Class: ActiveRecord::ConnectionAdapters::CockroachDBAdapter
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 =
0
Class Method Summary
collapse
Instance Method Summary
collapse
#insert_fixtures_set, #transaction_isolation_levels
#disable_referential_integrity
#add_index, #create_schema_dumper, #create_table_definition, #default_sequence_name, #foreign_keys, #native_database_types, #new_column_from_field, #primary_key, #reset_pk_sequence!, #schema_creation, #spatial_column_info, #type_to_sql
Constructor Details
#initialize(connection, logger, conn_params, config) ⇒ CockroachDBAdapter
Returns a new instance of CockroachDBAdapter.
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 233
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? "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
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.to_i
if @crdb_version >= 2120
begin
execute("SET intervalstyle_enabled = true", "SCHEMA")
execute("SET intervalstyle = iso_8601", "SCHEMA")
rescue
end
end
end
|
Class Method Details
.database_exists?(config) ⇒ Boolean
290
291
292
293
294
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 290
def self.database_exists?(config)
!!ActiveRecord::Base.cockroachdb_connection(config)
rescue ActiveRecord::NoDatabaseError
false
end
|
.spatial_column_options(key) ⇒ Object
124
125
126
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 124
def self.spatial_column_options(key)
SPATIAL_COLUMN_OPTIONS[key]
end
|
Instance Method Details
#debugging? ⇒ Boolean
145
146
147
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 145
def debugging?
!!ENV["DEBUG_COCKROACHDB_ADAPTER"]
end
|
#default_srid ⇒ Object
132
133
134
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 132
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.
227
228
229
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 227
def max_identifier_length
63
end
|
#max_transaction_retries ⇒ Object
149
150
151
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 149
def max_transaction_retries
@max_transaction_retries ||= @config.fetch(:max_transaction_retries, 3)
end
|
#postgis_lib_version ⇒ Object
128
129
130
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 128
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+.
154
155
156
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 154
def postgresql_version
100000
end
|
#srs_database_columns ⇒ Object
136
137
138
139
140
141
142
143
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 136
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
202
203
204
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 202
def supports_advisory_locks?
false
end
|
#supports_bulk_alter? ⇒ Boolean
158
159
160
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 158
def supports_bulk_alter?
false
end
|
194
195
196
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 194
def
@crdb_version >= 2010
end
|
198
199
200
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 198
def
false
end
|
#supports_datetime_with_precision? ⇒ Boolean
190
191
192
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 190
def supports_datetime_with_precision?
false
end
|
#supports_ddl_transactions? ⇒ Boolean
167
168
169
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 167
def supports_ddl_transactions?
false
end
|
#supports_expression_index? ⇒ Boolean
183
184
185
186
187
188
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 183
def supports_expression_index?
false
end
|
#supports_extensions? ⇒ Boolean
171
172
173
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 171
def supports_extensions?
false
end
|
#supports_json? ⇒ Boolean
162
163
164
165
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 162
def supports_json?
true
end
|
#supports_materialized_views? ⇒ Boolean
175
176
177
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 175
def supports_materialized_views?
false
end
|
#supports_partial_index? ⇒ Boolean
179
180
181
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 179
def supports_partial_index?
@crdb_version >= 2020
end
|
#supports_partitioned_indexes? ⇒ Boolean
214
215
216
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 214
def supports_partitioned_indexes?
false
end
|
#supports_string_to_array_coercion? ⇒ Boolean
210
211
212
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 210
def supports_string_to_array_coercion?
@crdb_version >= 2020
end
|
#supports_virtual_columns? ⇒ Boolean
206
207
208
|
# File 'lib/active_record/connection_adapters/cockroachdb_adapter.rb', line 206
def supports_virtual_columns?
@crdb_version >= 2110
end
|