activerecord 6.1.7 → 7.1.5

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 (311) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +2030 -1020
  3. data/MIT-LICENSE +1 -1
  4. data/README.rdoc +18 -18
  5. data/lib/active_record/aggregations.rb +17 -14
  6. data/lib/active_record/association_relation.rb +1 -11
  7. data/lib/active_record/associations/association.rb +51 -19
  8. data/lib/active_record/associations/association_scope.rb +17 -12
  9. data/lib/active_record/associations/belongs_to_association.rb +28 -9
  10. data/lib/active_record/associations/belongs_to_polymorphic_association.rb +10 -2
  11. data/lib/active_record/associations/builder/association.rb +11 -5
  12. data/lib/active_record/associations/builder/belongs_to.rb +40 -14
  13. data/lib/active_record/associations/builder/collection_association.rb +10 -3
  14. data/lib/active_record/associations/builder/has_and_belongs_to_many.rb +1 -5
  15. data/lib/active_record/associations/builder/has_many.rb +3 -2
  16. data/lib/active_record/associations/builder/has_one.rb +2 -1
  17. data/lib/active_record/associations/builder/singular_association.rb +6 -2
  18. data/lib/active_record/associations/collection_association.rb +39 -35
  19. data/lib/active_record/associations/collection_proxy.rb +30 -15
  20. data/lib/active_record/associations/disable_joins_association_scope.rb +59 -0
  21. data/lib/active_record/associations/foreign_association.rb +10 -3
  22. data/lib/active_record/associations/has_many_association.rb +28 -18
  23. data/lib/active_record/associations/has_many_through_association.rb +12 -7
  24. data/lib/active_record/associations/has_one_association.rb +20 -10
  25. data/lib/active_record/associations/has_one_through_association.rb +1 -1
  26. data/lib/active_record/associations/join_dependency/join_association.rb +3 -2
  27. data/lib/active_record/associations/join_dependency.rb +28 -20
  28. data/lib/active_record/associations/preloader/association.rb +210 -52
  29. data/lib/active_record/associations/preloader/batch.rb +48 -0
  30. data/lib/active_record/associations/preloader/branch.rb +147 -0
  31. data/lib/active_record/associations/preloader/through_association.rb +50 -14
  32. data/lib/active_record/associations/preloader.rb +50 -121
  33. data/lib/active_record/associations/singular_association.rb +9 -3
  34. data/lib/active_record/associations/through_association.rb +25 -14
  35. data/lib/active_record/associations.rb +446 -306
  36. data/lib/active_record/asynchronous_queries_tracker.rb +60 -0
  37. data/lib/active_record/attribute_assignment.rb +1 -3
  38. data/lib/active_record/attribute_methods/before_type_cast.rb +24 -2
  39. data/lib/active_record/attribute_methods/dirty.rb +73 -22
  40. data/lib/active_record/attribute_methods/primary_key.rb +78 -26
  41. data/lib/active_record/attribute_methods/query.rb +31 -19
  42. data/lib/active_record/attribute_methods/read.rb +27 -12
  43. data/lib/active_record/attribute_methods/serialization.rb +194 -37
  44. data/lib/active_record/attribute_methods/time_zone_conversion.rb +8 -3
  45. data/lib/active_record/attribute_methods/write.rb +12 -15
  46. data/lib/active_record/attribute_methods.rb +161 -40
  47. data/lib/active_record/attributes.rb +27 -38
  48. data/lib/active_record/autosave_association.rb +65 -31
  49. data/lib/active_record/base.rb +25 -2
  50. data/lib/active_record/callbacks.rb +18 -34
  51. data/lib/active_record/coders/column_serializer.rb +61 -0
  52. data/lib/active_record/coders/json.rb +1 -1
  53. data/lib/active_record/coders/yaml_column.rb +70 -46
  54. data/lib/active_record/connection_adapters/abstract/connection_handler.rb +367 -0
  55. data/lib/active_record/connection_adapters/abstract/connection_pool/queue.rb +211 -0
  56. data/lib/active_record/connection_adapters/abstract/connection_pool/reaper.rb +78 -0
  57. data/lib/active_record/connection_adapters/abstract/connection_pool.rb +113 -597
  58. data/lib/active_record/connection_adapters/abstract/database_limits.rb +5 -17
  59. data/lib/active_record/connection_adapters/abstract/database_statements.rb +172 -50
  60. data/lib/active_record/connection_adapters/abstract/query_cache.rb +78 -27
  61. data/lib/active_record/connection_adapters/abstract/quoting.rb +87 -73
  62. data/lib/active_record/connection_adapters/abstract/savepoints.rb +4 -3
  63. data/lib/active_record/connection_adapters/abstract/schema_creation.rb +21 -20
  64. data/lib/active_record/connection_adapters/abstract/schema_definitions.rb +186 -31
  65. data/lib/active_record/connection_adapters/abstract/schema_dumper.rb +14 -1
  66. data/lib/active_record/connection_adapters/abstract/schema_statements.rb +367 -141
  67. data/lib/active_record/connection_adapters/abstract/transaction.rb +281 -59
  68. data/lib/active_record/connection_adapters/abstract_adapter.rb +631 -150
  69. data/lib/active_record/connection_adapters/abstract_mysql_adapter.rb +317 -164
  70. data/lib/active_record/connection_adapters/column.rb +13 -0
  71. data/lib/active_record/connection_adapters/mysql/column.rb +1 -0
  72. data/lib/active_record/connection_adapters/mysql/database_statements.rb +25 -134
  73. data/lib/active_record/connection_adapters/mysql/quoting.rb +56 -25
  74. data/lib/active_record/connection_adapters/mysql/schema_creation.rb +9 -0
  75. data/lib/active_record/connection_adapters/mysql/schema_definitions.rb +10 -1
  76. data/lib/active_record/connection_adapters/mysql/schema_dumper.rb +8 -2
  77. data/lib/active_record/connection_adapters/mysql/schema_statements.rb +39 -14
  78. data/lib/active_record/connection_adapters/mysql2/database_statements.rb +151 -0
  79. data/lib/active_record/connection_adapters/mysql2_adapter.rb +112 -55
  80. data/lib/active_record/connection_adapters/pool_config.rb +20 -11
  81. data/lib/active_record/connection_adapters/pool_manager.rb +19 -9
  82. data/lib/active_record/connection_adapters/postgresql/column.rb +30 -1
  83. data/lib/active_record/connection_adapters/postgresql/database_statements.rb +89 -52
  84. data/lib/active_record/connection_adapters/postgresql/oid/array.rb +1 -1
  85. data/lib/active_record/connection_adapters/postgresql/oid/cidr.rb +6 -0
  86. data/lib/active_record/connection_adapters/postgresql/oid/date.rb +8 -0
  87. data/lib/active_record/connection_adapters/postgresql/oid/date_time.rb +5 -0
  88. data/lib/active_record/connection_adapters/postgresql/oid/hstore.rb +53 -14
  89. data/lib/active_record/connection_adapters/postgresql/oid/money.rb +3 -2
  90. data/lib/active_record/connection_adapters/postgresql/oid/range.rb +12 -3
  91. data/lib/active_record/connection_adapters/postgresql/oid/timestamp.rb +15 -0
  92. data/lib/active_record/connection_adapters/postgresql/oid/timestamp_with_time_zone.rb +30 -0
  93. data/lib/active_record/connection_adapters/postgresql/oid/type_map_initializer.rb +18 -6
  94. data/lib/active_record/connection_adapters/postgresql/oid.rb +2 -0
  95. data/lib/active_record/connection_adapters/postgresql/quoting.rb +89 -56
  96. data/lib/active_record/connection_adapters/postgresql/referential_integrity.rb +28 -0
  97. data/lib/active_record/connection_adapters/postgresql/schema_creation.rb +92 -2
  98. data/lib/active_record/connection_adapters/postgresql/schema_definitions.rb +153 -3
  99. data/lib/active_record/connection_adapters/postgresql/schema_dumper.rb +78 -0
  100. data/lib/active_record/connection_adapters/postgresql/schema_statements.rb +397 -75
  101. data/lib/active_record/connection_adapters/postgresql/utils.rb +9 -10
  102. data/lib/active_record/connection_adapters/postgresql_adapter.rb +508 -246
  103. data/lib/active_record/connection_adapters/schema_cache.rb +319 -90
  104. data/lib/active_record/connection_adapters/sqlite3/column.rb +49 -0
  105. data/lib/active_record/connection_adapters/sqlite3/database_statements.rb +72 -53
  106. data/lib/active_record/connection_adapters/sqlite3/quoting.rb +37 -21
  107. data/lib/active_record/connection_adapters/sqlite3/schema_definitions.rb +7 -0
  108. data/lib/active_record/connection_adapters/sqlite3/schema_statements.rb +43 -22
  109. data/lib/active_record/connection_adapters/sqlite3_adapter.rb +296 -104
  110. data/lib/active_record/connection_adapters/statement_pool.rb +7 -0
  111. data/lib/active_record/connection_adapters/trilogy/database_statements.rb +99 -0
  112. data/lib/active_record/connection_adapters/trilogy_adapter.rb +258 -0
  113. data/lib/active_record/connection_adapters.rb +9 -6
  114. data/lib/active_record/connection_handling.rb +108 -137
  115. data/lib/active_record/core.rb +242 -233
  116. data/lib/active_record/counter_cache.rb +52 -27
  117. data/lib/active_record/database_configurations/connection_url_resolver.rb +3 -2
  118. data/lib/active_record/database_configurations/database_config.rb +21 -12
  119. data/lib/active_record/database_configurations/hash_config.rb +88 -16
  120. data/lib/active_record/database_configurations/url_config.rb +18 -12
  121. data/lib/active_record/database_configurations.rb +95 -59
  122. data/lib/active_record/delegated_type.rb +66 -20
  123. data/lib/active_record/deprecator.rb +7 -0
  124. data/lib/active_record/destroy_association_async_job.rb +4 -2
  125. data/lib/active_record/disable_joins_association_relation.rb +39 -0
  126. data/lib/active_record/dynamic_matchers.rb +1 -1
  127. data/lib/active_record/encryption/auto_filtered_parameters.rb +66 -0
  128. data/lib/active_record/encryption/cipher/aes256_gcm.rb +101 -0
  129. data/lib/active_record/encryption/cipher.rb +53 -0
  130. data/lib/active_record/encryption/config.rb +68 -0
  131. data/lib/active_record/encryption/configurable.rb +60 -0
  132. data/lib/active_record/encryption/context.rb +42 -0
  133. data/lib/active_record/encryption/contexts.rb +76 -0
  134. data/lib/active_record/encryption/derived_secret_key_provider.rb +18 -0
  135. data/lib/active_record/encryption/deterministic_key_provider.rb +14 -0
  136. data/lib/active_record/encryption/encryptable_record.rb +230 -0
  137. data/lib/active_record/encryption/encrypted_attribute_type.rb +155 -0
  138. data/lib/active_record/encryption/encrypted_fixtures.rb +38 -0
  139. data/lib/active_record/encryption/encrypting_only_encryptor.rb +12 -0
  140. data/lib/active_record/encryption/encryptor.rb +155 -0
  141. data/lib/active_record/encryption/envelope_encryption_key_provider.rb +55 -0
  142. data/lib/active_record/encryption/errors.rb +15 -0
  143. data/lib/active_record/encryption/extended_deterministic_queries.rb +157 -0
  144. data/lib/active_record/encryption/extended_deterministic_uniqueness_validator.rb +28 -0
  145. data/lib/active_record/encryption/key.rb +28 -0
  146. data/lib/active_record/encryption/key_generator.rb +53 -0
  147. data/lib/active_record/encryption/key_provider.rb +46 -0
  148. data/lib/active_record/encryption/message.rb +33 -0
  149. data/lib/active_record/encryption/message_serializer.rb +92 -0
  150. data/lib/active_record/encryption/null_encryptor.rb +21 -0
  151. data/lib/active_record/encryption/properties.rb +76 -0
  152. data/lib/active_record/encryption/read_only_null_encryptor.rb +24 -0
  153. data/lib/active_record/encryption/scheme.rb +100 -0
  154. data/lib/active_record/encryption.rb +58 -0
  155. data/lib/active_record/enum.rb +154 -63
  156. data/lib/active_record/errors.rb +172 -15
  157. data/lib/active_record/explain.rb +23 -3
  158. data/lib/active_record/explain_registry.rb +11 -6
  159. data/lib/active_record/explain_subscriber.rb +1 -1
  160. data/lib/active_record/fixture_set/file.rb +15 -1
  161. data/lib/active_record/fixture_set/model_metadata.rb +14 -4
  162. data/lib/active_record/fixture_set/render_context.rb +2 -0
  163. data/lib/active_record/fixture_set/table_row.rb +70 -14
  164. data/lib/active_record/fixture_set/table_rows.rb +4 -4
  165. data/lib/active_record/fixtures.rb +147 -86
  166. data/lib/active_record/future_result.rb +174 -0
  167. data/lib/active_record/gem_version.rb +3 -3
  168. data/lib/active_record/inheritance.rb +81 -29
  169. data/lib/active_record/insert_all.rb +135 -22
  170. data/lib/active_record/integration.rb +11 -10
  171. data/lib/active_record/internal_metadata.rb +119 -33
  172. data/lib/active_record/legacy_yaml_adapter.rb +2 -39
  173. data/lib/active_record/locking/optimistic.rb +37 -22
  174. data/lib/active_record/locking/pessimistic.rb +15 -6
  175. data/lib/active_record/log_subscriber.rb +52 -19
  176. data/lib/active_record/marshalling.rb +59 -0
  177. data/lib/active_record/message_pack.rb +124 -0
  178. data/lib/active_record/middleware/database_selector/resolver.rb +10 -10
  179. data/lib/active_record/middleware/database_selector.rb +23 -13
  180. data/lib/active_record/middleware/shard_selector.rb +62 -0
  181. data/lib/active_record/migration/command_recorder.rb +112 -14
  182. data/lib/active_record/migration/compatibility.rb +233 -46
  183. data/lib/active_record/migration/default_strategy.rb +23 -0
  184. data/lib/active_record/migration/execution_strategy.rb +19 -0
  185. data/lib/active_record/migration/join_table.rb +1 -1
  186. data/lib/active_record/migration/pending_migration_connection.rb +21 -0
  187. data/lib/active_record/migration.rb +361 -173
  188. data/lib/active_record/model_schema.rb +125 -101
  189. data/lib/active_record/nested_attributes.rb +50 -20
  190. data/lib/active_record/no_touching.rb +3 -3
  191. data/lib/active_record/normalization.rb +167 -0
  192. data/lib/active_record/persistence.rb +409 -88
  193. data/lib/active_record/promise.rb +84 -0
  194. data/lib/active_record/query_cache.rb +4 -22
  195. data/lib/active_record/query_logs.rb +174 -0
  196. data/lib/active_record/query_logs_formatter.rb +41 -0
  197. data/lib/active_record/querying.rb +29 -6
  198. data/lib/active_record/railtie.rb +220 -44
  199. data/lib/active_record/railties/controller_runtime.rb +15 -10
  200. data/lib/active_record/railties/databases.rake +188 -252
  201. data/lib/active_record/railties/job_runtime.rb +23 -0
  202. data/lib/active_record/readonly_attributes.rb +41 -3
  203. data/lib/active_record/reflection.rb +248 -81
  204. data/lib/active_record/relation/batches/batch_enumerator.rb +23 -7
  205. data/lib/active_record/relation/batches.rb +192 -63
  206. data/lib/active_record/relation/calculations.rb +246 -90
  207. data/lib/active_record/relation/delegation.rb +28 -14
  208. data/lib/active_record/relation/finder_methods.rb +108 -51
  209. data/lib/active_record/relation/merger.rb +22 -13
  210. data/lib/active_record/relation/predicate_builder/association_query_value.rb +31 -3
  211. data/lib/active_record/relation/predicate_builder/polymorphic_array_value.rb +10 -7
  212. data/lib/active_record/relation/predicate_builder/relation_handler.rb +5 -1
  213. data/lib/active_record/relation/predicate_builder.rb +27 -20
  214. data/lib/active_record/relation/query_attribute.rb +30 -12
  215. data/lib/active_record/relation/query_methods.rb +670 -129
  216. data/lib/active_record/relation/record_fetch_warning.rb +7 -9
  217. data/lib/active_record/relation/spawn_methods.rb +20 -3
  218. data/lib/active_record/relation/where_clause.rb +10 -19
  219. data/lib/active_record/relation.rb +287 -120
  220. data/lib/active_record/result.rb +37 -11
  221. data/lib/active_record/runtime_registry.rb +32 -13
  222. data/lib/active_record/sanitization.rb +65 -20
  223. data/lib/active_record/schema.rb +36 -22
  224. data/lib/active_record/schema_dumper.rb +73 -24
  225. data/lib/active_record/schema_migration.rb +68 -33
  226. data/lib/active_record/scoping/default.rb +72 -15
  227. data/lib/active_record/scoping/named.rb +5 -13
  228. data/lib/active_record/scoping.rb +65 -34
  229. data/lib/active_record/secure_password.rb +60 -0
  230. data/lib/active_record/secure_token.rb +21 -3
  231. data/lib/active_record/serialization.rb +6 -1
  232. data/lib/active_record/signed_id.rb +10 -8
  233. data/lib/active_record/store.rb +10 -10
  234. data/lib/active_record/suppressor.rb +13 -15
  235. data/lib/active_record/table_metadata.rb +16 -3
  236. data/lib/active_record/tasks/database_tasks.rb +251 -140
  237. data/lib/active_record/tasks/mysql_database_tasks.rb +16 -7
  238. data/lib/active_record/tasks/postgresql_database_tasks.rb +35 -26
  239. data/lib/active_record/tasks/sqlite_database_tasks.rb +15 -7
  240. data/lib/active_record/test_databases.rb +1 -1
  241. data/lib/active_record/test_fixtures.rb +117 -96
  242. data/lib/active_record/timestamp.rb +32 -19
  243. data/lib/active_record/token_for.rb +113 -0
  244. data/lib/active_record/touch_later.rb +11 -6
  245. data/lib/active_record/transactions.rb +48 -27
  246. data/lib/active_record/translation.rb +3 -3
  247. data/lib/active_record/type/adapter_specific_registry.rb +32 -14
  248. data/lib/active_record/type/hash_lookup_type_map.rb +34 -1
  249. data/lib/active_record/type/internal/timezone.rb +7 -2
  250. data/lib/active_record/type/serialized.rb +9 -5
  251. data/lib/active_record/type/time.rb +4 -0
  252. data/lib/active_record/type/type_map.rb +17 -20
  253. data/lib/active_record/type.rb +1 -2
  254. data/lib/active_record/validations/absence.rb +1 -1
  255. data/lib/active_record/validations/associated.rb +4 -4
  256. data/lib/active_record/validations/numericality.rb +5 -4
  257. data/lib/active_record/validations/presence.rb +5 -28
  258. data/lib/active_record/validations/uniqueness.rb +51 -6
  259. data/lib/active_record/validations.rb +8 -4
  260. data/lib/active_record/version.rb +1 -1
  261. data/lib/active_record.rb +335 -32
  262. data/lib/arel/attributes/attribute.rb +0 -8
  263. data/lib/arel/crud.rb +28 -22
  264. data/lib/arel/delete_manager.rb +18 -4
  265. data/lib/arel/errors.rb +10 -0
  266. data/lib/arel/factory_methods.rb +4 -0
  267. data/lib/arel/filter_predications.rb +9 -0
  268. data/lib/arel/insert_manager.rb +2 -3
  269. data/lib/arel/nodes/and.rb +4 -0
  270. data/lib/arel/nodes/binary.rb +6 -1
  271. data/lib/arel/nodes/bound_sql_literal.rb +61 -0
  272. data/lib/arel/nodes/casted.rb +1 -1
  273. data/lib/arel/nodes/cte.rb +36 -0
  274. data/lib/arel/nodes/delete_statement.rb +12 -13
  275. data/lib/arel/nodes/filter.rb +10 -0
  276. data/lib/arel/nodes/fragments.rb +35 -0
  277. data/lib/arel/nodes/function.rb +1 -0
  278. data/lib/arel/nodes/homogeneous_in.rb +1 -9
  279. data/lib/arel/nodes/insert_statement.rb +2 -2
  280. data/lib/arel/nodes/leading_join.rb +8 -0
  281. data/lib/arel/nodes/node.rb +111 -2
  282. data/lib/arel/nodes/select_core.rb +2 -2
  283. data/lib/arel/nodes/select_statement.rb +2 -2
  284. data/lib/arel/nodes/sql_literal.rb +6 -0
  285. data/lib/arel/nodes/table_alias.rb +4 -0
  286. data/lib/arel/nodes/update_statement.rb +8 -3
  287. data/lib/arel/nodes.rb +5 -0
  288. data/lib/arel/predications.rb +13 -3
  289. data/lib/arel/select_manager.rb +10 -4
  290. data/lib/arel/table.rb +9 -6
  291. data/lib/arel/tree_manager.rb +5 -13
  292. data/lib/arel/update_manager.rb +18 -4
  293. data/lib/arel/visitors/dot.rb +80 -90
  294. data/lib/arel/visitors/mysql.rb +16 -3
  295. data/lib/arel/visitors/postgresql.rb +0 -10
  296. data/lib/arel/visitors/to_sql.rb +141 -20
  297. data/lib/arel/visitors/visitor.rb +2 -2
  298. data/lib/arel.rb +18 -3
  299. data/lib/rails/generators/active_record/application_record/USAGE +8 -0
  300. data/lib/rails/generators/active_record/application_record/templates/application_record.rb.tt +1 -1
  301. data/lib/rails/generators/active_record/migration.rb +3 -1
  302. data/lib/rails/generators/active_record/model/USAGE +113 -0
  303. data/lib/rails/generators/active_record/model/model_generator.rb +15 -6
  304. data/lib/rails/generators/active_record/model/templates/abstract_base_class.rb.tt +1 -1
  305. data/lib/rails/generators/active_record/model/templates/model.rb.tt +1 -1
  306. data/lib/rails/generators/active_record/model/templates/module.rb.tt +2 -2
  307. data/lib/rails/generators/active_record/multi_db/multi_db_generator.rb +16 -0
  308. data/lib/rails/generators/active_record/multi_db/templates/multi_db.rb.tt +44 -0
  309. metadata +96 -16
  310. data/lib/active_record/connection_adapters/legacy_pool_manager.rb +0 -35
  311. data/lib/active_record/null_relation.rb +0 -67
@@ -4,6 +4,7 @@ require "set"
4
4
  require "active_record/connection_adapters/sql_type_metadata"
5
5
  require "active_record/connection_adapters/abstract/schema_dumper"
6
6
  require "active_record/connection_adapters/abstract/schema_creation"
7
+ require "active_support/concurrency/null_lock"
7
8
  require "active_support/concurrency/load_interlock_aware_monitor"
8
9
  require "arel/collectors/bind"
9
10
  require "arel/collectors/composite"
@@ -12,6 +13,8 @@ require "arel/collectors/substitute_binds"
12
13
 
13
14
  module ActiveRecord
14
15
  module ConnectionAdapters # :nodoc:
16
+ # = Active Record Abstract Adapter
17
+ #
15
18
  # Active Record supports multiple database systems. AbstractAdapter and
16
19
  # related classes form the abstraction layer which makes this possible.
17
20
  # An AbstractAdapter represents a connection to a database, and provides an
@@ -36,12 +39,20 @@ module ActiveRecord
36
39
  include Savepoints
37
40
 
38
41
  SIMPLE_INT = /\A\d+\z/
39
- COMMENT_REGEX = %r{(?:\-\-.*\n)*|/\*(?:[^\*]|\*[^/])*\*/}m
42
+ COMMENT_REGEX = %r{(?:--.*\n)|/\*(?:[^*]|\*[^/])*\*/}
40
43
 
41
- attr_accessor :pool
44
+ attr_reader :pool
42
45
  attr_reader :visitor, :owner, :logger, :lock
43
46
  alias :in_use? :owner
44
47
 
48
+ def pool=(value)
49
+ return if value.eql?(@pool)
50
+ @schema_cache = nil
51
+ @pool = value
52
+
53
+ @pool.schema_reflection.load!(self) if ActiveRecord.lazily_load_schema_cache
54
+ end
55
+
45
56
  set_callback :checkin, :after, :enable_lazy_transactions!
46
57
 
47
58
  def self.type_cast_config_to_integer(config)
@@ -62,44 +73,142 @@ module ActiveRecord
62
73
  end
63
74
  end
64
75
 
76
+ def self.validate_default_timezone(config)
77
+ case config
78
+ when nil
79
+ when "utc", "local"
80
+ config.to_sym
81
+ else
82
+ raise ArgumentError, "default_timezone must be either 'utc' or 'local'"
83
+ end
84
+ end
85
+
65
86
  DEFAULT_READ_QUERY = [:begin, :commit, :explain, :release, :rollback, :savepoint, :select, :with] # :nodoc:
66
87
  private_constant :DEFAULT_READ_QUERY
67
88
 
68
89
  def self.build_read_query_regexp(*parts) # :nodoc:
69
90
  parts += DEFAULT_READ_QUERY
70
91
  parts = parts.map { |part| /#{part}/i }
71
- /\A(?:[\(\s]|#{COMMENT_REGEX})*#{Regexp.union(*parts)}/
92
+ /\A(?:[(\s]|#{COMMENT_REGEX})*#{Regexp.union(*parts)}/
72
93
  end
73
94
 
74
- def self.quoted_column_names # :nodoc:
75
- @quoted_column_names ||= {}
95
+ def self.find_cmd_and_exec(commands, *args) # :doc:
96
+ commands = Array(commands)
97
+
98
+ dirs_on_path = ENV["PATH"].to_s.split(File::PATH_SEPARATOR)
99
+ unless (ext = RbConfig::CONFIG["EXEEXT"]).empty?
100
+ commands = commands.map { |cmd| "#{cmd}#{ext}" }
101
+ end
102
+
103
+ full_path_command = nil
104
+ found = commands.detect do |cmd|
105
+ dirs_on_path.detect do |path|
106
+ full_path_command = File.join(path, cmd)
107
+ begin
108
+ stat = File.stat(full_path_command)
109
+ rescue SystemCallError
110
+ else
111
+ stat.file? && stat.executable?
112
+ end
113
+ end
114
+ end
115
+
116
+ if found
117
+ exec full_path_command, *args
118
+ else
119
+ abort("Couldn't find database client: #{commands.join(', ')}. Check your $PATH and try again.")
120
+ end
76
121
  end
77
122
 
78
- def self.quoted_table_names # :nodoc:
79
- @quoted_table_names ||= {}
123
+ # Opens a database console session.
124
+ def self.dbconsole(config, options = {})
125
+ raise NotImplementedError
80
126
  end
81
127
 
82
- def initialize(connection, logger = nil, config = {}) # :nodoc:
128
+ def initialize(config_or_deprecated_connection, deprecated_logger = nil, deprecated_connection_options = nil, deprecated_config = nil) # :nodoc:
83
129
  super()
84
130
 
85
- @connection = connection
86
- @owner = nil
87
- @instrumenter = ActiveSupport::Notifications.instrumenter
88
- @logger = logger
89
- @config = config
90
- @pool = ActiveRecord::ConnectionAdapters::NullPool.new
91
- @idle_since = Concurrent.monotonic_time
131
+ @raw_connection = nil
132
+ @unconfigured_connection = nil
133
+
134
+ if config_or_deprecated_connection.is_a?(Hash)
135
+ @config = config_or_deprecated_connection.symbolize_keys
136
+ @logger = ActiveRecord::Base.logger
137
+
138
+ if deprecated_logger || deprecated_connection_options || deprecated_config
139
+ raise ArgumentError, "when initializing an ActiveRecord adapter with a config hash, that should be the only argument"
140
+ end
141
+ else
142
+ # Soft-deprecated for now; we'll probably warn in future.
143
+
144
+ @unconfigured_connection = config_or_deprecated_connection
145
+ @logger = deprecated_logger || ActiveRecord::Base.logger
146
+ if deprecated_config
147
+ @config = (deprecated_config || {}).symbolize_keys
148
+ @connection_parameters = deprecated_connection_options
149
+ else
150
+ @config = (deprecated_connection_options || {}).symbolize_keys
151
+ @connection_parameters = nil
152
+ end
153
+ end
154
+
155
+ @owner = nil
156
+ @instrumenter = ActiveSupport::Notifications.instrumenter
157
+ @pool = ActiveRecord::ConnectionAdapters::NullPool.new
158
+ @idle_since = Process.clock_gettime(Process::CLOCK_MONOTONIC)
92
159
  @visitor = arel_visitor
93
160
  @statements = build_statement_pool
94
- @lock = ActiveSupport::Concurrency::LoadInterlockAwareMonitor.new
161
+ self.lock_thread = nil
95
162
 
96
- @prepared_statements = self.class.type_cast_config_to_boolean(
97
- config.fetch(:prepared_statements, true)
163
+ @prepared_statements = !ActiveRecord.disable_prepared_statements && self.class.type_cast_config_to_boolean(
164
+ @config.fetch(:prepared_statements) { default_prepared_statements }
98
165
  )
99
166
 
100
167
  @advisory_locks_enabled = self.class.type_cast_config_to_boolean(
101
- config.fetch(:advisory_locks, true)
168
+ @config.fetch(:advisory_locks, true)
102
169
  )
170
+
171
+ @default_timezone = self.class.validate_default_timezone(@config[:default_timezone])
172
+
173
+ @raw_connection_dirty = false
174
+ @verified = false
175
+ end
176
+
177
+ THREAD_LOCK = ActiveSupport::Concurrency::ThreadLoadInterlockAwareMonitor.new
178
+ private_constant :THREAD_LOCK
179
+
180
+ FIBER_LOCK = ActiveSupport::Concurrency::LoadInterlockAwareMonitor.new
181
+ private_constant :FIBER_LOCK
182
+
183
+ def lock_thread=(lock_thread) # :nodoc:
184
+ @lock =
185
+ case lock_thread
186
+ when Thread
187
+ THREAD_LOCK
188
+ when Fiber
189
+ FIBER_LOCK
190
+ else
191
+ ActiveSupport::Concurrency::NullLock
192
+ end
193
+ end
194
+
195
+ EXCEPTION_NEVER = { Exception => :never }.freeze # :nodoc:
196
+ EXCEPTION_IMMEDIATE = { Exception => :immediate }.freeze # :nodoc:
197
+ private_constant :EXCEPTION_NEVER, :EXCEPTION_IMMEDIATE
198
+ def with_instrumenter(instrumenter, &block) # :nodoc:
199
+ Thread.handle_interrupt(EXCEPTION_NEVER) do
200
+ previous_instrumenter = @instrumenter
201
+ @instrumenter = instrumenter
202
+ Thread.handle_interrupt(EXCEPTION_IMMEDIATE, &block)
203
+ ensure
204
+ @instrumenter = previous_instrumenter
205
+ end
206
+ end
207
+
208
+ def check_if_write_query(sql) # :nodoc:
209
+ if preventing_writes? && write_query?(sql)
210
+ raise ActiveRecord::ReadOnlyError, "Write query attempted while in readonly mode: #{sql}"
211
+ end
103
212
  end
104
213
 
105
214
  def replica?
@@ -110,21 +219,31 @@ module ActiveRecord
110
219
  @config.fetch(:use_metadata_table, true)
111
220
  end
112
221
 
222
+ def connection_retries
223
+ (@config[:connection_retries] || 1).to_i
224
+ end
225
+
226
+ def retry_deadline
227
+ if @config[:retry_deadline]
228
+ @config[:retry_deadline].to_f
229
+ else
230
+ nil
231
+ end
232
+ end
233
+
234
+ def default_timezone
235
+ @default_timezone || ActiveRecord.default_timezone
236
+ end
237
+
113
238
  # Determines whether writes are currently being prevented.
114
239
  #
115
- # Returns true if the connection is a replica.
116
- #
117
- # If the application is using legacy handling, returns
118
- # true if +connection_handler.prevent_writes+ is set.
119
- #
120
- # If the application is using the new connection handling
121
- # will return true based on +current_preventing_writes+.
240
+ # Returns true if the connection is a replica or returns
241
+ # the value of +current_preventing_writes+.
122
242
  def preventing_writes?
123
243
  return true if replica?
124
- return ActiveRecord::Base.connection_handler.prevent_writes if ActiveRecord::Base.legacy_connection_handling
125
- return false if connection_klass.nil?
244
+ return false if connection_class.nil?
126
245
 
127
- connection_klass.current_preventing_writes
246
+ connection_class.current_preventing_writes
128
247
  end
129
248
 
130
249
  def migrations_paths # :nodoc:
@@ -132,25 +251,15 @@ module ActiveRecord
132
251
  end
133
252
 
134
253
  def migration_context # :nodoc:
135
- MigrationContext.new(migrations_paths, schema_migration)
254
+ MigrationContext.new(migrations_paths, schema_migration, internal_metadata)
136
255
  end
137
256
 
138
257
  def schema_migration # :nodoc:
139
- @schema_migration ||= begin
140
- conn = self
141
- spec_name = conn.pool.pool_config.connection_specification_name
142
-
143
- return ActiveRecord::SchemaMigration if spec_name == "ActiveRecord::Base"
144
-
145
- schema_migration_name = "#{spec_name}::SchemaMigration"
146
-
147
- Class.new(ActiveRecord::SchemaMigration) do
148
- define_singleton_method(:name) { schema_migration_name }
149
- define_singleton_method(:to_s) { schema_migration_name }
258
+ SchemaMigration.new(self)
259
+ end
150
260
 
151
- self.connection_specification_name = spec_name
152
- end
153
- end
261
+ def internal_metadata # :nodoc:
262
+ InternalMetadata.new(self)
154
263
  end
155
264
 
156
265
  def prepared_statements?
@@ -159,7 +268,7 @@ module ActiveRecord
159
268
  alias :prepared_statements :prepared_statements?
160
269
 
161
270
  def prepared_statements_disabled_cache # :nodoc:
162
- Thread.current[:ar_prepared_statements_disabled_cache] ||= Set.new
271
+ ActiveSupport::IsolatedExecutionState[:active_record_prepared_statements_disabled_cache] ||= Set.new
163
272
  end
164
273
 
165
274
  class Version
@@ -189,41 +298,48 @@ module ActiveRecord
189
298
  def lease
190
299
  if in_use?
191
300
  msg = +"Cannot lease connection, "
192
- if @owner == Thread.current
301
+ if @owner == ActiveSupport::IsolatedExecutionState.context
193
302
  msg << "it is already leased by the current thread."
194
303
  else
195
304
  msg << "it is already in use by a different thread: #{@owner}. " \
196
- "Current thread: #{Thread.current}."
305
+ "Current thread: #{ActiveSupport::IsolatedExecutionState.context}."
197
306
  end
198
307
  raise ActiveRecordError, msg
199
308
  end
200
309
 
201
- @owner = Thread.current
310
+ @owner = ActiveSupport::IsolatedExecutionState.context
202
311
  end
203
312
 
204
- def connection_klass # :nodoc:
205
- @pool.connection_klass
313
+ def connection_class # :nodoc:
314
+ @pool.connection_class
206
315
  end
207
316
 
208
- def schema_cache
209
- @pool.get_schema_cache(self)
317
+ # The role (e.g. +:writing+) for the current connection. In a
318
+ # non-multi role application, +:writing+ is returned.
319
+ def role
320
+ @pool.role
210
321
  end
211
322
 
212
- def schema_cache=(cache)
213
- cache.connection = self
214
- @pool.set_schema_cache(cache)
323
+ # The shard (e.g. +:default+) for the current connection. In
324
+ # a non-sharded application, +:default+ is returned.
325
+ def shard
326
+ @pool.shard
327
+ end
328
+
329
+ def schema_cache
330
+ @schema_cache ||= BoundSchemaReflection.new(@pool.schema_reflection, self)
215
331
  end
216
332
 
217
333
  # this method must only be called while holding connection pool's mutex
218
334
  def expire
219
335
  if in_use?
220
- if @owner != Thread.current
336
+ if @owner != ActiveSupport::IsolatedExecutionState.context
221
337
  raise ActiveRecordError, "Cannot expire connection, " \
222
338
  "it is owned by a different thread: #{@owner}. " \
223
- "Current thread: #{Thread.current}."
339
+ "Current thread: #{ActiveSupport::IsolatedExecutionState.context}."
224
340
  end
225
341
 
226
- @idle_since = Concurrent.monotonic_time
342
+ @idle_since = Process.clock_gettime(Process::CLOCK_MONOTONIC)
227
343
  @owner = nil
228
344
  else
229
345
  raise ActiveRecordError, "Cannot expire connection, it is not currently leased."
@@ -233,10 +349,10 @@ module ActiveRecord
233
349
  # this method must only be called while holding connection pool's mutex (and a desire for segfaults)
234
350
  def steal! # :nodoc:
235
351
  if in_use?
236
- if @owner != Thread.current
352
+ if @owner != ActiveSupport::IsolatedExecutionState.context
237
353
  pool.send :remove_connection_from_thread_cache, self, @owner
238
354
 
239
- @owner = Thread.current
355
+ @owner = ActiveSupport::IsolatedExecutionState.context
240
356
  end
241
357
  else
242
358
  raise ActiveRecordError, "Cannot steal connection, it is not currently leased."
@@ -246,7 +362,7 @@ module ActiveRecord
246
362
  # Seconds since this connection was returned to the pool
247
363
  def seconds_idle # :nodoc:
248
364
  return 0 if in_use?
249
- Concurrent.monotonic_time - @idle_since
365
+ Process.clock_gettime(Process::CLOCK_MONOTONIC) - @idle_since
250
366
  end
251
367
 
252
368
  def unprepared_statement
@@ -264,7 +380,14 @@ module ActiveRecord
264
380
 
265
381
  # Does the database for this adapter exist?
266
382
  def self.database_exists?(config)
267
- raise NotImplementedError
383
+ new(config).database_exists?
384
+ end
385
+
386
+ def database_exists?
387
+ connect!
388
+ true
389
+ rescue ActiveRecord::NoDatabaseError
390
+ false
268
391
  end
269
392
 
270
393
  # Does this adapter support DDL rollbacks in transactions? That is, would
@@ -282,6 +405,16 @@ module ActiveRecord
282
405
  false
283
406
  end
284
407
 
408
+ # Do TransactionRollbackErrors on savepoints affect the parent
409
+ # transaction?
410
+ def savepoint_errors_invalidate_transactions?
411
+ false
412
+ end
413
+
414
+ def supports_restart_db_transaction?
415
+ false
416
+ end
417
+
285
418
  # Does this adapter support application-enforced advisory locking?
286
419
  def supports_advisory_locks?
287
420
  false
@@ -308,6 +441,11 @@ module ActiveRecord
308
441
  false
309
442
  end
310
443
 
444
+ # Does this adapter support including non-key columns?
445
+ def supports_index_include?
446
+ false
447
+ end
448
+
311
449
  # Does this adapter support expression indices?
312
450
  def supports_expression_index?
313
451
  false
@@ -344,11 +482,26 @@ module ActiveRecord
344
482
  false
345
483
  end
346
484
 
485
+ # Does this adapter support creating deferrable constraints?
486
+ def supports_deferrable_constraints?
487
+ false
488
+ end
489
+
347
490
  # Does this adapter support creating check constraints?
348
491
  def supports_check_constraints?
349
492
  false
350
493
  end
351
494
 
495
+ # Does this adapter support creating exclusion constraints?
496
+ def supports_exclusion_constraints?
497
+ false
498
+ end
499
+
500
+ # Does this adapter support creating unique constraints?
501
+ def supports_unique_constraints?
502
+ false
503
+ end
504
+
352
505
  # Does this adapter support views?
353
506
  def supports_views?
354
507
  false
@@ -364,7 +517,7 @@ module ActiveRecord
364
517
  false
365
518
  end
366
519
 
367
- # Does this adapter support json data type?
520
+ # Does this adapter support JSON data type?
368
521
  def supports_json?
369
522
  false
370
523
  end
@@ -418,12 +571,49 @@ module ActiveRecord
418
571
  false
419
572
  end
420
573
 
574
+ def supports_concurrent_connections?
575
+ true
576
+ end
577
+
578
+ def supports_nulls_not_distinct?
579
+ false
580
+ end
581
+
582
+ def return_value_after_insert?(column) # :nodoc:
583
+ column.auto_incremented_by_db?
584
+ end
585
+
586
+ def async_enabled? # :nodoc:
587
+ supports_concurrent_connections? &&
588
+ !ActiveRecord.async_query_executor.nil? && !pool.async_executor.nil?
589
+ end
590
+
421
591
  # This is meant to be implemented by the adapters that support extensions
422
- def disable_extension(name)
592
+ def disable_extension(name, **)
423
593
  end
424
594
 
425
595
  # This is meant to be implemented by the adapters that support extensions
426
- def enable_extension(name)
596
+ def enable_extension(name, **)
597
+ end
598
+
599
+ # This is meant to be implemented by the adapters that support custom enum types
600
+ def create_enum(*) # :nodoc:
601
+ end
602
+
603
+ # This is meant to be implemented by the adapters that support custom enum types
604
+ def drop_enum(*) # :nodoc:
605
+ end
606
+
607
+ # This is meant to be implemented by the adapters that support custom enum types
608
+ def rename_enum(*) # :nodoc:
609
+ end
610
+
611
+ # This is meant to be implemented by the adapters that support custom enum types
612
+ def add_enum_value(*) # :nodoc:
613
+ end
614
+
615
+ # This is meant to be implemented by the adapters that support custom enum types
616
+ def rename_enum_value(*) # :nodoc:
427
617
  end
428
618
 
429
619
  def advisory_locks_enabled? # :nodoc:
@@ -461,6 +651,21 @@ module ActiveRecord
461
651
  yield
462
652
  end
463
653
 
654
+ # Override to check all foreign key constraints in a database.
655
+ def all_foreign_keys_valid?
656
+ check_all_foreign_keys_valid!
657
+ true
658
+ rescue ActiveRecord::StatementInvalid
659
+ false
660
+ end
661
+ deprecate :all_foreign_keys_valid?, deprecator: ActiveRecord.deprecator
662
+
663
+ # Override to check all foreign key constraints in a database.
664
+ # The adapter should raise a +ActiveRecord::StatementInvalid+ if foreign key
665
+ # constraints are not met.
666
+ def check_all_foreign_keys_valid!
667
+ end
668
+
464
669
  # CONNECTION MANAGEMENT ====================================
465
670
 
466
671
  # Checks whether the connection to the database is still active. This includes
@@ -469,19 +674,51 @@ module ActiveRecord
469
674
  def active?
470
675
  end
471
676
 
472
- # Disconnects from the database if already connected, and establishes a
473
- # new connection with the database. Implementors should call super if they
474
- # override the default implementation.
475
- def reconnect!
476
- clear_cache!
477
- reset_transaction
677
+ # Disconnects from the database if already connected, and establishes a new
678
+ # connection with the database. Implementors should define private #reconnect
679
+ # instead.
680
+ def reconnect!(restore_transactions: false)
681
+ retries_available = connection_retries
682
+ deadline = retry_deadline && Process.clock_gettime(Process::CLOCK_MONOTONIC) + retry_deadline
683
+
684
+ @lock.synchronize do
685
+ reconnect
686
+
687
+ enable_lazy_transactions!
688
+ @raw_connection_dirty = false
689
+ @verified = true
690
+
691
+ reset_transaction(restore: restore_transactions) do
692
+ clear_cache!(new_connection: true)
693
+ configure_connection
694
+ end
695
+ rescue => original_exception
696
+ translated_exception = translate_exception_class(original_exception, nil, nil)
697
+ retry_deadline_exceeded = deadline && deadline < Process.clock_gettime(Process::CLOCK_MONOTONIC)
698
+
699
+ if !retry_deadline_exceeded && retries_available > 0
700
+ retries_available -= 1
701
+
702
+ if retryable_connection_error?(translated_exception)
703
+ backoff(connection_retries - retries_available)
704
+ retry
705
+ end
706
+ end
707
+
708
+ @verified = false
709
+
710
+ raise translated_exception
711
+ end
478
712
  end
479
713
 
480
714
  # Disconnects from the database if already connected. Otherwise, this
481
715
  # method does nothing.
482
716
  def disconnect!
483
- clear_cache!
484
- reset_transaction
717
+ @lock.synchronize do
718
+ clear_cache!(new_connection: true)
719
+ reset_transaction
720
+ @raw_connection_dirty = false
721
+ end
485
722
  end
486
723
 
487
724
  # Immediately forget this connection ever existed. Unlike disconnect!,
@@ -492,22 +729,20 @@ module ActiveRecord
492
729
  # rid of a connection that belonged to its parent.
493
730
  def discard!
494
731
  # This should be overridden by concrete adapters.
495
- #
496
- # Prevent @connection's finalizer from touching the socket, or
497
- # otherwise communicating with its server, when it is collected.
498
- if schema_cache.connection == self
499
- schema_cache.connection = nil
500
- end
501
732
  end
502
733
 
503
734
  # Reset the state of this connection, directing the DBMS to clear
504
735
  # transactions and other connection-related server-side state. Usually a
505
736
  # database-dependent operation.
506
737
  #
507
- # The default implementation does nothing; the implementation should be
508
- # overridden by concrete adapters.
738
+ # If a database driver or protocol does not support such a feature,
739
+ # implementors may alias this to #reconnect!. Otherwise, implementors
740
+ # should call super immediately after resetting the connection (and while
741
+ # still holding @lock).
509
742
  def reset!
510
- # this should be overridden by concrete adapters
743
+ clear_cache!(new_connection: true)
744
+ reset_transaction
745
+ configure_connection
511
746
  end
512
747
 
513
748
  # Removes the connection from the pool and disconnect it.
@@ -517,8 +752,16 @@ module ActiveRecord
517
752
  end
518
753
 
519
754
  # Clear any caching the database adapter may be doing.
520
- def clear_cache!
521
- @lock.synchronize { @statements.clear } if @statements
755
+ def clear_cache!(new_connection: false)
756
+ if @statements
757
+ @lock.synchronize do
758
+ if new_connection
759
+ @statements.reset
760
+ else
761
+ @statements.clear
762
+ end
763
+ end
764
+ end
522
765
  end
523
766
 
524
767
  # Returns true if its required to reload the connection between requests for development mode.
@@ -530,7 +773,31 @@ module ActiveRecord
530
773
  # This is done under the hood by calling #active?. If the connection
531
774
  # is no longer active, then this method will reconnect to the database.
532
775
  def verify!
533
- reconnect! unless active?
776
+ unless active?
777
+ @lock.synchronize do
778
+ if @unconfigured_connection
779
+ @raw_connection = @unconfigured_connection
780
+ @unconfigured_connection = nil
781
+ configure_connection
782
+ @verified = true
783
+ return
784
+ end
785
+
786
+ reconnect!(restore_transactions: true)
787
+ end
788
+ end
789
+
790
+ @verified = true
791
+ end
792
+
793
+ def connect!
794
+ verify!
795
+ self
796
+ end
797
+
798
+ def clean! # :nodoc:
799
+ @raw_connection_dirty = false
800
+ @verified = nil
534
801
  end
535
802
 
536
803
  # Provides access to the underlying database driver for this adapter. For
@@ -539,9 +806,16 @@ module ActiveRecord
539
806
  #
540
807
  # This is useful for when you need to call a proprietary method such as
541
808
  # PostgreSQL's lo_* methods.
809
+ #
810
+ # Active Record cannot track if the database is getting modified using
811
+ # this client. If that is the case, generally you'll want to invalidate
812
+ # the query cache using +ActiveRecord::Base.clear_query_cache+.
542
813
  def raw_connection
543
- disable_lazy_transactions!
544
- @connection
814
+ with_raw_connection do |conn|
815
+ disable_lazy_transactions!
816
+ @raw_connection_dirty = true
817
+ conn
818
+ end
545
819
  end
546
820
 
547
821
  def default_uniqueness_comparison(attribute, value) # :nodoc:
@@ -599,78 +873,259 @@ module ActiveRecord
599
873
  def check_version # :nodoc:
600
874
  end
601
875
 
602
- private
603
- def type_map
604
- @type_map ||= Type::TypeMap.new.tap do |mapping|
605
- initialize_type_map(mapping)
876
+ # Returns the version identifier of the schema currently available in
877
+ # the database. This is generally equal to the number of the highest-
878
+ # numbered migration that has been executed, or 0 if no schema
879
+ # information is present / the database is empty.
880
+ def schema_version
881
+ migration_context.current_version
882
+ end
883
+
884
+ class << self
885
+ def register_class_with_precision(mapping, key, klass, **kwargs) # :nodoc:
886
+ mapping.register_type(key) do |*args|
887
+ precision = extract_precision(args.last)
888
+ klass.new(precision: precision, **kwargs)
889
+ end
890
+ end
891
+
892
+ def extended_type_map(default_timezone:) # :nodoc:
893
+ Type::TypeMap.new(self::TYPE_MAP).tap do |m|
894
+ register_class_with_precision m, %r(\A[^\(]*time)i, Type::Time, timezone: default_timezone
895
+ register_class_with_precision m, %r(\A[^\(]*datetime)i, Type::DateTime, timezone: default_timezone
896
+ m.alias_type %r(\A[^\(]*timestamp)i, "datetime"
897
+ end
898
+ end
899
+
900
+ private
901
+ def initialize_type_map(m)
902
+ register_class_with_limit m, %r(boolean)i, Type::Boolean
903
+ register_class_with_limit m, %r(char)i, Type::String
904
+ register_class_with_limit m, %r(binary)i, Type::Binary
905
+ register_class_with_limit m, %r(text)i, Type::Text
906
+ register_class_with_precision m, %r(date)i, Type::Date
907
+ register_class_with_precision m, %r(time)i, Type::Time
908
+ register_class_with_precision m, %r(datetime)i, Type::DateTime
909
+ register_class_with_limit m, %r(float)i, Type::Float
910
+ register_class_with_limit m, %r(int)i, Type::Integer
911
+
912
+ m.alias_type %r(blob)i, "binary"
913
+ m.alias_type %r(clob)i, "text"
914
+ m.alias_type %r(timestamp)i, "datetime"
915
+ m.alias_type %r(numeric)i, "decimal"
916
+ m.alias_type %r(number)i, "decimal"
917
+ m.alias_type %r(double)i, "float"
918
+
919
+ m.register_type %r(^json)i, Type::Json.new
920
+
921
+ m.register_type(%r(decimal)i) do |sql_type|
922
+ scale = extract_scale(sql_type)
923
+ precision = extract_precision(sql_type)
924
+
925
+ if scale == 0
926
+ # FIXME: Remove this class as well
927
+ Type::DecimalWithoutScale.new(precision: precision)
928
+ else
929
+ Type::Decimal.new(precision: precision, scale: scale)
930
+ end
931
+ end
932
+ end
933
+
934
+ def register_class_with_limit(mapping, key, klass)
935
+ mapping.register_type(key) do |*args|
936
+ limit = extract_limit(args.last)
937
+ klass.new(limit: limit)
938
+ end
606
939
  end
940
+
941
+ def extract_scale(sql_type)
942
+ case sql_type
943
+ when /\((\d+)\)/ then 0
944
+ when /\((\d+)(,(\d+))\)/ then $3.to_i
945
+ end
946
+ end
947
+
948
+ def extract_precision(sql_type)
949
+ $1.to_i if sql_type =~ /\((\d+)(,\d+)?\)/
950
+ end
951
+
952
+ def extract_limit(sql_type)
953
+ $1.to_i if sql_type =~ /\((.*)\)/
954
+ end
955
+ end
956
+
957
+ TYPE_MAP = Type::TypeMap.new.tap { |m| initialize_type_map(m) }
958
+ EXTENDED_TYPE_MAPS = Concurrent::Map.new
959
+
960
+ private
961
+ def reconnect_can_restore_state?
962
+ transaction_manager.restorable? && !@raw_connection_dirty
607
963
  end
608
964
 
609
- def initialize_type_map(m = type_map)
610
- register_class_with_limit m, %r(boolean)i, Type::Boolean
611
- register_class_with_limit m, %r(char)i, Type::String
612
- register_class_with_limit m, %r(binary)i, Type::Binary
613
- register_class_with_limit m, %r(text)i, Type::Text
614
- register_class_with_precision m, %r(date)i, Type::Date
615
- register_class_with_precision m, %r(time)i, Type::Time
616
- register_class_with_precision m, %r(datetime)i, Type::DateTime
617
- register_class_with_limit m, %r(float)i, Type::Float
618
- register_class_with_limit m, %r(int)i, Type::Integer
619
-
620
- m.alias_type %r(blob)i, "binary"
621
- m.alias_type %r(clob)i, "text"
622
- m.alias_type %r(timestamp)i, "datetime"
623
- m.alias_type %r(numeric)i, "decimal"
624
- m.alias_type %r(number)i, "decimal"
625
- m.alias_type %r(double)i, "float"
626
-
627
- m.register_type %r(^json)i, Type::Json.new
628
-
629
- m.register_type(%r(decimal)i) do |sql_type|
630
- scale = extract_scale(sql_type)
631
- precision = extract_precision(sql_type)
632
-
633
- if scale == 0
634
- # FIXME: Remove this class as well
635
- Type::DecimalWithoutScale.new(precision: precision)
965
+ # Lock the monitor, ensure we're properly connected and
966
+ # transactions are materialized, and then yield the underlying
967
+ # raw connection object.
968
+ #
969
+ # If +allow_retry+ is true, a connection-related exception will
970
+ # cause an automatic reconnect and re-run of the block, up to
971
+ # the connection's configured +connection_retries+ setting
972
+ # and the configured +retry_deadline+ limit. (Note that when
973
+ # +allow_retry+ is true, it's possible to return without having marked
974
+ # the connection as verified. If the block is guaranteed to exercise the
975
+ # connection, consider calling `verified!` to avoid needless
976
+ # verification queries in subsequent calls.)
977
+ #
978
+ # If +materialize_transactions+ is false, the block will be run without
979
+ # ensuring virtual transactions have been materialized in the DB
980
+ # server's state. The active transaction will also remain clean
981
+ # (if it is not already dirty), meaning it's able to be restored
982
+ # by reconnecting and opening an equivalent-depth set of new
983
+ # transactions. This should only be used by transaction control
984
+ # methods, and internal transaction-agnostic queries.
985
+ #
986
+ ###
987
+ #
988
+ # It's not the primary use case, so not something to optimize
989
+ # for, but note that this method does need to be re-entrant:
990
+ # +materialize_transactions+ will re-enter if it has work to do,
991
+ # and the yield block can also do so under some circumstances.
992
+ #
993
+ # In the latter case, we really ought to guarantee the inner
994
+ # call will not reconnect (which would interfere with the
995
+ # still-yielded connection in the outer block), but we currently
996
+ # provide no special enforcement there.
997
+ #
998
+ def with_raw_connection(allow_retry: false, materialize_transactions: true)
999
+ @lock.synchronize do
1000
+ connect! if @raw_connection.nil? && reconnect_can_restore_state?
1001
+
1002
+ self.materialize_transactions if materialize_transactions
1003
+
1004
+ retries_available = allow_retry ? connection_retries : 0
1005
+ deadline = retry_deadline && Process.clock_gettime(Process::CLOCK_MONOTONIC) + retry_deadline
1006
+ reconnectable = reconnect_can_restore_state?
1007
+
1008
+ if @verified
1009
+ # Cool, we're confident the connection's ready to use. (Note this might have
1010
+ # become true during the above #materialize_transactions.)
1011
+ elsif reconnectable
1012
+ if allow_retry
1013
+ # Not sure about the connection yet, but if anything goes wrong we can
1014
+ # just reconnect and re-run our query
1015
+ else
1016
+ # We can reconnect if needed, but we don't trust the upcoming query to be
1017
+ # safely re-runnable: let's verify the connection to be sure
1018
+ verify!
1019
+ end
636
1020
  else
637
- Type::Decimal.new(precision: precision, scale: scale)
1021
+ # We don't know whether the connection is okay, but it also doesn't matter:
1022
+ # we wouldn't be able to reconnect anyway. We're just going to run our query
1023
+ # and hope for the best.
1024
+ end
1025
+
1026
+ begin
1027
+ yield @raw_connection
1028
+ rescue => original_exception
1029
+ translated_exception = translate_exception_class(original_exception, nil, nil)
1030
+ invalidate_transaction(translated_exception)
1031
+ retry_deadline_exceeded = deadline && deadline < Process.clock_gettime(Process::CLOCK_MONOTONIC)
1032
+
1033
+ if !retry_deadline_exceeded && retries_available > 0
1034
+ retries_available -= 1
1035
+
1036
+ if retryable_query_error?(translated_exception)
1037
+ backoff(connection_retries - retries_available)
1038
+ retry
1039
+ elsif reconnectable && retryable_connection_error?(translated_exception)
1040
+ reconnect!(restore_transactions: true)
1041
+ # Only allowed to reconnect once, because reconnect! has its own retry
1042
+ # loop
1043
+ reconnectable = false
1044
+ retry
1045
+ end
1046
+ end
1047
+
1048
+ unless retryable_query_error?(translated_exception)
1049
+ # Barring a known-retryable error inside the query (regardless of
1050
+ # whether we were in a _position_ to retry it), we should infer that
1051
+ # there's likely a real problem with the connection.
1052
+ @verified = false
1053
+ end
1054
+
1055
+ raise translated_exception
1056
+ ensure
1057
+ dirty_current_transaction if materialize_transactions
638
1058
  end
639
1059
  end
640
1060
  end
641
1061
 
642
- def reload_type_map
643
- type_map.clear
644
- initialize_type_map
1062
+ # Mark the connection as verified. Call this inside a
1063
+ # `with_raw_connection` block only when the block is guaranteed to
1064
+ # exercise the raw connection.
1065
+ def verified!
1066
+ @verified = true
645
1067
  end
646
1068
 
647
- def register_class_with_limit(mapping, key, klass)
648
- mapping.register_type(key) do |*args|
649
- limit = extract_limit(args.last)
650
- klass.new(limit: limit)
651
- end
1069
+ def retryable_connection_error?(exception)
1070
+ exception.is_a?(ConnectionNotEstablished) || exception.is_a?(ConnectionFailed)
652
1071
  end
653
1072
 
654
- def register_class_with_precision(mapping, key, klass)
655
- mapping.register_type(key) do |*args|
656
- precision = extract_precision(args.last)
657
- klass.new(precision: precision)
658
- end
1073
+ def invalidate_transaction(exception)
1074
+ return unless exception.is_a?(TransactionRollbackError)
1075
+ return unless savepoint_errors_invalidate_transactions?
1076
+
1077
+ current_transaction.invalidate!
659
1078
  end
660
1079
 
661
- def extract_scale(sql_type)
662
- case sql_type
663
- when /\((\d+)\)/ then 0
664
- when /\((\d+)(,(\d+))\)/ then $3.to_i
665
- end
1080
+ def retryable_query_error?(exception)
1081
+ # We definitely can't retry if we were inside an invalidated transaction.
1082
+ return false if current_transaction.invalidated?
1083
+
1084
+ exception.is_a?(Deadlocked) || exception.is_a?(LockWaitTimeout)
1085
+ end
1086
+
1087
+ def backoff(counter)
1088
+ sleep 0.1 * counter
1089
+ end
1090
+
1091
+ def reconnect
1092
+ raise NotImplementedError
1093
+ end
1094
+
1095
+ # Returns a raw connection for internal use with methods that are known
1096
+ # to both be thread-safe and not rely upon actual server communication.
1097
+ # This is useful for e.g. string escaping methods.
1098
+ def any_raw_connection
1099
+ @raw_connection || valid_raw_connection
666
1100
  end
667
1101
 
668
- def extract_precision(sql_type)
669
- $1.to_i if sql_type =~ /\((\d+)(,\d+)?\)/
1102
+ # Similar to any_raw_connection, but ensures it is validated and
1103
+ # connected. Any method called on this result still needs to be
1104
+ # independently thread-safe, so it probably shouldn't talk to the
1105
+ # server... but some drivers fail if they know the connection has gone
1106
+ # away.
1107
+ def valid_raw_connection
1108
+ (@verified && @raw_connection) ||
1109
+ # `allow_retry: false`, to force verification: the block won't
1110
+ # raise, so a retry wouldn't help us get the valid connection we
1111
+ # need.
1112
+ with_raw_connection(allow_retry: false, materialize_transactions: false) { |conn| conn }
670
1113
  end
671
1114
 
672
- def extract_limit(sql_type)
673
- $1.to_i if sql_type =~ /\((.*)\)/
1115
+ def extended_type_map_key
1116
+ if @default_timezone
1117
+ { default_timezone: @default_timezone }
1118
+ end
1119
+ end
1120
+
1121
+ def type_map
1122
+ if key = extended_type_map_key
1123
+ self.class::EXTENDED_TYPE_MAPS.compute_if_absent(key) do
1124
+ self.class.extended_type_map(**key)
1125
+ end
1126
+ else
1127
+ self.class::TYPE_MAP
1128
+ end
674
1129
  end
675
1130
 
676
1131
  def translate_exception_class(e, sql, binds)
@@ -683,7 +1138,7 @@ module ActiveRecord
683
1138
  exception
684
1139
  end
685
1140
 
686
- def log(sql, name = "SQL", binds = [], type_casted_binds = [], statement_name = nil) # :doc:
1141
+ def log(sql, name = "SQL", binds = [], type_casted_binds = [], statement_name = nil, async: false, &block) # :doc:
687
1142
  @instrumenter.instrument(
688
1143
  "sql.active_record",
689
1144
  sql: sql,
@@ -691,22 +1146,28 @@ module ActiveRecord
691
1146
  binds: binds,
692
1147
  type_casted_binds: type_casted_binds,
693
1148
  statement_name: statement_name,
694
- connection: self) do
695
- @lock.synchronize do
696
- yield
697
- end
698
- rescue => e
699
- raise translate_exception_class(e, sql, binds)
1149
+ async: async,
1150
+ connection: self,
1151
+ &block
1152
+ )
1153
+ rescue ActiveRecord::StatementInvalid => ex
1154
+ raise ex.set_query(sql, binds)
1155
+ end
1156
+
1157
+ def transform_query(sql)
1158
+ ActiveRecord.query_transformers.each do |transformer|
1159
+ sql = transformer.call(sql, self)
700
1160
  end
1161
+ sql
701
1162
  end
702
1163
 
703
1164
  def translate_exception(exception, message:, sql:, binds:)
704
1165
  # override in derived class
705
1166
  case exception
706
- when RuntimeError
1167
+ when RuntimeError, ActiveRecord::ActiveRecordError
707
1168
  exception
708
1169
  else
709
- ActiveRecord::StatementInvalid.new(message, sql: sql, binds: binds)
1170
+ ActiveRecord::StatementInvalid.new(message, sql: sql, binds: binds, connection_pool: @pool)
710
1171
  end
711
1172
  end
712
1173
 
@@ -753,6 +1214,26 @@ module ActiveRecord
753
1214
  def build_result(columns:, rows:, column_types: {})
754
1215
  ActiveRecord::Result.new(columns, rows, column_types)
755
1216
  end
1217
+
1218
+ # Perform any necessary initialization upon the newly-established
1219
+ # @raw_connection -- this is the place to modify the adapter's
1220
+ # connection settings, run queries to configure any application-global
1221
+ # "session" variables, etc.
1222
+ #
1223
+ # Implementations may assume this method will only be called while
1224
+ # holding @lock (or from #initialize).
1225
+ def configure_connection
1226
+ end
1227
+
1228
+ def default_prepared_statements
1229
+ true
1230
+ end
1231
+
1232
+ def warning_ignored?(warning)
1233
+ ActiveRecord.db_warnings_ignore.any? do |warning_matcher|
1234
+ warning.message.match?(warning_matcher) || warning.code.to_s.match?(warning_matcher)
1235
+ end
1236
+ end
756
1237
  end
757
1238
  end
758
1239
  end