pg_canary 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +5 -0
  3. data/LICENSE.txt +21 -0
  4. data/README.md +114 -0
  5. data/demo.png +0 -0
  6. data/lib/pg_canary/configuration.rb +80 -0
  7. data/lib/pg_canary/detector.rb +94 -0
  8. data/lib/pg_canary/middleware.rb +115 -0
  9. data/lib/pg_canary/pg_query_support.rb +115 -0
  10. data/lib/pg_canary/rules/base.rb +77 -0
  11. data/lib/pg_canary/rules/definitions/array_search_without_gin.rb +75 -0
  12. data/lib/pg_canary/rules/definitions/cartesian_join.rb +108 -0
  13. data/lib/pg_canary/rules/definitions/correlated_subquery_in_select.rb +80 -0
  14. data/lib/pg_canary/rules/definitions/count_star_without_where.rb +57 -0
  15. data/lib/pg_canary/rules/definitions/deep_offset.rb +63 -0
  16. data/lib/pg_canary/rules/definitions/distinct_with_join.rb +43 -0
  17. data/lib/pg_canary/rules/definitions/function_on_column.rb +89 -0
  18. data/lib/pg_canary/rules/definitions/huge_in_list.rb +74 -0
  19. data/lib/pg_canary/rules/definitions/implicit_cast.rb +79 -0
  20. data/lib/pg_canary/rules/definitions/jsonb_search_without_gin.rb +108 -0
  21. data/lib/pg_canary/rules/definitions/leading_wildcard_like.rb +81 -0
  22. data/lib/pg_canary/rules/definitions/not_in_subquery.rb +69 -0
  23. data/lib/pg_canary/rules/definitions/or_across_columns.rb +69 -0
  24. data/lib/pg_canary/rules/definitions/order_by_random.rb +41 -0
  25. data/lib/pg_canary/rules/definitions/query_complexity.rb +65 -0
  26. data/lib/pg_canary/rules/definitions/regex_without_trgm.rb +70 -0
  27. data/lib/pg_canary/rules/definitions/select_star_with_heavy_columns.rb +73 -0
  28. data/lib/pg_canary/rules/definitions/unindexed_join.rb +85 -0
  29. data/lib/pg_canary/rules/definitions/unindexed_order_by_with_limit.rb +51 -0
  30. data/lib/pg_canary/rules/definitions/unindexed_where.rb +95 -0
  31. data/lib/pg_canary/rules/definitions/union_instead_of_union_all.rb +30 -0
  32. data/lib/pg_canary/rules/detection.rb +21 -0
  33. data/lib/pg_canary/rules/index_predicates.rb +39 -0
  34. data/lib/pg_canary/rules/query_context.rb +147 -0
  35. data/lib/pg_canary/schema_introspection.rb +72 -0
  36. data/lib/pg_canary/subscriber.rb +41 -0
  37. data/lib/pg_canary/version.rb +5 -0
  38. data/lib/pg_canary.rb +77 -0
  39. metadata +126 -0
metadata ADDED
@@ -0,0 +1,126 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: pg_canary
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - kyuuri1791
8
+ bindir: bin
9
+ cert_chain: []
10
+ date: 1980-01-02 00:00:00.000000000 Z
11
+ dependencies:
12
+ - !ruby/object:Gem::Dependency
13
+ name: activerecord
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ - - ">="
17
+ - !ruby/object:Gem::Version
18
+ version: '7.0'
19
+ type: :runtime
20
+ prerelease: false
21
+ version_requirements: !ruby/object:Gem::Requirement
22
+ requirements:
23
+ - - ">="
24
+ - !ruby/object:Gem::Version
25
+ version: '7.0'
26
+ - !ruby/object:Gem::Dependency
27
+ name: activesupport
28
+ requirement: !ruby/object:Gem::Requirement
29
+ requirements:
30
+ - - ">="
31
+ - !ruby/object:Gem::Version
32
+ version: '7.0'
33
+ type: :runtime
34
+ prerelease: false
35
+ version_requirements: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - ">="
38
+ - !ruby/object:Gem::Version
39
+ version: '7.0'
40
+ - !ruby/object:Gem::Dependency
41
+ name: pg_query
42
+ requirement: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - ">="
45
+ - !ruby/object:Gem::Version
46
+ version: '5.0'
47
+ type: :runtime
48
+ prerelease: false
49
+ version_requirements: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - ">="
52
+ - !ruby/object:Gem::Version
53
+ version: '5.0'
54
+ description: 'pg_canary watches queries executed in development/test, parses them
55
+ with PostgreSQL''s own parser (pg_query), and combines the AST with schema metadata
56
+ (indexes, column types) to warn about anti-patterns that can become slow queries
57
+ in production: leading-wildcard LIKEs, function-wrapped columns in WHERE, ORDER
58
+ BY RANDOM(), NOT IN (SELECT ...), and more.'
59
+ executables: []
60
+ extensions: []
61
+ extra_rdoc_files: []
62
+ files:
63
+ - CHANGELOG.md
64
+ - LICENSE.txt
65
+ - README.md
66
+ - demo.png
67
+ - lib/pg_canary.rb
68
+ - lib/pg_canary/configuration.rb
69
+ - lib/pg_canary/detector.rb
70
+ - lib/pg_canary/middleware.rb
71
+ - lib/pg_canary/pg_query_support.rb
72
+ - lib/pg_canary/rules/base.rb
73
+ - lib/pg_canary/rules/definitions/array_search_without_gin.rb
74
+ - lib/pg_canary/rules/definitions/cartesian_join.rb
75
+ - lib/pg_canary/rules/definitions/correlated_subquery_in_select.rb
76
+ - lib/pg_canary/rules/definitions/count_star_without_where.rb
77
+ - lib/pg_canary/rules/definitions/deep_offset.rb
78
+ - lib/pg_canary/rules/definitions/distinct_with_join.rb
79
+ - lib/pg_canary/rules/definitions/function_on_column.rb
80
+ - lib/pg_canary/rules/definitions/huge_in_list.rb
81
+ - lib/pg_canary/rules/definitions/implicit_cast.rb
82
+ - lib/pg_canary/rules/definitions/jsonb_search_without_gin.rb
83
+ - lib/pg_canary/rules/definitions/leading_wildcard_like.rb
84
+ - lib/pg_canary/rules/definitions/not_in_subquery.rb
85
+ - lib/pg_canary/rules/definitions/or_across_columns.rb
86
+ - lib/pg_canary/rules/definitions/order_by_random.rb
87
+ - lib/pg_canary/rules/definitions/query_complexity.rb
88
+ - lib/pg_canary/rules/definitions/regex_without_trgm.rb
89
+ - lib/pg_canary/rules/definitions/select_star_with_heavy_columns.rb
90
+ - lib/pg_canary/rules/definitions/unindexed_join.rb
91
+ - lib/pg_canary/rules/definitions/unindexed_order_by_with_limit.rb
92
+ - lib/pg_canary/rules/definitions/unindexed_where.rb
93
+ - lib/pg_canary/rules/definitions/union_instead_of_union_all.rb
94
+ - lib/pg_canary/rules/detection.rb
95
+ - lib/pg_canary/rules/index_predicates.rb
96
+ - lib/pg_canary/rules/query_context.rb
97
+ - lib/pg_canary/schema_introspection.rb
98
+ - lib/pg_canary/subscriber.rb
99
+ - lib/pg_canary/version.rb
100
+ homepage: https://github.com/kyuuri1791/pg_canary
101
+ licenses:
102
+ - MIT
103
+ metadata:
104
+ homepage_uri: https://github.com/kyuuri1791/pg_canary
105
+ source_code_uri: https://github.com/kyuuri1791/pg_canary
106
+ changelog_uri: https://github.com/kyuuri1791/pg_canary/blob/main/CHANGELOG.md
107
+ rubygems_mfa_required: 'true'
108
+ rdoc_options: []
109
+ require_paths:
110
+ - lib
111
+ required_ruby_version: !ruby/object:Gem::Requirement
112
+ requirements:
113
+ - - ">="
114
+ - !ruby/object:Gem::Version
115
+ version: 3.1.0
116
+ required_rubygems_version: !ruby/object:Gem::Requirement
117
+ requirements:
118
+ - - ">="
119
+ - !ruby/object:Gem::Version
120
+ version: '0'
121
+ requirements: []
122
+ rubygems_version: 3.6.7
123
+ specification_version: 4
124
+ summary: Detects SQL anti-patterns that can become slow queries in production, while
125
+ you develop.
126
+ test_files: []