activerecord-cockroachdb-adapter 6.1.11 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29c3318f817a9fd47781d39fe3c9ae0271341a3c6d19398e4f284de85417c024
-  data.tar.gz: ceaef29be16168e8440a8beacae0b1c846d29093ea348c993d8ec25bebd43584
+  metadata.gz: c8f39021d1353c56c2830adac978ec3336f993bdb46e670f4c975be8d2c307c5
+  data.tar.gz: 8ea587bc12a5e5bc806901d28c7e67e9f63a0c2f5dfc769f2370ab4dd3f20c65
 SHA512:
-  metadata.gz: 67952a7628ffc8031dc13d7ad9590a11998f254445f490f4cfa21ab23135d6a7882ed3e9eb36514da9e6d6f91a4cbc0b2ac1a3a4ee61835f7e50b558bdbe7d9f
-  data.tar.gz: ef9ffcd4772e1c2593660c3e8ce55d2c30baaf32601ca945dcaa50cd668d30c197020bd5dc9cbf0ef5f55b0ec2145c89e3aebbc1f64f87cfbf5c295c3149a45b
+  metadata.gz: 6c7fca690e7203047ffeac709b9a62165c96f3ccb7ec26f3fe412daffc979f62ec392117912e15af15865aacf9f2b09bf2ff4d2efc155ee1f3dcbef1b2a213bb
+  data.tar.gz: 55cf42b3a055eabbec2045dac6650d50a96a085794dc2ef6bbb08efb44182daff7664720292f720099c3b08239edafbe1ae668779aa975426d9d8905fe98620b

data/CHANGELOG.md

@@ -1,8 +1,8 @@
 # Changelog
 
-## 6.1.11 - 2024-06-24
+## 7.0.0 - 2022-06-02
 
-- Add support for sql dump in rake tasks.
+- Add support for Active Record 7.0.3
 
 ## 6.1.10 - 2022-05-06
 

data/Gemfile

@@ -54,10 +54,12 @@ end
 
 group :development do
   gem "byebug"
-  gem "minitest-excludes"
+  gem "minitest-excludes", "~> 2.0.1"
 
   # Gems used by the ActiveRecord test suite
-  gem "bcrypt"
-  gem "mocha"
-  gem "sqlite3"
+  gem "bcrypt", "~> 3.1.18"
+  gem "mocha", "~> 1.14.0"
+  gem "sqlite3", "~> 1.4.4"
+
+  gem "minitest", "~> 5.15.0"
 end

data/README.md

@@ -1,19 +1,21 @@
 # ActiveRecord CockroachDB Adapter
 
-CockroachDB adapter for ActiveRecord 5 and 6. This is a lightweight extension of the PostgreSQL adapter that establishes compatibility with [CockroachDB](https://github.com/cockroachdb/cockroach).
+CockroachDB adapter for ActiveRecord 5, 6, and 7. This is a lightweight extension of the PostgreSQL adapter that establishes compatibility with [CockroachDB](https://github.com/cockroachdb/cockroach).
 
 ## Installation
 
 Add this line to your project's Gemfile:
 
 ```ruby
-gem 'activerecord-cockroachdb-adapter', '~> 6.1.0'
+gem 'activerecord-cockroachdb-adapter', '~> 7.0.0'
 ```
 
 If you're using Rails 5.2, use the `5.2.x` versions of this gem.
 
 If you're using Rails 6.0, use the `6.0.x` versions of this gem.
 
+If you're using Rails 7.0, use the `7.0.x` versions of this gem.
+
 In `database.yml`, use the following adapter setting:
 
 ```

data/activerecord-cockroachdb-adapter.gemspec

@@ -17,10 +17,12 @@ Gem::Specification.new do |spec|
   spec.description   = "Allows the use of CockroachDB as a backend for ActiveRecord and Rails apps."
   spec.homepage      = "https://github.com/cockroachdb/activerecord-cockroachdb-adapter"
 
-  spec.add_dependency "activerecord", "~> 6.1"
+  spec.add_dependency "activerecord", "~> 7.0.3"
   spec.add_dependency "pg", "~> 1.2"
   spec.add_dependency "rgeo-activerecord", "~> 7.0.0"
 
+  spec.add_development_dependency "benchmark-ips", "~> 2.9.1"
+
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)

data/build/teamcity-test.sh

@@ -3,7 +3,7 @@
 set -euox pipefail
 
 # Download CockroachDB
-VERSION=v21.2.5
+VERSION=v22.1.0
 wget -qO- https://binaries.cockroachdb.com/cockroach-$VERSION.linux-amd64.tgz | tar  xvz
 readonly COCKROACH=./cockroach-$VERSION.linux-amd64/cockroach
 
@@ -35,6 +35,8 @@ run_cockroach() {
   cockroach sql --insecure -e 'CREATE DATABASE activerecord_unittest2;'
   cockroach sql --insecure -e 'SET CLUSTER SETTING sql.stats.automatic_collection.enabled = false;'
   cockroach sql --insecure -e 'SET CLUSTER SETTING sql.stats.histogram_collection.enabled = false;'
+  cockroach sql --insecure -e "SET CLUSTER SETTING jobs.retention_time = '180s';"
+  cockroach sql --insecure -e "SET CLUSTER SETTING sql.defaults.experimental_alter_column_type.enabled = 'true'"
 
   cockroach sql --insecure -e "ALTER RANGE default CONFIGURE ZONE USING num_replicas = 1, gc.ttlseconds = 30;"
   cockroach sql --insecure -e "ALTER TABLE system.public.jobs CONFIGURE ZONE USING num_replicas = 1, gc.ttlseconds = 30;"
@@ -46,21 +48,14 @@ run_cockroach() {
   cockroach sql --insecure -e "SET CLUSTER SETTING kv.raft_log.disable_synchronization_unsafe = 'true'"
   cockroach sql --insecure -e "SET CLUSTER SETTING jobs.registry.interval.cancel = '180s';"
   cockroach sql --insecure -e "SET CLUSTER SETTING jobs.registry.interval.gc = '30s';"
-  cockroach sql --insecure -e "SET CLUSTER SETTING jobs.retention_time = '15s';"
-  cockroach sql --insecure -e "SET CLUSTER SETTING sql.stats.automatic_collection.enabled = false;"
   cockroach sql --insecure -e "SET CLUSTER SETTING kv.range_split.by_load_merge_delay = '5s';"
 
-  # Enable when we test with v22.1.
-  # cockroach sql --insecure -e "SET CLUSTER SETTING sql.catalog.unsafe_skip_system_config_trigger.enabled = true;"
-
   # Enable experimental features.
   cockroach sql --insecure -e "SET CLUSTER SETTING sql.defaults.experimental_temporary_tables.enabled = 'true';"
-  cockroach sql --insecure -e "SET CLUSTER SETTING sql.defaults.datestyle.enabled = true"
-  cockroach sql --insecure -e "SET CLUSTER SETTING sql.defaults.intervalstyle.enabled = true;"
 }
 
 # Install ruby dependencies.
-gem install bundler:2.1.4
+gem install bundler:2.3.14
 bundle install
 
 run_cockroach

data/lib/active_record/connection_adapters/cockroachdb/database_statements.rb

@@ -12,7 +12,8 @@ module ActiveRecord
           {
             read_committed:   "READ COMMITTED",
             repeatable_read:  "REPEATABLE READ",
-            serializable:     "SERIALIZABLE"
+            serializable:     "SERIALIZABLE",
+            read_uncommitted: "READ UNCOMMITTED"
           }
         end
 

data/lib/active_record/connection_adapters/cockroachdb/database_tasks.rb

@@ -5,43 +5,7 @@ module ActiveRecord
     module CockroachDB
       class DatabaseTasks < ActiveRecord::Tasks::PostgreSQLDatabaseTasks
         def structure_dump(filename, extra_flags=nil)
-          if extra_flags
-            raise "No flag supported yet, please raise an issue if needed. " \
-              "https://github.com/cockroachdb/activerecord-cockroachdb-adapter/issues/new"
-          end
-
-          case ActiveRecord::Base.dump_schemas
-          when :all, String
-            raise  "Custom schemas are not supported in CockroachDB. " \
-              "See https://github.com/cockroachdb/cockroach/issues/26443."
-          when :schema_search_path
-            if configuration_hash[:schema_search_path]
-              raise  "Custom schemas are not supported in CockroachDB. " \
-                "See https://github.com/cockroachdb/cockroach/issues/26443."
-            end
-          end
-
-          conn = ActiveRecord::Base.connection
-          File.open(filename, "w") do |file|
-            %w(SCHEMAS TYPES).each do |object_kind|
-              ActiveRecord::Base.connection.execute("SHOW CREATE ALL #{object_kind}").each_row { file.puts _1 }
-            end
-
-            ignore_tables = ActiveRecord::SchemaDumper.ignore_tables.to_set
-
-            conn.execute("SHOW CREATE ALL TABLES").each_row do |(sql)|
-              if sql.start_with?("CREATE")
-                table_name = sql[/CREATE TABLE (?:.*?\.)?\"?(.*?)[\" ]/, 1]
-                next if ignore_tables.member?(table_name)
-              elsif sql.start_with?("ALTER")
-                table_name = sql[/ALTER TABLE (?:.*?\.)?\"?(.*?)[\" ]/, 1]
-                ref_table_name = sql[/REFERENCES (?:.*?\.)?\"?(.*?)[\" ]/, 1]
-                next if ignore_tables.member?(table_name) || ignore_tables.member?(ref_table_name)
-              end
-
-              file.puts sql
-            end
-          end
+          raise "db:structure:dump is unimplemented. See https://github.com/cockroachdb/activerecord-cockroachdb-adapter/issues/2"
         end
 
         def structure_load(filename, extra_flags=nil)

data/lib/active_record/connection_adapters/cockroachdb/oid/date_time.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module CockroachDB
+      module OID
+        module DateTime
+          protected
+
+          # override
+          # Uses CockroachDBAdapter instead of PostgreSQLAdapter
+          def real_type_unless_aliased(real_type)
+            ActiveRecord::ConnectionAdapters::CockroachDBAdapter.datetime_type == real_type ? :datetime : real_type
+          end
+        end
+
+        PostgreSQL::OID::DateTime.prepend(DateTime)
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/cockroachdb/quoting.rb

@@ -2,8 +2,6 @@ module ActiveRecord
   module ConnectionAdapters
     module CockroachDB
       module Quoting
-        private
-
         # CockroachDB does not allow inserting integer values into string
         # columns, but ActiveRecord expects this to work. CockroachDB will
         # however allow inserting string values into integer columns. It will
@@ -19,7 +17,7 @@ module ActiveRecord
         # (https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry#Well-known_binary)
         # but when creating objects, using RGeo features is more convenient than
         # converting to WKB, so this does it automatically.
-        def _quote(value)
+        def quote(value)
           if value.is_a?(Numeric)
             "'#{quote_string(value.to_s)}'"
           elsif RGeo::Feature::Geometry.check_type(value)

data/lib/active_record/connection_adapters/cockroachdb/referential_integrity.rb

@@ -20,17 +20,31 @@ module ActiveRecord
 
           yield
 
-          foreign_keys.each do |foreign_key|
-            begin
-              add_foreign_key(foreign_key.from_table, foreign_key.to_table, **foreign_key.options)
-            rescue ActiveRecord::StatementInvalid => error
-              if error.cause.class == PG::DuplicateObject
-                # This error is safe to ignore because the yielded caller
-                # already re-added the foreign key constraint.
-              else
-                raise error
+          # Prefixes and suffixes are added in add_foreign_key
+          # in AR7+ so we need to temporarily disable them here,
+          # otherwise prefixes/suffixes will be erroneously added.
+          old_prefix = ActiveRecord::Base.table_name_prefix
+          old_suffix = ActiveRecord::Base.table_name_suffix
+
+          ActiveRecord::Base.table_name_prefix = ""
+          ActiveRecord::Base.table_name_suffix = ""
+
+          begin
+            foreign_keys.each do |foreign_key|
+              begin
+                add_foreign_key(foreign_key.from_table, foreign_key.to_table, **foreign_key.options)
+              rescue ActiveRecord::StatementInvalid => error
+                if error.cause.class == PG::DuplicateObject
+                  # This error is safe to ignore because the yielded caller
+                  # already re-added the foreign key constraint.
+                else
+                  raise error
+                end
               end
             end
+          ensure
+            ActiveRecord::Base.table_name_prefix = old_prefix
+            ActiveRecord::Base.table_name_suffix = old_suffix
           end
         end
       end

data/lib/active_record/connection_adapters/cockroachdb_adapter.rb

@@ -18,7 +18,9 @@ require "active_record/connection_adapters/cockroachdb/setup"
 require "active_record/connection_adapters/cockroachdb/oid/type_map_initializer"
 require "active_record/connection_adapters/cockroachdb/oid/spatial"
 require "active_record/connection_adapters/cockroachdb/oid/interval"
+require "active_record/connection_adapters/cockroachdb/oid/date_time"
 require "active_record/connection_adapters/cockroachdb/arel_tosql"
+require_relative "../migration/cockroachdb/compatibility"
 require_relative "../../version"
 
 # Run to ignore spatial tables that will break schemna dumper.
@@ -215,6 +217,10 @@ module ActiveRecord
         false
       end
 
+      def supports_deferrable_constraints?
+        false
+      end
+
       # This is hardcoded to 63 (as previously was in ActiveRecord 5.0) to aid in
       # migration from PostgreSQL to CockroachDB. In practice, this limitation
       # is arbitrary since CockroachDB supports index name lengths and table alias
@@ -293,8 +299,20 @@ module ActiveRecord
         false
       end
 
-      private
+      # override
+      # The PostgreSQLAdapter uses syntax for an anonymous function
+      # (DO $$) that CockroachDB does not support.
+      #
+      # Given a name and an array of values, creates an enum type.
+      def create_enum(name, values)
+        sql_values = values.map { |s| "'#{s}'" }.join(", ")
+        query = <<~SQL
+          CREATE TYPE IF NOT EXISTS \"#{name}\" AS ENUM (#{sql_values});
+        SQL
+        exec_query(query)
+      end
 
+      class << self
         def initialize_type_map(m = type_map)
           %w(
             geography
@@ -341,10 +359,13 @@ module ActiveRecord
               # lookups on PG
               Type::DecimalWithoutScale.new(precision: precision)
             else
-              OID::Decimal.new(precision: precision, scale: scale)
+              ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Decimal.new(precision: precision, scale: scale)
             end
           end
         end
+      end
+
+      private
 
         # Configures the encoding, verbosity, schema search path, and time zone of the connection.
         # This is called by #connect and should not be called manually.
@@ -366,7 +387,7 @@ module ActiveRecord
           # If using Active Record's time zone support configure the connection to return
           # TIMESTAMP WITH ZONE types in UTC.
           unless variables["timezone"]
-            if ActiveRecord::Base.default_timezone == :utc
+            if ActiveRecord.default_timezone == :utc
               variables["timezone"] = "UTC"
             elsif @local_tz
               variables["timezone"] = @local_tz

data/lib/active_record/migration/cockroachdb/compatibility.rb

@@ -0,0 +1,28 @@
+require "active_record/migration"
+require "active_record/migration/compatibility"
+
+module ActiveRecord
+  class Migration
+    module CockroachDB
+      module Compatibility
+        module V7_0Patch
+          # Override. Use "CockroachDB" instead of "PostgreSQL"
+          def compatible_timestamp_type(type, connection)
+            if connection.adapter_name == "CockroachDB"
+              # For Rails <= 6.1, :datetime was aliased to :timestamp
+              # See: https://github.com/rails/rails/blob/v6.1.3.2/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb#L108
+              # From Rails 7 onwards, you can define what :datetime resolves to (the default is still :timestamp)
+              # See `ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.datetime_type`
+              type.to_sym == :datetime ? :timestamp : type
+            else
+              type
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+prepend_mod = ActiveRecord::Migration::CockroachDB::Compatibility::V7_0Patch
+ActiveRecord::Migration::Compatibility::V6_1::PostgreSQLCompat.singleton_class.prepend(prepend_mod)

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecord
-  COCKROACH_DB_ADAPTER_VERSION = "6.1.11"
+  COCKROACH_DB_ADAPTER_VERSION = "7.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-cockroachdb-adapter
 version: !ruby/object:Gem::Version
-  version: 6.1.11
+  version: 7.0.0
 platform: ruby
 authors:
 - Cockroach Labs
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-24 00:00:00.000000000 Z
+date: 2022-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: 7.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: 7.0.3
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.1
 description: Allows the use of CockroachDB as a backend for ActiveRecord and Rails
   apps.
 email:
@@ -82,6 +96,7 @@ files:
 - lib/active_record/connection_adapters/cockroachdb/column_methods.rb
 - lib/active_record/connection_adapters/cockroachdb/database_statements.rb
 - lib/active_record/connection_adapters/cockroachdb/database_tasks.rb
+- lib/active_record/connection_adapters/cockroachdb/oid/date_time.rb
 - lib/active_record/connection_adapters/cockroachdb/oid/interval.rb
 - lib/active_record/connection_adapters/cockroachdb/oid/spatial.rb
 - lib/active_record/connection_adapters/cockroachdb/oid/type_map_initializer.rb
@@ -96,6 +111,7 @@ files:
 - lib/active_record/connection_adapters/cockroachdb/transaction_manager.rb
 - lib/active_record/connection_adapters/cockroachdb/type.rb
 - lib/active_record/connection_adapters/cockroachdb_adapter.rb
+- lib/active_record/migration/cockroachdb/compatibility.rb
 - lib/activerecord-cockroachdb-adapter.rb
 - lib/version.rb
 homepage: https://github.com/cockroachdb/activerecord-cockroachdb-adapter
@@ -118,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.9
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: CockroachDB adapter for ActiveRecord.