Class: ActiveRecord::ConnectionAdapters::RedshiftAdapter
- Inherits:
-
AbstractAdapter
- Object
- AbstractAdapter
- ActiveRecord::ConnectionAdapters::RedshiftAdapter
- 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 aSET client_encoding TO <encoding>
call on the connection. -
:min_messages
- An optional client min messages that is used in aSET client_min_messages TO <min_messages>
call on the connection. -
:variables
- An optional hash of additional parameters that will be used inSET 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
-
#active? ⇒ Boolean
Is this connection alive and ready for queries?.
-
#clear_cache! ⇒ Object
Clears the prepared statements cache.
-
#column_name_for_operation(operation, node) ⇒ Object
:nodoc:.
- #disable_extension(name) ⇒ Object
-
#disconnect! ⇒ Object
Disconnects from the database if already connected.
- #enable_extension(name) ⇒ Object
- #extension_enabled?(name) ⇒ Boolean
- #index_algorithms ⇒ Object
-
#initialize(connection, logger, connection_parameters, config) ⇒ RedshiftAdapter
constructor
Initializes and connects a PostgreSQL adapter.
-
#lookup_cast_type(sql_type) ⇒ Object
:nodoc:.
-
#native_database_types ⇒ Object
:nodoc:.
-
#prepare_column_options(column, types) ⇒ Object
Adds
:array
option to the default set provided by the AbstractAdapter. -
#reconnect! ⇒ Object
Close then reopen the connection.
- #reset! ⇒ Object
-
#schema_creation ⇒ Object
:nodoc:.
-
#session_auth=(user) ⇒ Object
Set the authorized user for this session.
-
#set_standard_conforming_strings ⇒ Object
Enable standard-conforming strings if available.
- #supports_ddl_transactions? ⇒ Boolean
- #supports_explain? ⇒ Boolean
- #supports_extensions? ⇒ Boolean
- #supports_foreign_keys? ⇒ Boolean
- #supports_import? ⇒ Boolean
- #supports_index_sort_order? ⇒ Boolean
- #supports_materialized_views? ⇒ Boolean
-
#supports_migrations? ⇒ Boolean
Returns true, since this connection adapter supports migrations.
- #supports_partial_index? ⇒ Boolean
-
#supports_primary_key? ⇒ Boolean
Does PostgreSQL support finding primary key on non-Active Record tables?.
- #supports_ranges? ⇒ Boolean
-
#supports_statement_cache? ⇒ Boolean
Returns
true
, since this connection adapter supports prepared statement caching. - #supports_transaction_isolation? ⇒ Boolean
- #supports_views? ⇒ Boolean
-
#table_alias_length ⇒ Object
Returns the configured supported identifier length supported by PostgreSQL.
- #truncate(table_name, name = nil) ⇒ Object
-
#update_table_definition(table_name, base) ⇒ Object
:nodoc:.
- #use_insert_returning? ⇒ Boolean
- #valid_type?(type) ⇒ Boolean
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, #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.
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 195 def initialize(connection, logger, connection_parameters, config) super(connection, logger) @visitor = Arel::Visitors::PostgreSQL.new self @prepared_statements = false @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?
227 228 229 230 231 232 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 227 def active? @connection.query 'SELECT 1' true rescue PGError false end |
#clear_cache! ⇒ Object
Clears the prepared statements cache.
218 219 220 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 218 def clear_cache! @statements.clear end |
#column_name_for_operation(operation, node) ⇒ Object
:nodoc:
342 343 344 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 342 def column_name_for_operation(operation, node) # :nodoc: OPERATION_ALIASES.fetch(operation) { operation.downcase } end |
#disable_extension(name) ⇒ Object
307 308 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 307 def disable_extension(name) end |
#disconnect! ⇒ Object
Disconnects from the database if already connected. Otherwise, this method does nothing.
253 254 255 256 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 253 def disconnect! super @connection.close rescue nil end |
#enable_extension(name) ⇒ Object
304 305 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 304 def enable_extension(name) end |
#extension_enabled?(name) ⇒ Boolean
310 311 312 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 310 def extension_enabled?(name) false end |
#index_algorithms ⇒ Object
137 138 139 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 137 def index_algorithms { concurrently: 'CONCURRENTLY' } end |
#lookup_cast_type(sql_type) ⇒ Object
:nodoc:
337 338 339 340 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 337 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:
258 259 260 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 258 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
105 106 107 108 109 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 105 def (column, types) # :nodoc: spec = super spec[:default] = "\"#{column.default_function}\"" if column.default_function spec end |
#reconnect! ⇒ Object
Close then reopen the connection.
235 236 237 238 239 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 235 def reconnect! super @connection.reset configure_connection end |
#reset! ⇒ Object
241 242 243 244 245 246 247 248 249 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 241 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:
99 100 101 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 99 def schema_creation # :nodoc: Redshift::SchemaCreation.new self end |
#session_auth=(user) ⇒ Object
Set the authorized user for this session
320 321 322 323 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 320 def session_auth=(user) clear_cache! exec_query "SET SESSION AUTHORIZATION #{user}" end |
#set_standard_conforming_strings ⇒ Object
Enable standard-conforming strings if available.
273 274 275 276 277 278 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 273 def set_standard_conforming_strings old, self. = , 'panic' execute('SET standard_conforming_strings = on', 'SCHEMA') rescue nil ensure self. = old end |
#supports_ddl_transactions? ⇒ Boolean
280 281 282 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 280 def supports_ddl_transactions? true end |
#supports_explain? ⇒ Boolean
284 285 286 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 284 def supports_explain? true end |
#supports_extensions? ⇒ Boolean
288 289 290 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 288 def supports_extensions? false end |
#supports_foreign_keys? ⇒ Boolean
129 130 131 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 129 def supports_foreign_keys? true end |
#supports_import? ⇒ Boolean
300 301 302 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 300 def supports_import? true end |
#supports_index_sort_order? ⇒ Boolean
117 118 119 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 117 def supports_index_sort_order? false end |
#supports_materialized_views? ⇒ Boolean
296 297 298 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 296 def supports_materialized_views? false end |
#supports_migrations? ⇒ Boolean
Returns true, since this connection adapter supports migrations.
263 264 265 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 263 def supports_migrations? true end |
#supports_partial_index? ⇒ Boolean
121 122 123 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 121 def supports_partial_index? false end |
#supports_primary_key? ⇒ Boolean
Does PostgreSQL support finding primary key on non-Active Record tables?
268 269 270 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 268 def supports_primary_key? #:nodoc: true end |
#supports_ranges? ⇒ Boolean
292 293 294 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 292 def supports_ranges? false end |
#supports_statement_cache? ⇒ Boolean
Returns true
, since this connection adapter supports prepared statement caching.
113 114 115 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 113 def supports_statement_cache? true end |
#supports_transaction_isolation? ⇒ Boolean
125 126 127 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 125 def supports_transaction_isolation? false end |
#supports_views? ⇒ Boolean
133 134 135 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 133 def supports_views? true end |
#table_alias_length ⇒ Object
Returns the configured supported identifier length supported by PostgreSQL
315 316 317 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 315 def table_alias_length @table_alias_length ||= query('SHOW max_identifier_length', 'SCHEMA')[0][0].to_i end |
#truncate(table_name, name = nil) ⇒ Object
222 223 224 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 222 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:
333 334 335 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 333 def update_table_definition(table_name, base) #:nodoc: Redshift::Table.new(table_name, base) end |
#use_insert_returning? ⇒ Boolean
325 326 327 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 325 def use_insert_returning? false end |
#valid_type?(type) ⇒ Boolean
329 330 331 |
# File 'lib/active_record/connection_adapters/redshift_adapter.rb', line 329 def valid_type?(type) !native_database_types[type].nil? end |