activerecord-cockroachdb-adapter 7.2.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 496e736f6d7baf4f0acb18461a70d7686765262e3fd09f4a65ac49534582d871
-  data.tar.gz: 9bd072d1ac20b7f1099076fb5019c9cfbee305da4463de7f91ec493c8f6eebe3
+  metadata.gz: 297d02b873231237d61965f02c1a058a02f81927866af87a62aba2dd8da7d19a
+  data.tar.gz: b1d74cd086386ea3ae8d6ef9af2e3c8ba054e55136accadd667b3348f7a63a91
 SHA512:
-  metadata.gz: '044899369534c133039634cc835ce3efd71500a527d9249b10ca34fb8cb343f4754e0c72c8bc0f560267348881fe5d8e7701921b270431dfde1a810f1c48efad'
-  data.tar.gz: 5c67f56709062e0982998ff59f49f9caa1b14bb630e81339d6183821add59bfaf731f2af5e416b724fc00d3f57e17d63138eabec63166288185d69284bd53891
+  metadata.gz: e35e21188ac363b1e7f676588fbc478e0792af4669cdeab74c9eda58d6e1eae55dfc474de48cd7dcf9a9c95a516d3fbd49c56a42d265931aa738c8e9800046f7
+  data.tar.gz: 4c45ff7d9ffc569efa0b9838e67fb2a1d76fda059ddbeb0ed073fe1486286092477beaa83990863d08122028adb25b5f25f92beb9bce6b8118f6aed63502351b

data/.github/issue_template.md

@@ -0,0 +1,46 @@
+<!-- NOTE: This template is copying most of the Rails repo template -->
+
+### Steps to reproduce
+
+<!-- (Guidelines for creating a bug report are [available
+here](https://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#creating-a-bug-report)) -->
+
+<!-- Paste your executable test case created from one of the scripts found [here](https://github.com/cockroachdb/activerecord-cockroachdb-adapter/tree/master/.github/reproduction_scripts) below: -->
+
+```ruby
+# Your reproduction script goes here
+```
+
+### Expected behavior
+
+<!-- Tell us what should happen -->
+
+### Actual behavior
+
+<!-- Tell us what happens instead -->
+
+### System configuration
+
+<!-- Either fill manually or paste the output of this script within code blocks:
+
+```bash
+bundle info rails | head -1 &&
+	ruby -v &&
+	bundle info activerecord-cockroachdb-adapter | head -1 &&
+	cockroach --version
+```
+-->
+
+<!--
+```
+# output here (and uncomment!)
+```
+-->
+
+**Rails version**:
+
+**Ruby version**:
+
+**Adapter version**:
+
+**CockroachDB version**:

data/.github/reproduction_scripts/migrations.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+#
+# Adapted from https://github.com/rails/rails/blob/main/guides/bug_report_templates/active_record_migrations.rb
+
+require "bundler/inline"
+
+gemfile(true) do
+  source "https://rubygems.org"
+
+  gem "activerecord"
+
+  gem "activerecord-cockroachdb-adapter"
+end
+
+require "activerecord-cockroachdb-adapter"
+require "minitest/autorun"
+require "logger"
+
+# You might want to change the database name for another one.
+ActiveRecord::Base.establish_connection("cockroachdb://root@localhost:26257/defaultdb")
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+ActiveRecord::Schema.define do
+  create_table :payments, force: true do |t|
+    t.decimal :amount, precision: 10, scale: 0, default: 0, null: false
+  end
+end
+
+class Payment < ActiveRecord::Base
+end
+
+class ChangeAmountToAddScale < ActiveRecord::Migration::Current # or use a specific version via `Migration[number]`
+  def change
+    reversible do |dir|
+      dir.up do
+        change_column :payments, :amount, :decimal, precision: 10, scale: 2
+      end
+
+      dir.down do
+        change_column :payments, :amount, :decimal, precision: 10, scale: 0
+      end
+    end
+  end
+end
+
+class BugTest < ActiveSupport::TestCase
+  def test_migration_up
+    ChangeAmountToAddScale.migrate(:up)
+    Payment.reset_column_information
+
+    assert_equal "decimal(10,2)", Payment.columns.last.sql_type
+  end
+
+  def test_migration_down
+    ChangeAmountToAddScale.migrate(:down)
+    Payment.reset_column_information
+
+    assert_equal "decimal(10)", Payment.columns.last.sql_type
+  end
+end

data/.github/reproduction_scripts/models_and_database.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+#
+# Adapted from https://github.com/rails/rails/blob/main/guides/bug_report_templates/active_record.rb
+
+require "bundler/inline"
+
+gemfile(true) do
+  source "https://rubygems.org"
+
+  gem "activerecord"
+
+  gem "activerecord-cockroachdb-adapter"
+end
+
+require "activerecord-cockroachdb-adapter"
+require "minitest/autorun"
+require "logger"
+
+# You might want to change the database name for another one.
+ActiveRecord::Base.establish_connection("cockroachdb://root@localhost:26257/defaultdb")
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+ActiveRecord::Schema.define do
+  create_table :posts, force: true do |t|
+  end
+
+  create_table :comments, force: true do |t|
+    t.integer :post_id
+  end
+end
+
+class Post < ActiveRecord::Base
+  has_many :comments
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+end
+
+class BugTest < ActiveSupport::TestCase
+  def test_association_stuff
+    post = Post.create!
+    post.comments << Comment.create!
+
+    assert_equal 1, post.comments.count
+    assert_equal 1, Comment.count
+    assert_equal post.id, Comment.first.post.id
+  end
+end

data/.github/workflows/ci.yml

@@ -40,8 +40,8 @@ jobs:
       fail-fast: false
       matrix:
         # https://www.cockroachlabs.com/docs/releases/release-support-policy
-        crdb: [v23.2, v24.1, v24.2]
-        ruby: ["3.3"]
+        crdb: [v23.2, v24.1, v24.3]
+        ruby: ["3.4"]
     name: Test (crdb=${{ matrix.crdb }} ruby=${{ matrix.ruby }})
     steps:
       - name: Set Up Actions

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Ongoing
 
+## 8.0.0 - 2024-12-19
+
+- Add support for Rails 8.0 ([#356](https://github.com/cockroachdb/activerecord-cockroachdb-adapter/pull/356))
+
 ## 7.2.0 - 2024-09-24
 
 - Add support for Rails 7.2 ([#337](https://github.com/cockroachdb/activerecord-cockroachdb-adapter/pull/337))

data/Gemfile

@@ -63,7 +63,7 @@ group :development, :test do
 
   # Gems used by the ActiveRecord test suite
   gem "bcrypt", "~> 3.1"
-  gem "sqlite3", "~> 1.4"
+  gem "sqlite3", "~> 2.1"
 
   gem "minitest", "~> 5.15"
 end

data/README.md

@@ -8,16 +8,16 @@ of the PostgreSQL adapter that establishes compatibility with [CockroachDB](http
 Add this line to your project's Gemfile:
 
 ```ruby
-gem 'activerecord-cockroachdb-adapter', '~> 7.2.0'
+gem 'activerecord-cockroachdb-adapter', '~> 8.0.0'
 ```
 
-If you're using Rails 7.0, use the `7.0.x` versions of this gem.
-
 If you're using Rails 7.1, use the `7.1.x` versions of this gem.
 
 If you're using Rails 7.2, use the `7.2.x` versions of this gem.
 The minimal CockroachDB version required is 23.1.12 for this version.
 
+If you're using Rails 8.0, use the `8.0.x` versions of this gem.
+
 In `database.yml`, use the following adapter setting:
 
 ```

data/activerecord-cockroachdb-adapter.gemspec

@@ -14,9 +14,9 @@ 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", "~> 7.2.0"
+  spec.add_dependency "activerecord", "~> 8.0.0"
   spec.add_dependency "pg", "~> 1.5"
-  spec.add_dependency "rgeo-activerecord", "~> 7.0.0"
+  spec.add_dependency "rgeo-activerecord", "~> 8.0.0"
 
   spec.add_development_dependency "benchmark-ips", "~> 2.9.1"
 

data/bin/console

@@ -12,20 +12,22 @@ require "activerecord-cockroachdb-adapter"
 #       structure_load(Post.connection_db_config, "awesome-file.sql")
 require "active_record/connection_adapters/cockroachdb/database_tasks"
 
+DB_NAME = "ar_crdb_console"
+
 schema_kind = ENV.fetch("SCHEMA_KIND", ENV.fetch("SCHEMA", "default"))
 
-system("cockroach sql --insecure --host=localhost:26257 --execute='drop database if exists ar_crdb_console'",
+system("cockroach sql --insecure --host=localhost:26257 --execute='drop database if exists #{DB_NAME}'",
   exception: true)
-system("cockroach sql --insecure --host=localhost:26257 --execute='create database ar_crdb_console'",
+system("cockroach sql --insecure --host=localhost:26257 --execute='create database #{DB_NAME}'",
   exception: true)
 
 ActiveRecord::Base.establish_connection(
-  #Alternative version:  "cockroachdb://root@localhost:26257/ar_crdb_console"
+  #Alternative version:  "cockroachdb://root@localhost:26257/#{DB_NAME}"
   adapter: "cockroachdb",
   host: "localhost",
   port: 26257,
   user: "root",
-  database: "ar_crdb_console"
+  database: DB_NAME
 )
 
 load "#{__dir__}/console_schemas/#{schema_kind}.rb"

data/bin/console_schemas/default.rb

@@ -6,4 +6,6 @@ ActiveRecord::Schema.define do
     t.string :title
     t.text :body
   end
+
+  add_index("posts", ["title"], name: "index_posts_on_title", unique: true)
 end

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

@@ -24,10 +24,8 @@ module ActiveRecord
           table_deletes = tables_to_delete.map { |table| "DELETE FROM #{quote_table_name(table)}" }
           statements = table_deletes + fixture_inserts
 
-          with_multi_statements do
-            disable_referential_integrity do
-              execute_batch(statements, "Fixtures Load")
-            end
+          disable_referential_integrity do
+            execute_batch(statements, "Fixtures Load")
           end
         end
       end

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

@@ -50,6 +50,14 @@ module ActiveRecord
             super
           end
         end
+
+        def quoted_date(value)
+          # CockroachDB differs from PostgreSQL in its representation of
+          # a `timestamp with timezone`, it does not always include the
+          # timezone offset (e.g. `+00`), so we need to add it here.
+          # This is tested by `BasicsTest#test_default_in_local_time`.
+          super + value.strftime("%z")
+        end
       end
     end
   end

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

@@ -55,6 +55,37 @@ module ActiveRecord
           end
         end
 
+        def primary_keys(table_name)
+          return super unless database_version >= 24_02_02
+
+          query_values(<<~SQL, "SCHEMA")
+            SELECT a.attname
+              FROM (
+                     SELECT indrelid, indkey, generate_subscripts(indkey, 1) idx
+                       FROM pg_index
+                      WHERE indrelid = #{quote(quote_table_name(table_name))}::regclass
+                        AND indisprimary
+                   ) i
+              JOIN pg_attribute a
+                ON a.attrelid = i.indrelid
+               AND a.attnum = i.indkey[i.idx]
+               AND NOT a.attishidden
+             ORDER BY i.idx
+          SQL
+        end
+
+        def column_names_from_column_numbers(table_oid, column_numbers)
+          return super unless database_version >= 24_02_02
+
+          Hash[query(<<~SQL, "SCHEMA")].values_at(*column_numbers).compact
+            SELECT a.attnum, a.attname
+            FROM pg_attribute a
+            WHERE a.attrelid = #{table_oid}
+            AND a.attnum IN (#{column_numbers.join(", ")})
+            AND NOT a.attishidden
+          SQL
+        end
+
         # OVERRIDE: CockroachDB does not support deferrable constraints.
         #   See: https://go.crdb.dev/issue-v/31632/v23.1
         def foreign_key_options(from_table, to_table, options)

data/lib/active_record/connection_adapters/cockroachdb_adapter.rb

@@ -161,6 +161,15 @@ module ActiveRecord
         false
       end
 
+      # Partitioning is quite different from PostgreSQL, so we don't support it.
+      # If you need partitioning, you should default to using raw SQL queries.
+      #
+      # See https://www.postgresql.org/docs/current/ddl-partitioning.html
+      # See https://www.cockroachlabs.com/docs/stable/partitioning
+      def supports_native_partitioning?
+        false
+      end
+
       def supports_ddl_transactions?
         false
       end
@@ -181,6 +190,17 @@ module ActiveRecord
         false
       end
 
+      # OVERRIDE: UNIQUE CONSTRAINTS will create indexes anyway, so we only consider
+      #   then as indexes.
+      # See https://github.com/cockroachdb/activerecord-cockroachdb-adapter/issues/347.
+      # See https://www.cockroachlabs.com/docs/stable/unique.
+      #
+      # NOTE: support is actually partial, one can still use the `#unique_constraints`
+      #   method to get the unique constraints.
+      def supports_unique_constraints?
+        false
+      end
+
       def supports_expression_index?
         # Expression indexes are partially supported by CockroachDB v21.2,
         # but activerecord requires "ON CONFLICT expression" support.
@@ -393,32 +413,29 @@ module ActiveRecord
           # have [] appended to the end of it.
           re = /\A(?:geometry|geography|interval|numeric)/
 
-          # 0: attname
-          # 1: type
-          # 2: default
-          # 3: attnotnull
-          # 4: atttypid
-          # 5: atttypmod
-          # 6: collname
-          # 7: comment
-          # 8: attidentity
-          # 9: attgenerated
-          # 10: is_hidden
+          f_attname = 0
+          f_type = 1
+          # f_default = 2
+          # f_attnotnull = 3
+          # f_atttypid = 4
+          # f_atttypmod = 5
+          # f_collname = 6
+          f_comment = 7
+          # f_attidentity = 8
+          # f_attgenerated = 9
+          f_is_hidden = 10
           fields.map do |field|
-            dtype = field[1]
-            field[1] = crdb_fields[field[0]][2].downcase if re.match(dtype)
-            field[7] = crdb_fields[field[0]][1]&.gsub!(/^\'|\'?$/, '')
-            field[10] = true if crdb_fields[field[0]][3]
+            dtype = field[f_type]
+            field[f_type] = crdb_fields[field[f_attname]][2].downcase if re.match(dtype)
+            field[f_comment] = crdb_fields[field[f_attname]][1]&.gsub!(/^\'|\'?$/, '')
+            field[f_is_hidden] = true if crdb_fields[field[f_attname]][3]
             field
           end
           fields.delete_if do |field|
             # Don't include rowid column if it is hidden and the primary key
             # is not defined (meaning CRDB implicitly created it).
-            if field[0] == CockroachDBAdapter::DEFAULT_PRIMARY_KEY
-              field[10] && !primary_key(table_name)
-            else
-              false # Keep this entry.
-            end
+            field[f_attname] == CockroachDBAdapter::DEFAULT_PRIMARY_KEY &&
+              field[f_is_hidden] && !primary_key(table_name)
           end
         end
 
@@ -458,9 +475,7 @@ module ActiveRecord
         # That method will not work for CockroachDB because the error
         # originates from the "runExecBuilder" function, so we need
         # to modify the original to match the CockroachDB behavior.
-        def is_cached_plan_failure?(e)
-          pgerror = e.cause
-
+        def is_cached_plan_failure?(pgerror)
           pgerror.result.result_error_field(PG::PG_DIAG_SQLSTATE) == FEATURE_NOT_SUPPORTED &&
             pgerror.result.result_error_field(PG::PG_DIAG_SOURCE_FUNCTION) == "runExecBuilder"
         rescue

data/lib/active_record/relation/query_methods_ext.rb

@@ -57,7 +57,7 @@ module ActiveRecord
       def force_index!(index_name, direction: nil)
         return self unless from_clause_is_a_table_name?
 
-        index_name = sanitize_sql(index_name.to_s)
+        index_name = model.sanitize_sql(index_name.to_s)
         direction = direction.to_s.upcase
         direction = %w[ASC DESC].include?(direction) ? ",#{direction}" : ""
 
@@ -84,7 +84,7 @@ module ActiveRecord
       def index_hint!(hint)
         return self unless from_clause_is_a_table_name?
 
-        hint = sanitize_sql(hint.to_s)
+        hint = model.sanitize_sql(hint.to_s)
         @index_hint = hint.to_s
         self.from_clause = build_from_clause_with_hints
         self
@@ -120,7 +120,7 @@ module ActiveRecord
 
         table_name =
           if from_clause.empty?
-            quoted_table_name
+            model.quoted_table_name
           else
             # Remove previous table hints if any. And spaces.
             from_clause.value.partition("@").first.strip

data/lib/version.rb

@@ -15,5 +15,5 @@
 # limitations under the License.
 
 module ActiveRecord
-  COCKROACH_DB_ADAPTER_VERSION = "7.2.0"
+  COCKROACH_DB_ADAPTER_VERSION = "8.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-cockroachdb-adapter
 version: !ruby/object:Gem::Version
-  version: 7.2.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Cockroach Labs
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-30 00:00:00.000000000 Z
+date: 2024-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.2.0
+        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.2.0
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +75,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/issue_template.md"
+- ".github/reproduction_scripts/migrations.rb"
+- ".github/reproduction_scripts/models_and_database.rb"
 - ".github/workflows/ci.yml"
 - ".github/workflows/docker.yml"
 - ".gitignore"
@@ -127,7 +130,7 @@ licenses:
 - Apache-2.0
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -142,8 +145,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.5.23
+signing_key:
 specification_version: 4
 summary: CockroachDB adapter for ActiveRecord.
 test_files: []