Class: ActiveRecord::ConnectionAdapters::CockroachDBAdapter

Inherits:
PostgreSQLAdapter
  • Object
show all
Includes:
ActiveRecord::ConnectionAdapters::CockroachDB::DatabaseStatements, ActiveRecord::ConnectionAdapters::CockroachDB::Quoting, ActiveRecord::ConnectionAdapters::CockroachDB::ReferentialIntegrity, ActiveRecord::ConnectionAdapters::CockroachDB::SchemaStatements
Defined in:
lib/active_record/connection_adapters/cockroachdb_adapter.rb

Constant Summary collapse

ADAPTER_NAME = 
"CockroachDB".freeze
DEFAULT_PRIMARY_KEY = 
"rowid"
SPATIAL_COLUMN_OPTIONS = 
{
  geography:           { geographic: true },
  geometry:            {},
  geometry_collection: {},
  line_string:         {},
  multi_line_string:   {},
  multi_point:         {},
  multi_polygon:       {},
  spatial:             {},
  st_point:            {},
  st_polygon:          {},
}
DEFAULT_SRID =

postgis.17.x6.nabble.com/Default-SRID-td5001115.html

0

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ActiveRecord::ConnectionAdapters::CockroachDB::DatabaseStatements

#insert_fixtures_set, #transaction_isolation_levels

Methods included from ActiveRecord::ConnectionAdapters::CockroachDB::ReferentialIntegrity

#disable_referential_integrity

Methods included from ActiveRecord::ConnectionAdapters::CockroachDB::SchemaStatements

#add_index, #create_table_definition, #default_sequence_name, #native_database_types, #new_column_from_field, #primary_key, #reset_pk_sequence!, #spatial_column_info, #type_to_sql

Constructor Details

#initialize(connection, logger, conn_params, config) ⇒ CockroachDBAdapter 



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 264

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."
    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
  else
    version_num = 202
  end
  @crdb_version = version_num
end

Class Method Details

.database_exists?(config) ⇒ Boolean 



284
285
286
287
288
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 284

def self.database_exists?(config)
  !!ActiveRecord::Base.cockroachdb_connection(config)
rescue ActiveRecord::NoDatabaseError
  false
end

.spatial_column_options(key) ⇒ Object 



154
155
156
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 154

def self.spatial_column_options(key)
  SPATIAL_COLUMN_OPTIONS[key]
end

Instance Method Details

#column_definitions(table_name) ⇒ Object

override This method makes a sql query to gather information about columns in a table. It returns an array of arrays (one for each col) and passes each to the SchemaStatements#new_column_from_field method as the field parameter. This data is then used to format the column objects for the model and sent to the OID for data casting.

The issue with the default method is that the sql_type field is retrieved with the ‘format_type` function, but this is implemented differently in CockroachDB than PostGIS, so geometry/geography types are missing information which makes parsing them impossible. Below is an example of what `format_type` returns for a geometry column.

column_type: geometry(POINT, 4326) Expected: geometry(POINT, 4326) Actual: geometry

The solution is to make the default query with super, then iterate through the columns and if it is a spatial type, access the proper column_type with the information_schema.columns table.

@see: github.com/rails/rails/blob/8695b028261bdd244e254993255c6641bdbc17a5/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb#L829



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 128

def column_definitions(table_name)
  fields = super
  # iterate through and identify all spatial fields based on format_type
  # being geometry or geography, then query for the information_schema.column
  # column_type because that contains the necessary information.
  fields.map do |field|
    dtype = field[1]
    if dtype == 'geometry' || dtype == 'geography'
      col_name = field[0]
      data_type = \
      query(<<~SQL, "SCHEMA")
        SELECT c.data_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]
    end
    field
  end
end

#debugging? ⇒ Boolean 



175
176
177
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 175

def debugging?
  !!ENV["DEBUG_COCKROACHDB_ADAPTER"]
end

#default_srid ⇒ Object 



162
163
164
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 162

def default_srid
  DEFAULT_SRID
end

#max_identifier_length ⇒ Object Also known as: index_name_length, table_alias_length

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 lengths far greater than this value. For the time being though, we match the original behavior for PostgreSQL to simplify migrations.

Note that in the migration to ActiveRecord 5.1, this was changed in PostgreSQLAdapter to use ‘SHOW max_identifier_length` (which does not exist in CockroachDB). Therefore, we have to redefine this here.



258
259
260
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 258

def max_identifier_length
  63
end

#max_transaction_retries ⇒ Object 



179
180
181
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 179

def max_transaction_retries
  @max_transaction_retries ||= @config.fetch(:max_transaction_retries, 3)
end

#postgis_lib_version ⇒ Object 



158
159
160
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 158

def postgis_lib_version
  @postgis_lib_version ||= select_value("SELECT PostGIS_Lib_Version()")
end

#postgresql_version ⇒ Object

CockroachDB 20.1 can run queries that work against PostgreSQL 10+.



184
185
186
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 184

def postgresql_version
  100000
end

#srs_database_columns ⇒ Object 



166
167
168
169
170
171
172
173
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 166

def srs_database_columns
  {
    auth_name_column: "auth_name",
    auth_srid_column: "auth_srid",
    proj4text_column: "proj4text",
    srtext_column:    "srtext",
  }
end

#supports_advisory_locks? ⇒ Boolean 



232
233
234
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 232

def supports_advisory_locks?
  false
end

#supports_bulk_alter? ⇒ Boolean 



188
189
190
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 188

def supports_bulk_alter?
  false
end

#supports_comments? ⇒ Boolean 



222
223
224
225
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 222

def supports_comments?
  # See cockroachdb/cockroach#19472.
  false
end

#supports_comments_in_create? ⇒ Boolean 



227
228
229
230
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 227

def supports_comments_in_create?
  # See cockroachdb/cockroach#19472.
  false
end

#supports_datetime_with_precision? ⇒ Boolean 



218
219
220
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 218

def supports_datetime_with_precision?
  false
end

#supports_ddl_transactions? ⇒ Boolean 



197
198
199
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 197

def supports_ddl_transactions?
  false
end

#supports_expression_index? ⇒ Boolean 



213
214
215
216
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 213

def supports_expression_index?
  # See cockroachdb/cockroach#9682
  false
end

#supports_extensions? ⇒ Boolean 



201
202
203
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 201

def supports_extensions?
  false
end

#supports_json? ⇒ Boolean 



192
193
194
195
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 192

def supports_json?
  # FIXME(joey): Add a version check.
  true
end

#supports_materialized_views? ⇒ Boolean 



205
206
207
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 205

def supports_materialized_views?
  false
end

#supports_partial_index? ⇒ Boolean 



209
210
211
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 209

def supports_partial_index?
  @crdb_version >= 202
end

#supports_partitioned_indexes? ⇒ Boolean 



245
246
247
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 245

def supports_partitioned_indexes?
  false
end

#supports_string_to_array_coercion? ⇒ Boolean 



241
242
243
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 241

def supports_string_to_array_coercion?
  @crdb_version >= 202
end

#supports_virtual_columns? ⇒ Boolean 



236
237
238
239
 
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 236

def supports_virtual_columns?
  # See cockroachdb/cockroach#20882.
  false
end