activerecord-cockroachdb-adapter 6.1.3 → 6.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2f121de56f7c6e8cf67c486533873cf2f081ec2dbe32a6d395849ecd9f7f958
-  data.tar.gz: 698808276bece741fc6ec06a69e871ca482e6e69ff3b9e5e95b278619bf4ee02
+  metadata.gz: 55fcba0c750ea29dde5f7a7efcabd35c1c81d1cbabee65ad1aeca9e16ab3e9d6
+  data.tar.gz: 1f3b6c480c3430c53f632d11647afc4d76b8d5a05990e3a7b7f21191f093c746
 SHA512:
-  metadata.gz: b2e9255a98a5114f7fd644baf0c2bd3e509f78b2fd73f4c5a85748b9e7ae8a1f212721ffcdf7e04f5bcb841bf752740ed4e0d2c97756f46b65677419fab89e10
-  data.tar.gz: b7680180bc3c35f350f92912f447a988582b54f6f90f18414f3b7a730b7b57bfa49c6bfbf2c7668e58a1974f140b02979c9d5cbbae5fa81d0871d39c123b6b39
+  metadata.gz: c29d9e502572a94a2a34ddf43f9cf09aac0aca3c63b6e489844a256cbbce7728ce90280acc8153ab4114dc9721eac37f26752936d5b3418c731fee17a2c1bd98
+  data.tar.gz: 68943312caf4a756081d806e7e6bb29a563d396f435226f2dadf595f2068649d1877f8bd79a88f2b65df9cc57ee998b4e2f7f6a81a7589f1ef03198cd3dc3a1d

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 6.1.6 - 2022-02-25
+
+- Fix mixed versions of CockroachDB v21.1 and v21.2 not working.
+
+## 6.1.5 - 2022-02-08
+
+- Support `atttypmod` being sent for DECIMAL types.
+  This is needed for CockroachDB v22.1.
+
+## 6.1.4 - 2021-12-09
+
+- Add support for CockroachDB v21.2.
+
 ## 6.1.3 - 2021-07-28
 
 - Santitize the input to the telemetry query that is issued on startup.

data/build/Dockerfile

@@ -4,7 +4,7 @@
 FROM cockroachdb/example-orms-builder:20200413-1918
 
 # Native dependencies for libxml-ruby and sqlite3.
-RUN apt-get update -y && apt-get install -y \
+RUN apt-get --allow-releaseinfo-change update -y && apt-get install -y \
   libxslt-dev \
   libxml2-dev \
   libsqlite3-dev \

data/build/teamcity-test.sh

@@ -3,7 +3,7 @@
 set -euox pipefail
 
 # Download CockroachDB
-VERSION=v21.1.5
+VERSION=v21.2.5
 wget -qO- https://binaries.cockroachdb.com/cockroach-$VERSION.linux-amd64.tgz | tar  xvz
 readonly COCKROACH=./cockroach-$VERSION.linux-amd64/cockroach
 
@@ -35,8 +35,28 @@ 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_temporary_tables.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;"
+  cockroach sql --insecure -e "ALTER RANGE meta CONFIGURE ZONE USING num_replicas = 1, gc.ttlseconds = 30;"
+  cockroach sql --insecure -e "ALTER RANGE system CONFIGURE ZONE USING num_replicas = 1, gc.ttlseconds = 30;"
+  cockroach sql --insecure -e "ALTER RANGE liveness CONFIGURE ZONE USING num_replicas = 1, gc.ttlseconds = 30;"
+
+  cockroach sql --insecure -e "SET CLUSTER SETTING kv.range_merge.queue_interval = '50ms'"
+  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.

data/docker.sh

@@ -4,10 +4,7 @@
 
 set -euox pipefail
 
-DOCKER_IMAGE_TAG=activerecord_test_container
-
-# Build the docker image to use.
-docker build -t ${DOCKER_IMAGE_TAG} build/
+DOCKER_IMAGE_TAG=cockroachdb/activerecord_test_container:20210914
 
 # Absolute path to this repository.
 repo_root=$(cd "$(dirname "${0}")" && pwd)
@@ -26,7 +23,7 @@ container_root=${repo_root}/docker_root
 mkdir -p "${container_root}"/{etc,home,home/"${username}"/activerecord-cockroachdb-adapter,home/.gems}
 echo "${username}:x:${uid_gid}::/home/${username}:/bin/bash" > "${container_root}/etc/passwd"
 
-docker run \
+exec docker run \
   --volume="${container_root}/etc/passwd:/etc/passwd" \
   --volume="${container_root}/home/${username}:/home/${username}" \
   --volume="${repo_root}:/home/${username}/activerecord-cockroachdb-adapter" \

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

@@ -22,7 +22,7 @@ module ActiveRecord
 
           foreign_keys.each do |foreign_key|
             begin
-              add_foreign_key(foreign_key.from_table, foreign_key.to_table, foreign_key.options)
+              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

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

@@ -32,6 +32,41 @@ module ActiveRecord
           end
         end
 
+        # override
+        # Modified version of the postgresql foreign_keys method.
+        # Replaces t2.oid::regclass::text with t2.relname since this is
+        # more efficient in CockroachDB.
+        def foreign_keys(table_name)
+          scope = quoted_scope(table_name)
+          fk_info = exec_query(<<~SQL, "SCHEMA")
+            SELECT t2.relname AS to_table, a1.attname AS column, a2.attname AS primary_key, c.conname AS name, c.confupdtype AS on_update, c.confdeltype AS on_delete, c.convalidated AS valid
+            FROM pg_constraint c
+            JOIN pg_class t1 ON c.conrelid = t1.oid
+            JOIN pg_class t2 ON c.confrelid = t2.oid
+            JOIN pg_attribute a1 ON a1.attnum = c.conkey[1] AND a1.attrelid = t1.oid
+            JOIN pg_attribute a2 ON a2.attnum = c.confkey[1] AND a2.attrelid = t2.oid
+            JOIN pg_namespace t3 ON c.connamespace = t3.oid
+            WHERE c.contype = 'f'
+              AND t1.relname = #{scope[:name]}
+              AND t3.nspname = #{scope[:schema]}
+            ORDER BY c.conname
+          SQL
+
+          fk_info.map do |row|
+            options = {
+              column: row["column"],
+              name: row["name"],
+              primary_key: row["primary_key"]
+            }
+
+            options[:on_delete] = extract_foreign_key_action(row["on_delete"])
+            options[:on_update] = extract_foreign_key_action(row["on_update"])
+            options[:validate] = row["valid"]
+
+            ForeignKeyDefinition.new(table_name, row["to_table"], options)
+          end
+        end
+
         # CockroachDB uses unique_rowid() for primary keys, not sequences. It's
         # possible to force a table to use sequences, but since it's not the
         # default behavior we'll always return nil for default_sequence_name.

data/lib/active_record/connection_adapters/cockroachdb_adapter.rb

@@ -46,7 +46,9 @@ module ActiveRecord
     # This rescue flow appears in new_client, but it is needed here as well
     # since Cockroach will sometimes not raise until a query is made.
     rescue ActiveRecord::StatementInvalid => error
-      if conn_params && conn_params[:dbname] && error.cause.message.include?(conn_params[:dbname])
+      no_db_err_check1 = conn_params && conn_params[:dbname] && error.cause.message.include?(conn_params[:dbname])
+      no_db_err_check2 = conn_params && conn_params[:dbname] && error.cause.message.include?("pg_type")
+      if no_db_err_check1 || no_db_err_check2
         raise ActiveRecord::NoDatabaseError
       else
         raise ActiveRecord::ConnectionNotEstablished, error.message
@@ -173,12 +175,11 @@ module ActiveRecord
       end
 
       def supports_partial_index?
-        @crdb_version >= 202
+        @crdb_version >= 2020
       end
 
       def supports_expression_index?
-        # See cockroachdb/cockroach#9682
-        false
+        @crdb_version >= 2122
       end
 
       def supports_datetime_with_precision?
@@ -186,7 +187,7 @@ module ActiveRecord
       end
 
       def supports_comments?
-        @crdb_version >= 201
+        @crdb_version >= 2010
       end
 
       def supports_comments_in_create?
@@ -198,12 +199,11 @@ module ActiveRecord
       end
 
       def supports_virtual_columns?
-        # See cockroachdb/cockroach#20882.
         false
       end
 
       def supports_string_to_array_coercion?
-        @crdb_version >= 202
+        @crdb_version >= 2020
       end
 
       def supports_partitioned_indexes?
@@ -228,23 +228,37 @@ module ActiveRecord
       def initialize(connection, logger, conn_params, config)
         super(connection, logger, conn_params, config)
 
-        crdb_version_string = query_value("SHOW crdb_version")
-        if crdb_version_string.include? "v1."
+        crdb_version_string = query_value("SHOW CLUSTER SETTING version")
+        if crdb_version_string.start_with? "1."
           version_num = 1
-        elsif crdb_version_string.include? "v2."
-          version_num 2
-        elsif crdb_version_string.include? "v19.1."
-          version_num = 191
-        elsif crdb_version_string.include? "v19.2."
-          version_num = 192
-        elsif crdb_version_string.include? "v20.1."
-          version_num = 201
-        elsif crdb_version_string.include? "v20.2."
-          version_num = 202
+        elsif crdb_version_string.start_with? "2."
+          version_num = 2
+        elsif crdb_version_string.start_with? "19.1"
+          version_num = 1910
+        elsif crdb_version_string.start_with? "19.2"
+          version_num = 1920
+        elsif crdb_version_string.start_with? "20.1"
+          version_num = 2010
+        elsif crdb_version_string.start_with? "20.2"
+          version_num = 2020
+        elsif crdb_version_string.start_with? "21.1"
+          version_num = 2110
+        elsif crdb_version_string.start_with? "21.2"
+          version_num = 2120
         else
-          version_num = 210
+          version_num = 2210
         end
         @crdb_version = version_num
+
+        # NOTE: this is normally in configure_connection, but that is run
+        # before crdb_version is determined. Once all supported versions
+        # of CockroachDB support SET intervalstyle it can safely be moved
+        # back.
+        # Set interval output format to ISO 8601 for ease of parsing by ActiveSupport::Duration.parse
+        if @crdb_version >= 2120
+          execute("SET intervalstyle_enabled = true", "SCHEMA")
+          execute("SET intervalstyle = iso_8601", "SCHEMA")
+        end
       end
 
       def self.database_exists?(config)
@@ -283,9 +297,19 @@ module ActiveRecord
             precision = extract_precision(sql_type)
             scale = extract_scale(sql_type)
 
+
+            # The type for the numeric depends on the width of the field,
+            # so we'll do something special here.
+            #
+            # When dealing with decimal columns:
+            #
+            # places after decimal  = fmod - 4 & 0xffff
+            # places before decimal = (fmod - 4) >> 16 & 0xffff
+            #
+            # For older versions of CockroachDB (<v22.1), fmod is -1 for 0 width.
             # If fmod is -1, that means that precision is defined but not
             # scale, or neither is defined.
-            if fmod && fmod == -1 && !precision.nil?
+            if fmod && ((fmod == -1 && !precision.nil?) || (fmod - 4 & 0xffff).zero?)
               # Below comment is from ActiveRecord
               # FIXME: Remove this class, and the second argument to
               # lookups on PG
@@ -352,7 +376,8 @@ module ActiveRecord
           super ||
             extract_escaped_string_from_default(default) ||
             extract_time_from_default(default) ||
-            extract_empty_array_from_default(default)
+            extract_empty_array_from_default(default) ||
+            extract_decimal_from_default(default)
         end
 
         # Both PostgreSQL and CockroachDB use C-style string escapes under the
@@ -403,6 +428,14 @@ module ActiveRecord
           return "{}"
         end
 
+        # This method exists to extract the decimal defaults (e.g. scientific notation)
+        # that don't get parsed correctly
+        def extract_decimal_from_default(default)
+          Float(default).to_s
+        rescue
+          nil
+        end
+
         # override
         # This method makes a query to gather information about columns
         # in a table. It returns an array of arrays (one for each col) and
@@ -416,7 +449,21 @@ module ActiveRecord
         #
         # @see: https://github.com/rails/rails/blob/8695b028261bdd244e254993255c6641bdbc17a5/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb#L829
         def column_definitions(table_name)
-          fields = super
+          fields = query(<<~SQL, "SCHEMA")
+              SELECT a.attname, format_type(a.atttypid, a.atttypmod),
+                     pg_get_expr(d.adbin, d.adrelid), a.attnotnull, a.atttypid, a.atttypmod,
+                     c.collname, NULL AS comment,
+                     #{supports_virtual_columns? ? 'attgenerated' : quote('')} as attgenerated
+                FROM pg_attribute a
+                LEFT JOIN pg_attrdef d ON a.attrelid = d.adrelid AND a.attnum = d.adnum
+                LEFT JOIN pg_type t ON a.atttypid = t.oid
+                LEFT JOIN pg_collation c ON a.attcollation = c.oid AND a.attcollation <> t.typcollation
+               WHERE a.attrelid = #{quote(quote_table_name(table_name))}::regclass
+                 AND a.attnum > 0 AND NOT a.attisdropped
+               ORDER BY a.attnum
+          SQL
+
+          crdb_fields = crdb_column_definitions(table_name)
 
           # Use regex comparison because if a type is an array it will
           # have [] appended to the end of it.
@@ -426,32 +473,33 @@ module ActiveRecord
             /interval/,
             /numeric/
           ]
+
           re = Regexp.union(target_types)
           fields.map do |field|
             dtype = field[1]
-            if re.match(dtype)
-              crdb_column_definition(field, table_name)
-            else
-              field
-            end
+            field[1] = crdb_fields[field[0]][2].downcase if re.match(dtype)
+            field[7] = crdb_fields[field[0]][1]&.gsub!(/^\'|\'?$/, '')
+            field
           end
         end
 
+        # Fetch the column comment because it's faster this way
         # Use the crdb_sql_type instead of the sql_type returned by
         # column_definitions. This will include limit,
         # precision, and scale information in the type.
         # Ex. geometry -> geometry(point, 4326)
-        def crdb_column_definition(field, table_name)
-          col_name = field[0]
-          data_type = \
+        def crdb_column_definitions(table_name)
+          fields = \
           query(<<~SQL, "SCHEMA")
-            SELECT c.crdb_sql_type
+            SELECT c.column_name, c.column_comment, c.crdb_sql_type
               FROM information_schema.columns c
             WHERE c.table_name = #{quote(table_name)}
-              AND c.column_name = #{quote(col_name)}
           SQL
-          field[1] = data_type[0][0].downcase
-          field
+
+          fields.reduce({}) do |a, e|
+            a[e[0]] = e
+            a
+          end
         end
 
         # override

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-cockroachdb-adapter
 version: !ruby/object:Gem::Version
-  version: 6.1.3
+  version: 6.1.6
 platform: ruby
 authors:
 - Cockroach Labs
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-29 00:00:00.000000000 Z
+date: 2022-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -101,7 +101,7 @@ licenses:
 - Apache-2.0
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -116,8 +116,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: CockroachDB adapter for ActiveRecord.
 test_files: []