class Sequel::Postgres::Database
Constants
- DATABASE_ERROR_CLASSES
:nocov:
Public Instance Methods
Convert given argument so that it can be used directly by pg. Currently, pg doesn't handle fractional seconds in Time/DateTime or blobs with “0”. Only public for use by the adapter, shouldn't be used by external code.
# File lib/sequel/adapters/postgres.rb, line 183 def bound_variable_arg(arg, conn) case arg when Sequel::SQL::Blob {:value=>arg, :type=>17, :format=>1} # :nocov: # Not covered by tests as tests use pg_extended_date_support # extension, which has basically the same code. when Time, DateTime @default_dataset.literal_date_or_time(arg) # :nocov: else arg end end
Call a procedure with the given name and arguments. Returns a hash if the procedure returns a value, and nil otherwise. Example:
DB.call_procedure(:foo, 1, 2) # CALL foo(1, 2)
# File lib/sequel/adapters/postgres.rb, line 203 def call_procedure(name, *args) dataset.send(:call_procedure, name, args) end
Connects to the database. In addition to the standard database options, using the :encoding or :charset option changes the client encoding for the connection, :connect_timeout is a connection timeout in seconds, :sslmode sets whether postgres's sslmode, and :notice_receiver handles server notices in a proc. :connect_timeout, :driver_options, :sslmode, and :notice_receiver are only supported if the pg driver is used.
# File lib/sequel/adapters/postgres.rb, line 214 def connect(server) opts = server_opts(server) if USES_PG connection_params = { :host => opts[:host], :port => opts[:port], :dbname => opts[:database], :user => opts[:user], :password => opts[:password], :connect_timeout => opts[:connect_timeout] || 20, :sslmode => opts[:sslmode], :sslrootcert => opts[:sslrootcert] }.delete_if { |key, value| blank_object?(value) } # :nocov: connection_params.merge!(opts[:driver_options]) if opts[:driver_options] # :nocov: conn = Adapter.connect(opts[:conn_str] || connection_params) conn.instance_variable_set(:@prepared_statements, {}) if receiver = opts[:notice_receiver] conn.set_notice_receiver(&receiver) end # :nocov: if conn.respond_to?(:type_map_for_queries=) && defined?(PG_QUERY_TYPE_MAP) # :nocov: conn.type_map_for_queries = PG_QUERY_TYPE_MAP end # :nocov: else unless typecast_value_boolean(@opts.fetch(:force_standard_strings, true)) raise Error, "Cannot create connection using postgres-pr unless force_standard_strings is set" end conn = Adapter.connect( (opts[:host] unless blank_object?(opts[:host])), opts[:port] || 5432, nil, '', opts[:database], opts[:user], opts[:password] ) end # :nocov: conn.instance_variable_set(:@db, self) # :nocov: if encoding = opts[:encoding] || opts[:charset] if conn.respond_to?(:set_client_encoding) conn.set_client_encoding(encoding) else conn.async_exec("set client_encoding to '#{encoding}'") end end # :nocov: connection_configuration_sqls(opts).each{|sql| conn.execute(sql)} conn end
Always false, support was moved to pg_extended_date_support extension. Needs to stay defined here so that sequel_pg works.
# File lib/sequel/adapters/postgres.rb, line 278 def convert_infinite_timestamps false end
Enable pg_extended_date_support extension if symbol or string is given.
# File lib/sequel/adapters/postgres.rb, line 283 def convert_infinite_timestamps=(v) case v when Symbol, String, true extension(:pg_extended_date_support) self.convert_infinite_timestamps = v end end
copy_into
uses PostgreSQL's +COPY FROM STDIN+ SQL statement to do very fast inserts into a table
using input preformatting in either CSV or PostgreSQL text format. This
method is only supported if pg 0.14.0+ is the underlying ruby driver. This
method should only be called if you want results returned to the client.
If you are using +COPY FROM+ with a filename, you should just use
run
instead of this method.
The following options are respected:
- :columns
-
The columns to insert into, with the same order as the columns in the input data. If this isn't given, uses all columns in the table.
- :data
-
The data to copy to PostgreSQL, which should already be in CSV or PostgreSQL text format. This can be either a string, or any object that responds to each and yields string.
- :format
-
The format to use. text is the default, so this should be :csv or :binary.
- :options
-
An options SQL string to use, which should contain comma separated options.
- :server
-
The server on which to run the query.
If a block is provided and :data option is not, this will yield to the block repeatedly. The block should return a string, or nil to signal that it is finished.
# File lib/sequel/adapters/postgres.rb, line 430 def copy_into(table, opts=OPTS) data = opts[:data] data = Array(data) if data.is_a?(String) if defined?(yield) && data raise Error, "Cannot provide both a :data option and a block to copy_into" elsif !defined?(yield) && !data raise Error, "Must provide either a :data option or a block to copy_into" end synchronize(opts[:server]) do |conn| conn.execute(copy_into_sql(table, opts)) begin if defined?(yield) while buf = yield conn.put_copy_data(buf) end else data.each{|buff| conn.put_copy_data(buff)} end rescue Exception => e conn.put_copy_end("ruby exception occurred while copying data into PostgreSQL") ensure conn.put_copy_end unless e while res = conn.get_result raise e if e check_database_errors{res.check} end end end end
:nocov: copy_table
uses PostgreSQL's +COPY TO STDOUT+ SQL statement to return formatted results directly
to the caller. This method is only supported if pg is the underlying ruby
driver. This method should only be called if you want results returned to
the client. If you are using +COPY TO+ with a filename, you should just
use run
instead of this method.
The table argument supports the following types:
- String
-
Uses the first argument directly as literal SQL. If you are using a version of PostgreSQL before 9.0, you will probably want to use a string if you are using any options at all, as the syntax Sequel uses for options is only compatible with PostgreSQL 9.0+. This should be the full COPY statement passed to PostgreSQL, not just the SELECT query. If a string is given, the :format and :options options are ignored.
- Dataset
-
Uses a query instead of a table name when copying.
- other
-
Uses a table name (usually a symbol) when copying.
The following options are respected:
- :format
-
The format to use. text is the default, so this should be :csv or :binary.
- :options
-
An options SQL string to use, which should contain comma separated options.
- :server
-
The server on which to run the query.
If a block is provided, the method continually yields to the block, one yield per row. If a block is not provided, a single string is returned with all of the data.
# File lib/sequel/adapters/postgres.rb, line 380 def copy_table(table, opts=OPTS) synchronize(opts[:server]) do |conn| conn.execute(copy_table_sql(table, opts)) begin if defined?(yield) while buf = conn.get_copy_data yield buf end b = nil else b = String.new b << buf while buf = conn.get_copy_data end res = conn.get_last_result if !res || res.result_status != 1 raise PG::NotAllCopyDataRetrieved, "Not all COPY data retrieved" end b rescue => e raise_error(e, :disconnect=>true) ensure if buf && !e raise DatabaseDisconnectError, "disconnecting as a partial COPY may leave the connection in an unusable state" end end end end
# File lib/sequel/adapters/postgres.rb, line 291 def disconnect_connection(conn) conn.finish rescue PGError, IOError nil end
:nocov: Return a hash of information about the related PGError (or Sequel::DatabaseError that wraps a
PGError), with the following entries (any of which may be
nil
):
- :schema
-
The schema name related to the error
- :table
-
The table name related to the error
- :column
-
the column name related to the error
- :constraint
-
The constraint name related to the error
- :type
-
The datatype name related to the error
- :severity
-
The severity of the error (e.g. “ERROR”)
- :sql_state
-
The SQL state code related to the error
- :message_primary
-
A single line message related to the error
- :message_detail
-
Any detail supplementing the primary message
- :message_hint
-
Possible suggestion about how to fix the problem
- :statement_position
-
Character offset in statement submitted by client where error occurred (starting at 1)
- :internal_position
-
Character offset in internal statement where error occurred (starting at 1)
- :internal_query
-
Text of internally-generated statement where error occurred
- :source_file
-
PostgreSQL source file where the error occurred
- :source_line
-
Line number of PostgreSQL source file where the error occurred
- :source_function
-
Function in PostgreSQL source file where the error occurred
This requires a PostgreSQL 9.3+ server and 9.3+ client library, and ruby-pg 0.16.0+ to be supported.
# File lib/sequel/adapters/postgres.rb, line 322 def error_info(e) e = e.wrapped_exception if e.is_a?(DatabaseError) r = e.result { :schema => r.error_field(::PG::PG_DIAG_SCHEMA_NAME), :table => r.error_field(::PG::PG_DIAG_TABLE_NAME), :column => r.error_field(::PG::PG_DIAG_COLUMN_NAME), :constraint => r.error_field(::PG::PG_DIAG_CONSTRAINT_NAME), :type => r.error_field(::PG::PG_DIAG_DATATYPE_NAME), :severity => r.error_field(::PG::PG_DIAG_SEVERITY), :sql_state => r.error_field(::PG::PG_DIAG_SQLSTATE), :message_primary => r.error_field(::PG::PG_DIAG_MESSAGE_PRIMARY), :message_detail => r.error_field(::PG::PG_DIAG_MESSAGE_DETAIL), :message_hint => r.error_field(::PG::PG_DIAG_MESSAGE_HINT), :statement_position => r.error_field(::PG::PG_DIAG_STATEMENT_POSITION), :internal_position => r.error_field(::PG::PG_DIAG_INTERNAL_POSITION), :internal_query => r.error_field(::PG::PG_DIAG_INTERNAL_QUERY), :source_file => r.error_field(::PG::PG_DIAG_SOURCE_FILE), :source_line => r.error_field(::PG::PG_DIAG_SOURCE_LINE), :source_function => r.error_field(::PG::PG_DIAG_SOURCE_FUNCTION) } end
# File lib/sequel/adapters/postgres.rb, line 346 def execute(sql, opts=OPTS, &block) synchronize(opts[:server]){|conn| check_database_errors{_execute(conn, sql, opts, &block)}} end
Listens on the given channel (or multiple channels if channel is an array), waiting for notifications. After a notification is received, or the timeout has passed, stops listening to the channel. Options:
- :after_listen
-
An object that responds to
call
that is called with the underlying connection after the LISTEN statement is sent, but before the connection starts waiting for notifications. - :loop
-
Whether to continually wait for notifications, instead of just waiting for a single notification. If this option is given, a block must be provided. If this object responds to
call
, it is called with the underlying connection after each notification is received (after the block is called). If a :timeout option is used, and a callable object is given, the object will also be called if the timeout expires. If :loop is used and you want to stop listening, you can either break from inside the block given to listen, or you can throw :stop from inside the :loop object's call method or the block. - :server
-
The server on which to listen, if the sharding support is being used.
- :timeout
-
How long to wait for a notification, in seconds (can provide a float value for fractional seconds). If this object responds to
call
, it will be called and should return the number of seconds to wait. If the loop option is also specified, the object will be called on each iteration to obtain a new timeout value. If not given or nil, waits indefinitely.
This method is only supported if pg is used as the underlying ruby driver. It returns the channel the notification was sent to (as a string), unless :loop was used, in which case it returns nil. If a block is given, it is yielded 3 arguments:
-
the channel the notification was sent to (as a string)
-
the backend pid of the notifier (as an integer),
-
and the payload of the notification (as a string or nil).
# File lib/sequel/adapters/postgres.rb, line 485 def listen(channels, opts=OPTS, &block) check_database_errors do synchronize(opts[:server]) do |conn| begin channels = Array(channels) channels.each do |channel| sql = "LISTEN ".dup dataset.send(:identifier_append, sql, channel) conn.execute(sql) end opts[:after_listen].call(conn) if opts[:after_listen] timeout = opts[:timeout] if timeout timeout_block = timeout.respond_to?(:call) ? timeout : proc{timeout} end if l = opts[:loop] raise Error, 'calling #listen with :loop requires a block' unless block loop_call = l.respond_to?(:call) catch(:stop) do while true t = timeout_block ? [timeout_block.call] : [] conn.wait_for_notify(*t, &block) l.call(conn) if loop_call end end nil else t = timeout_block ? [timeout_block.call] : [] conn.wait_for_notify(*t, &block) end ensure conn.execute("UNLISTEN *") end end end end
Private Instance Methods
Execute the given SQL string or prepared statement on the connection object.
# File lib/sequel/adapters/postgres.rb, line 527 def _execute(conn, sql, opts, &block) if sql.is_a?(Symbol) execute_prepared_statement(conn, sql, opts, &block) else conn.execute(sql, opts[:arguments], &block) end end
Execute the prepared statement name with the given arguments on the connection.
# File lib/sequel/adapters/postgres.rb, line 536 def _execute_prepared_statement(conn, ps_name, args, opts) conn.exec_prepared(ps_name, args) end
Add the primary_keys and primary_key_sequences instance variables, so we can get the correct return values for inserted rows.
# File lib/sequel/adapters/postgres.rb, line 542 def adapter_initialize @use_iso_date_format = typecast_value_boolean(@opts.fetch(:use_iso_date_format, true)) initialize_postgres_adapter # :nocov: add_conversion_proc(17, method(:unescape_bytea)) if USES_PG add_conversion_proc(1082, TYPE_TRANSLATOR_DATE) if @use_iso_date_format # :nocov: self.convert_infinite_timestamps = @opts[:convert_infinite_timestamps] end
Convert exceptions raised from the block into DatabaseErrors.
# File lib/sequel/adapters/postgres.rb, line 553 def check_database_errors yield rescue => e raise_error(e, :classes=>database_error_classes) end
Set the DateStyle to ISO if configured, for faster date parsing.
# File lib/sequel/adapters/postgres.rb, line 559 def connection_configuration_sqls(opts=@opts) sqls = super # :nocov: sqls << "SET DateStyle = 'ISO'" if @use_iso_date_format # :nocov: sqls end
# File lib/sequel/adapters/postgres.rb, line 576 def database_error_classes DATABASE_ERROR_CLASSES end
# File lib/sequel/adapters/postgres.rb, line 586 def database_exception_sqlstate(exception, opts) # :nocov: if exception.respond_to?(:result) && (result = exception.result) # :nocov: result.error_field(PGresult::PG_DIAG_SQLSTATE) end end
# File lib/sequel/adapters/postgres.rb, line 594 def dataset_class_default Dataset end
# File lib/sequel/adapters/postgres.rb, line 580 def disconnect_error?(exception, opts) super || Adapter::DISCONNECT_ERROR_CLASSES.any?{|klass| exception.is_a?(klass)} || exception.message =~ Adapter::DISCONNECT_ERROR_RE end
Execute the prepared statement with the given name on an available connection, using the given args. If the connection has not prepared a statement with the given name yet, prepare it. If the connection has prepared a statement with the same name and different SQL, deallocate that statement first and then prepare this statement. If a block is given, yield the result, otherwise, return the number of rows changed.
# File lib/sequel/adapters/postgres.rb, line 605 def execute_prepared_statement(conn, name, opts=OPTS, &block) ps = prepared_statement(name) sql = ps.prepared_sql ps_name = name.to_s if args = opts[:arguments] args = args.map{|arg| bound_variable_arg(arg, conn)} end unless conn.prepared_statements[ps_name] == sql conn.execute("DEALLOCATE #{ps_name}") if conn.prepared_statements.include?(ps_name) conn.check_disconnect_errors{log_connection_yield("PREPARE #{ps_name} AS #{sql}", conn){conn.prepare(ps_name, sql)}} conn.prepared_statements[ps_name] = sql end log_sql = "EXECUTE #{ps_name}" if ps.log_sql log_sql += " (" log_sql << sql log_sql << ")" end q = conn.check_disconnect_errors{log_connection_yield(log_sql, conn, args){_execute_prepared_statement(conn, ps_name, args, opts)}} begin defined?(yield) ? yield(q) : q.cmd_tuples ensure q.clear if q && q.respond_to?(:clear) end end
Don't log, since logging is done by the underlying connection.
# File lib/sequel/adapters/postgres.rb, line 636 def log_connection_execute(conn, sql) conn.execute(sql) end
# File lib/sequel/adapters/postgres.rb, line 640 def rollback_transaction(conn, opts=OPTS) super unless conn.transaction_status == 0 end
# File lib/sequel/adapters/postgres.rb, line 569 def unescape_bytea(s) ::Sequel::SQL::Blob.new(Adapter.unescape_bytea(s)) end