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
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 - Does nothing for Redshift.

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 primary key",
  string:      { name: "varchar" },
  text:        { name: "varchar" },
  integer:     { name: "integer" },
  float:       { name: "float" },
  decimal:     { name: "decimal" },
  datetime:    { name: "timestamp" },
  time:        { name: "time" },
  date:        { name: "date" },
  bigint:      { name: "bigint" },
  boolean:     { name: "boolean" },
}
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, #exec_delete, #exec_insert, #exec_query, #exec_rollback_db_transaction, #execute, #explain, #query, #result_as_array, #select_rows, #select_value, #select_values, #sql_for_insert

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

#add_column, #add_index, #change_column, #change_column_default, #change_column_null, #collation, #columns, #columns_for_distinct, #create_database, #create_schema, #ctype, #current_database, #current_schema, #data_source_exists?, #data_sources, #default_sequence_name, #drop_database, #drop_schema, #drop_table, #encoding, #extract_foreign_key_action, #fetch_type_metadata, #foreign_keys, #index_name_exists?, #index_name_length, #indexes, #new_column, #pk_and_sequence_for, #primary_keys, #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, #view_exists?, #views

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_schema_name, #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.



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 186

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

  @visitor = Arel::Visitors::PostgreSQL.new self
  @prepared_statements = false

  @connection_parameters = connection_parameters

  # @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[:statement_limit])

  @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) 


218
219
220
221
222
223
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 218

def active?
  @connection.query 'SELECT 1'
  true
rescue PG::Error
  false
end

#clear_cache! ⇒ Object

Clears the prepared statements cache.



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

def clear_cache!
  @statements.clear
end

#column_name_for_operation(operation, node) ⇒ Object

:nodoc:



333
334
335
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 333

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

#disable_extension(name) ⇒ Object 



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

def disable_extension(name)
end

#disconnect! ⇒ Object

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



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

def disconnect!
  super
  @connection.close rescue nil
end

#enable_extension(name) ⇒ Object 



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

def enable_extension(name)
end

#extension_enabled?(name) ⇒ Boolean

Returns:

  • (Boolean) 


301
302
303
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 301

def extension_enabled?(name)
  false
end

#index_algorithms ⇒ Object 



127
128
129
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 127

def index_algorithms
  { concurrently: 'CONCURRENTLY' }
end

#lookup_cast_type(sql_type) ⇒ Object

:nodoc:



328
329
330
331
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 328

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

#native_database_types ⇒ Object

:nodoc:



249
250
251
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 249

def native_database_types #:nodoc:
  NATIVE_DATABASE_TYPES
end

#reconnect! ⇒ Object

Close then reopen the connection.



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

def reconnect!
  super
  @connection.reset
  configure_connection
end

#reset! ⇒ Object 



232
233
234
235
236
237
238
239
240
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 232

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:



97
98
99
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 97

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

#session_auth=(user) ⇒ Object

Set the authorized user for this session



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

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

#set_standard_conforming_strings ⇒ Object

Enable standard-conforming strings if available.



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

def set_standard_conforming_strings
  old, self.client_min_messages = client_min_messages, 'panic'
  execute('SET standard_conforming_strings = on', 'SCHEMA') rescue nil
ensure
  self.client_min_messages = old
end

#supports_ddl_transactions? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_ddl_transactions?
  true
end

#supports_explain? ⇒ Boolean

Returns:

  • (Boolean) 


275
276
277
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 275

def supports_explain?
  true
end

#supports_extensions? ⇒ Boolean

Returns:

  • (Boolean) 


279
280
281
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 279

def supports_extensions?
  false
end

#supports_foreign_keys? ⇒ Boolean

Returns:

  • (Boolean) 


119
120
121
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 119

def supports_foreign_keys?
  true
end

#supports_import? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_import?
  true
end

#supports_index_sort_order? ⇒ Boolean

Returns:

  • (Boolean) 


107
108
109
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 107

def supports_index_sort_order?
  false
end

#supports_materialized_views? ⇒ Boolean

Returns:

  • (Boolean) 


287
288
289
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 287

def supports_materialized_views?
  false
end

#supports_migrations? ⇒ Boolean

Returns true, since this connection adapter supports migrations.

Returns:

  • (Boolean) 


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

def supports_migrations?
  true
end

#supports_partial_index? ⇒ Boolean

Returns:

  • (Boolean) 


111
112
113
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 111

def supports_partial_index?
  false
end

#supports_primary_key? ⇒ Boolean

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

Returns:

  • (Boolean) 


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

def supports_primary_key? #:nodoc:
  true
end

#supports_ranges? ⇒ Boolean

Returns:

  • (Boolean) 


283
284
285
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 283

def supports_ranges?
  false
end

#supports_statement_cache? ⇒ Boolean

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

Returns:

  • (Boolean) 


103
104
105
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 103

def supports_statement_cache?
  true
end

#supports_transaction_isolation? ⇒ Boolean

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 115

def supports_transaction_isolation?
  false
end

#supports_views? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_views?
  true
end

#table_alias_length ⇒ Object

Returns the configured supported identifier length supported by PostgreSQL



306
307
308
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 306

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

#truncate(table_name, name = nil) ⇒ Object 



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

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:



324
325
326
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 324

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

#use_insert_returning? ⇒ Boolean

Returns:

  • (Boolean) 


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

def use_insert_returning?
  false
end

#valid_type?(type) ⇒ Boolean

Returns:

  • (Boolean) 


320
321
322
 
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 320

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