activerecord-cockroachdb-adapter 6.1.6 → 6.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55fcba0c750ea29dde5f7a7efcabd35c1c81d1cbabee65ad1aeca9e16ab3e9d6
-  data.tar.gz: 1f3b6c480c3430c53f632d11647afc4d76b8d5a05990e3a7b7f21191f093c746
+  metadata.gz: a8b028b8755fedebaa4aff7f1f98218d553726364df8fcc24647c3bfd7c80e2d
+  data.tar.gz: 3f7268dccaf636eb1532697dd525a39930a829eba290f06d7446cc24547e0ea1
 SHA512:
-  metadata.gz: c29d9e502572a94a2a34ddf43f9cf09aac0aca3c63b6e489844a256cbbce7728ce90280acc8153ab4114dc9721eac37f26752936d5b3418c731fee17a2c1bd98
-  data.tar.gz: 68943312caf4a756081d806e7e6bb29a563d396f435226f2dadf595f2068649d1877f8bd79a88f2b65df9cc57ee998b4e2f7f6a81a7589f1ef03198cd3dc3a1d
+  metadata.gz: cea6678432382da1af4de2fb0216d820bde0be2c254d564fa931fc34683898ec72faf507263bed58187e2f582f55b1c590d1ba8b3fd8487be69518578903821f
+  data.tar.gz: a3e7d5dbc70abfeac236084dbcc7e60530d10413fbee0f8d6c08668c11d7ab3394e882b6a5a4b660520a1c456de09585128f66de92708ab2ad314f9ca3c66498

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 6.1.9 - 2022-04-26
+
+- Fix bug where duplicate `rowid` columns would be created when loading
+  a schema dump of a table that was not created with an explicit primary key.
+- Support the NOT VISIBLE syntax from CockroachDB, by using the `hidden`
+  column modifier in the Rails schema.
+
+## 6.1.8 - 2022-03-14
+
+- Add a test helper from https://github.com/rails/rails/pull/40822
+  to be able to test against Rails upstream.
+
+## 6.1.7 - 2022-03-01
+
+- Fix query to get the CockroachDB version so it does not require any privileges.
+
 ## 6.1.6 - 2022-02-25
 
 - Fix mixed versions of CockroachDB v21.1 and v21.2 not working.

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

@@ -6,9 +6,10 @@ module ActiveRecord
         # https://github.com/rgeo/activerecord-postgis-adapter/blob/master/lib/active_record/connection_adapters/postgis/spatial_column.rb
         def initialize(name, default, sql_type_metadata = nil, null = true,
                        default_function = nil, collation: nil, comment: nil,
-                       serial: nil, spatial: nil)
+                       serial: nil, spatial: nil, generated: nil, hidden: nil)
           @sql_type_metadata = sql_type_metadata
           @geographic = !!(sql_type_metadata.sql_type =~ /geography\(/i)
+          @hidden = hidden
 
           if spatial
             # This case comes from an entry in the geometry_columns table
@@ -29,7 +30,7 @@ module ActiveRecord
             build_from_sql_type(sql_type_metadata.sql_type)
           end
           super(name, default, sql_type_metadata, null, default_function,
-            collation: collation, comment: comment, serial: serial)
+            collation: collation, comment: comment, serial: serial, generated: generated)
           if spatial? && @srid
             @limit = { srid: @srid, type: to_type_name(geometric_type) }
             @limit[:has_z] = true if @has_z
@@ -52,6 +53,14 @@ module ActiveRecord
           spatial? ? @limit : super
         end
 
+        def virtual?
+          @generated.present?
+        end
+
+        def hidden?
+          @hidden
+        end
+
         def spatial?
           %i[geometry geography].include?(@sql_type_metadata.type)
         end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module CockroachDB
+      class SchemaCreation < PostgreSQL::SchemaCreation # :nodoc:
+        private
+          def add_column_options!(sql, options)
+            if options[:hidden]
+              sql << " NOT VISIBLE"
+            end
+            super
+          end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module CockroachDB
+      class SchemaDumper < ConnectionAdapters::PostgreSQL::SchemaDumper # :nodoc:
+        private
+          def prepare_column_options(column)
+            spec = super
+            if column.hidden?
+              spec[:hidden] = true
+            end
+            spec
+          end
+      end
+    end
+  end
+end
+

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

@@ -77,7 +77,7 @@ module ActiveRecord
         # override
         # https://github.com/rails/rails/blob/6-0-stable/activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb#L624
         def new_column_from_field(table_name, field)
-          column_name, type, default, notnull, oid, fmod, collation, comment = field
+          column_name, type, default, notnull, oid, fmod, collation, comment, generated, hidden = field
           type_metadata = fetch_type_metadata(column_name, type, oid.to_i, fmod.to_i)
           default_value = extract_value_from_default(default)
           default_function = extract_default_function(default_value, default)
@@ -99,7 +99,9 @@ module ActiveRecord
             collation: collation,
             comment: comment.presence,
             serial: serial,
-            spatial: spatial
+            spatial: spatial,
+            generated: generated,
+            hidden: hidden
           )
         end
 
@@ -186,6 +188,14 @@ module ActiveRecord
           @spatial_column_info ||= {}
           @spatial_column_info[table_name.to_sym] ||= SpatialColumnInfo.new(self, table_name.to_s)
         end
+
+        def create_schema_dumper(options)
+          CockroachDB::SchemaDumper.create(self, options)
+        end
+
+        def schema_creation
+          CockroachDB::SchemaCreation.new(self)
+        end
       end
     end
   end

data/lib/active_record/connection_adapters/cockroachdb_adapter.rb

@@ -1,7 +1,10 @@
 require "rgeo/active_record"
 
 require "active_record/connection_adapters/postgresql_adapter"
+require "active_record/connection_adapters/cockroachdb/attribute_methods"
 require "active_record/connection_adapters/cockroachdb/column_methods"
+require "active_record/connection_adapters/cockroachdb/schema_creation"
+require "active_record/connection_adapters/cockroachdb/schema_dumper"
 require "active_record/connection_adapters/cockroachdb/schema_statements"
 require "active_record/connection_adapters/cockroachdb/referential_integrity"
 require "active_record/connection_adapters/cockroachdb/transaction_manager"
@@ -9,7 +12,6 @@ require "active_record/connection_adapters/cockroachdb/database_statements"
 require "active_record/connection_adapters/cockroachdb/table_definition"
 require "active_record/connection_adapters/cockroachdb/quoting"
 require "active_record/connection_adapters/cockroachdb/type"
-require "active_record/connection_adapters/cockroachdb/attribute_methods"
 require "active_record/connection_adapters/cockroachdb/column"
 require "active_record/connection_adapters/cockroachdb/spatial_column_info"
 require "active_record/connection_adapters/cockroachdb/setup"
@@ -199,7 +201,7 @@ module ActiveRecord
       end
 
       def supports_virtual_columns?
-        false
+        @crdb_version >= 2110
       end
 
       def supports_string_to_array_coercion?
@@ -228,27 +230,42 @@ module ActiveRecord
       def initialize(connection, logger, conn_params, config)
         super(connection, logger, conn_params, config)
 
-        crdb_version_string = query_value("SHOW CLUSTER SETTING version")
-        if crdb_version_string.start_with? "1."
-          version_num = 1
-        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
+        # crdb_version is the version of the binary running on the node. We
+        # really want to use `SHOW CLUSTER SETTING version` to get the cluster
+        # version, but that is only available to admins. Instead, we can use
+        # crdb_internal.is_at_least_version, but that's only available in 22.1.
+        crdb_version_string = query_value("SHOW crdb_version")
+        if crdb_version_string.include? "v22.1"
+          version_num = query_value(<<~SQL, "VERSION")
+            SELECT
+              CASE
+              WHEN crdb_internal.is_at_least_version('22.2') THEN 2220
+              WHEN crdb_internal.is_at_least_version('22.1') THEN 2210
+              ELSE 2120
+              END;
+          SQL
         else
-          version_num = 2210
+          # This branch can be removed once the dialect stops supporting v21.2
+          # and earlier.
+          if crdb_version_string.include? "v1."
+            version_num = 1
+          elsif crdb_version_string.include? "v2."
+            version_num 2
+          elsif crdb_version_string.include? "v19.1."
+            version_num = 1910
+          elsif crdb_version_string.include? "v19.2."
+            version_num = 1920
+          elsif crdb_version_string.include? "v20.1."
+            version_num = 2010
+          elsif crdb_version_string.include? "v20.2."
+            version_num = 2020
+          elsif crdb_version_string.include? "v21.1."
+            version_num = 2110
+          else
+            version_num = 2120
+          end
         end
-        @crdb_version = version_num
+        @crdb_version = version_num.to_i
 
         # NOTE: this is normally in configure_connection, but that is run
         # before crdb_version is determined. Once all supported versions
@@ -256,8 +273,14 @@ module ActiveRecord
         # 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")
+          begin
+            execute("SET intervalstyle_enabled = true", "SCHEMA")
+            execute("SET intervalstyle = iso_8601", "SCHEMA")
+          rescue
+            # Ignore any error. This can happen with a cluster that has
+            # not yet finalized the v21.2 upgrade. v21.2 does not have
+            # a way to tell if the upgrade was finalized (see comment above).
+          end
         end
       end
 
@@ -453,7 +476,8 @@ module ActiveRecord
               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
+                     #{supports_virtual_columns? ? 'attgenerated' : quote('')} as attgenerated,
+                     NULL as is_hidden
                 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
@@ -479,8 +503,18 @@ module ActiveRecord
             dtype = field[1]
             field[1] = crdb_fields[field[0]][2].downcase if re.match(dtype)
             field[7] = crdb_fields[field[0]][1]&.gsub!(/^\'|\'?$/, '')
+            field[9] = true if crdb_fields[field[0]][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[9] && !primary_key(table_name)
+            else
+              false # Keep this entry.
+            end
+          end
         end
 
         # Fetch the column comment because it's faster this way
@@ -491,7 +525,7 @@ module ActiveRecord
         def crdb_column_definitions(table_name)
           fields = \
           query(<<~SQL, "SCHEMA")
-            SELECT c.column_name, c.column_comment, c.crdb_sql_type
+            SELECT c.column_name, c.column_comment, c.crdb_sql_type, c.is_hidden::BOOLEAN
               FROM information_schema.columns c
             WHERE c.table_name = #{quote(table_name)}
           SQL

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-cockroachdb-adapter
 version: !ruby/object:Gem::Version
-  version: 6.1.6
+  version: 6.1.9
 platform: ruby
 authors:
 - Cockroach Labs
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-25 00:00:00.000000000 Z
+date: 2022-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -87,6 +87,8 @@ files:
 - lib/active_record/connection_adapters/cockroachdb/oid/type_map_initializer.rb
 - lib/active_record/connection_adapters/cockroachdb/quoting.rb
 - lib/active_record/connection_adapters/cockroachdb/referential_integrity.rb
+- lib/active_record/connection_adapters/cockroachdb/schema_creation.rb
+- lib/active_record/connection_adapters/cockroachdb/schema_dumper.rb
 - lib/active_record/connection_adapters/cockroachdb/schema_statements.rb
 - lib/active_record/connection_adapters/cockroachdb/setup.rb
 - lib/active_record/connection_adapters/cockroachdb/spatial_column_info.rb
@@ -101,7 +103,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 +118,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.1.6
+signing_key:
 specification_version: 4
 summary: CockroachDB adapter for ActiveRecord.
 test_files: []