Class: ActiveRecord::ConnectionAdapters::RedshiftAdapter

Inherits:
AbstractAdapter
  • Object
show all
Includes:
ActiveRecord::ConnectionAdapters::Redshift::DatabaseStatements, ActiveRecord::ConnectionAdapters::Redshift::Quoting, ActiveRecord::ConnectionAdapters::Redshift::ReferentialIntegrity, ActiveRecord::ConnectionAdapters::Redshift::SchemaStatements, Savepoints
Defined in:
lib/active_record/connection_adapters/redshift_adapter.rb

Overview

The PostgreSQL adapter works with the native C (bitbucket.org/ged/ruby-pg) driver.

Options:

  • :host - Defaults to a Unix-domain socket in /tmp. On machines without Unix-domain sockets, the default is to connect to localhost.

  • :port - Defaults to 5432.

  • :username - Defaults to be the same as the operating system name of the user running the application.

  • :password - Password to be used if the server demands password authentication.

  • :database - Defaults to be the same as the user name.

  • :schema_search_path - An optional schema search path for the connection given as a string of comma-separated schema names. This is backward-compatible with the :schema_order option.

  • :encoding - An optional client encoding that is used in a SET client_encoding TO <encoding> call on the connection.

  • :min_messages - An optional client min messages that is used in a SET client_min_messages TO <min_messages> call on the connection.

  • :variables - An optional hash of additional parameters that will be used in SET SESSION key = val calls on the connection.

  • :insert_returning - An optional boolean to control the use or RETURNING for INSERT statements defaults to true.

Any further options are used as connection parameters to libpq. See www.postgresql.org/docs/9.1/static/libpq-connect.html for the list of parameters.

In addition, default connection parameters of libpq can be set per environment variables. See www.postgresql.org/docs/9.1/static/libpq-envars.html .

Defined Under Namespace

Classes: StatementPool

Constant Summary collapse

ADAPTER_NAME = 
'Redshift'.freeze
NATIVE_DATABASE_TYPES = 
{
  primary_key: "integer identity",
  bigserial:   { name: "bigint" },
  string:      { name: "character varying" },
  text:        { name: "text" },
  integer:     { name: "integer" },
  float:       { name: "float" },
  decimal:     { name: "decimal" },
  datetime:    { name: "timestamp" },
  time:        { name: "time" },
  date:        { name: "date" },
  daterange:   { name: "daterange" },
  numrange:    { name: "numrange" },
  tsrange:     { name: "tsrange" },
  tstzrange:   { name: "tstzrange" },
  int4range:   { name: "int4range" },
  int8range:   { name: "int8range" },
  binary:      { name: "bytea" },
  boolean:     { name: "boolean" },
  bigint:      { name: "bigint" },
  xml:         { name: "xml" },
  tsvector:    { name: "tsvector" },
  hstore:      { name: "hstore" },
  inet:        { name: "inet" },
  cidr:        { name: "cidr" },
  macaddr:     { name: "macaddr" },
  uuid:        { name: "uuid" },
  json:        { name: "json" },
  jsonb:       { name: "jsonb" },
  ltree:       { name: "ltree" },
  citext:      { name: "citext" },
  point:       { name: "point" },
  bit:         { name: "bit" },
  bit_varying: { name: "bit varying" },
  money:       { name: "money" },
}
OID =

:nodoc:

Redshift::OID
OPERATION_ALIASES =

:nodoc:

{ # :nodoc:
  "maximum" => "max",
  "minimum" => "min",
  "average" => "avg",
}

Constants included from ActiveRecord::ConnectionAdapters::Redshift::DatabaseStatements

ActiveRecord::ConnectionAdapters::Redshift::DatabaseStatements::BYTEA_COLUMN_TYPE_OID, ActiveRecord::ConnectionAdapters::Redshift::DatabaseStatements::MONEY_COLUMN_TYPE_OID

Instance Method Summary collapse

Methods included from ActiveRecord::ConnectionAdapters::Redshift::DatabaseStatements

#begin_db_transaction, #begin_isolated_db_transaction, #commit_db_transaction, #create, #exec_delete, #exec_insert, #exec_query, #exec_rollback_db_transaction, #execute, #explain, #insert_sql, #query, #result_as_array, #select_rows, #select_value, #select_values, #sql_for_insert, #update_sql

Methods included from ActiveRecord::ConnectionAdapters::Redshift::SchemaStatements

#add_column, #add_index, #change_column, #change_column_default, #change_column_null, #client_min_messages, #client_min_messages=, #collation, #columns, #columns_for_distinct, #create_database, #create_schema, #ctype, #current_database, #current_schema, #default_sequence_name, #drop_database, #drop_schema, #drop_table, #encoding, #extract_foreign_key_action, #foreign_keys, #index_name_exists?, #index_name_length, #indexes, #new_column, #pk_and_sequence_for, #primary_key, #recreate_database, #remove_index!, #rename_column, #rename_index, #rename_table, #reset_pk_sequence!, #schema_exists?, #schema_names, #schema_search_path, #schema_search_path=, #serial_sequence, #set_pk_sequence!, #table_exists?, #tables, #type_to_sql

Methods included from ActiveRecord::ConnectionAdapters::Redshift::ReferentialIntegrity

#disable_referential_integrity, #supports_disable_referential_integrity?

Methods included from ActiveRecord::ConnectionAdapters::Redshift::Quoting

#escape_bytea, #quote_column_name, #quote_default_value, #quote_string, #quote_table_name, #quote_table_name_for_assignment, #quoted_date, #unescape_bytea

Constructor Details

#initialize(connection, logger, connection_parameters, config) ⇒ RedshiftAdapter

Initializes and connects a PostgreSQL adapter.



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 226

def initialize(connection, logger, connection_parameters, config)
  super(connection, logger)

  @visitor = Arel::Visitors::PostgreSQL.new self
  if self.class.type_cast_config_to_boolean(config.fetch(:prepared_statements) { true })
    @prepared_statements = true
  else
    @prepared_statements = false
  end

  connection_parameters.delete :prepared_statements
  @connection_parameters, @config = connection_parameters, config

  # @local_tz is initialized as nil to avoid warnings when connect tries to use it
  @local_tz = nil
  @table_alias_length = nil

  connect
  @statements = StatementPool.new @connection,
                                  self.class.type_cast_config_to_integer(config.fetch(:statement_limit) { 1000 })

  @type_map = Type::HashLookupTypeMap.new
  initialize_type_map(type_map)
  @local_tz = execute('SHOW TIME ZONE', 'SCHEMA').first["TimeZone"]
  @use_insert_returning = @config.key?(:insert_returning) ? self.class.type_cast_config_to_boolean(@config[:insert_returning]) : false
end

Instance Method Details

#active? ⇒ Boolean

Is this connection alive and ready for queries?

Returns:

  • (Boolean) 


263
264
265
266
267
268
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 263

def active?
  @connection.query 'SELECT 1'
  true
rescue PGError
  false
end

#clear_cache! ⇒ Object

Clears the prepared statements cache.



254
255
256
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 254

def clear_cache!
  @statements.clear
end

#column_name_for_operation(operation, node) ⇒ Object

:nodoc:



386
387
388
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 386

def column_name_for_operation(operation, node) # :nodoc:
  OPERATION_ALIASES.fetch(operation) { operation.downcase }
end

#disable_extension(name) ⇒ Object 



336
337
338
339
340
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 336

def disable_extension(name)
  exec_query("DROP EXTENSION IF EXISTS \"#{name}\" CASCADE").tap {
    reload_type_map
  }
end

#disconnect! ⇒ Object

Disconnects from the database if already connected. Otherwise, this method does nothing.



289
290
291
292
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 289

def disconnect!
  super
  @connection.close rescue nil
end

#enable_extension(name) ⇒ Object 



330
331
332
333
334
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 330

def enable_extension(name)
  exec_query("CREATE EXTENSION IF NOT EXISTS \"#{name}\"").tap {
    reload_type_map
  }
end

#extension_enabled?(name) ⇒ Boolean

Returns:

  • (Boolean) 


342
343
344
345
346
347
348
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 342

def extension_enabled?(name)
  if supports_extensions?
    res = exec_query "SELECT EXISTS(SELECT * FROM pg_available_extensions WHERE name = '#{name}' AND installed_version IS NOT NULL) as enabled",
      'SCHEMA'
    res.cast_values.first
  end
end

#extensions ⇒ Object 



350
351
352
353
354
355
356
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 350

def extensions
  if supports_extensions?
    exec_query("SELECT extname from pg_extension", "SCHEMA").cast_values
  else
    super
  end
end

#index_algorithms ⇒ Object 



168
169
170
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 168

def index_algorithms
  { concurrently: 'CONCURRENTLY' }
end

#lookup_cast_type(sql_type) ⇒ Object

:nodoc:



381
382
383
384
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 381

def lookup_cast_type(sql_type) # :nodoc:
  oid = execute("SELECT #{quote(sql_type)}::regtype::oid", "SCHEMA").first['oid'].to_i
  super(oid)
end

#migration_keys ⇒ Object

Adds :array as a valid migration key



138
139
140
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 138

def migration_keys
  super + [:array]
end

#native_database_types ⇒ Object

:nodoc:



294
295
296
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 294

def native_database_types #:nodoc:
  NATIVE_DATABASE_TYPES
end

#prepare_column_options(column, types) ⇒ Object

Adds :array option to the default set provided by the AbstractAdapter



130
131
132
133
134
135
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 130

def prepare_column_options(column, types) # :nodoc:
  spec = super
  spec[:array] = 'true' if column.respond_to?(:array) && column.array
  spec[:default] = "\"#{column.default_function}\"" if column.default_function
  spec
end

#reconnect! ⇒ Object

Close then reopen the connection.



271
272
273
274
275
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 271

def reconnect!
  super
  @connection.reset
  configure_connection
end

#reset! ⇒ Object 



277
278
279
280
281
282
283
284
285
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 277

def reset!
  clear_cache!
  reset_transaction
  unless @connection.transaction_status == ::PG::PQTRANS_IDLE
    @connection.query 'ROLLBACK'
  end
  @connection.query 'DISCARD ALL'
  configure_connection
end

#schema_creation ⇒ Object

:nodoc:



124
125
126
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 124

def schema_creation # :nodoc:
  Redshift::SchemaCreation.new self
end

#session_auth=(user) ⇒ Object

Set the authorized user for this session



364
365
366
367
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 364

def session_auth=(user)
  clear_cache!
  exec_query "SET SESSION AUTHORIZATION #{user}"
end

#supports_ddl_transactions? ⇒ Boolean

Returns:

  • (Boolean) 


308
309
310
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 308

def supports_ddl_transactions?
  true
end

#supports_explain? ⇒ Boolean

Returns:

  • (Boolean) 


312
313
314
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 312

def supports_explain?
  true
end

#supports_extensions? ⇒ Boolean

Returns true if pg > 9.1

Returns:

  • (Boolean) 


317
318
319
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 317

def supports_extensions?
  redshift_version >= 90100
end

#supports_foreign_keys? ⇒ Boolean

Returns:

  • (Boolean) 


160
161
162
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 160

def supports_foreign_keys?
  true
end

#supports_index_sort_order? ⇒ Boolean

Returns:

  • (Boolean) 


148
149
150
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 148

def supports_index_sort_order?
  true
end

#supports_materialized_views? ⇒ Boolean

Returns:

  • (Boolean) 


326
327
328
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 326

def supports_materialized_views?
  redshift_version >= 90300
end

#supports_migrations? ⇒ Boolean

Returns true, since this connection adapter supports migrations.

Returns:

  • (Boolean) 


299
300
301
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 299

def supports_migrations?
  true
end

#supports_partial_index? ⇒ Boolean

Returns:

  • (Boolean) 


152
153
154
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 152

def supports_partial_index?
  true
end

#supports_primary_key? ⇒ Boolean

Does PostgreSQL support finding primary key on non-Active Record tables?

Returns:

  • (Boolean) 


304
305
306
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 304

def supports_primary_key? #:nodoc:
  true
end

#supports_ranges? ⇒ Boolean

Range datatypes weren’t introduced until PostgreSQL 9.2

Returns:

  • (Boolean) 


322
323
324
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 322

def supports_ranges?
  redshift_version >= 90200
end

#supports_statement_cache? ⇒ Boolean

Returns true, since this connection adapter supports prepared statement caching.

Returns:

  • (Boolean) 


144
145
146
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 144

def supports_statement_cache?
  true
end

#supports_transaction_isolation? ⇒ Boolean

Returns:

  • (Boolean) 


156
157
158
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 156

def supports_transaction_isolation?
  true
end

#supports_views? ⇒ Boolean

Returns:

  • (Boolean) 


164
165
166
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 164

def supports_views?
  true
end

#table_alias_length ⇒ Object

Returns the configured supported identifier length supported by PostgreSQL



359
360
361
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 359

def table_alias_length
  @table_alias_length ||= query('SHOW max_identifier_length', 'SCHEMA')[0][0].to_i
end

#truncate(table_name, name = nil) ⇒ Object 



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

def truncate(table_name, name = nil)
  exec_query "TRUNCATE TABLE #{quote_table_name(table_name)}", name, []
end

#update_table_definition(table_name, base) ⇒ Object

:nodoc:



377
378
379
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 377

def update_table_definition(table_name, base) #:nodoc:
  Redshift::Table.new(table_name, base)
end

#use_insert_returning? ⇒ Boolean

Returns:

  • (Boolean) 


369
370
371
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 369

def use_insert_returning?
  false
end

#valid_type?(type) ⇒ Boolean

Returns:

  • (Boolean) 


373
374
375
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 373

def valid_type?(type)
  !native_database_types[type].nil?
end