Class: PG::Connection

Inherits:
Object
  • Object
show all
Includes:
Constants
Defined in:
lib/pg/connection.rb,
ext/pg_connection.c

Overview

The PostgreSQL connection class. The interface for this class is based on libpq, the C application programmer’s interface to PostgreSQL. Some familiarity with libpq is recommended, but not necessary.

For example, to send query to the database on the localhost:

require 'pg'
conn = PG::Connection.open(:dbname => 'test')
res = conn.exec_params('SELECT $1 AS a, $2 AS b, $3 AS c', [1, 2, nil])
# Equivalent to:
#  res  = conn.exec('SELECT 1 AS a, 2 AS b, NULL AS c')

See the PG::Result class for information on working with the results of a query.

Constant Summary collapse

CONNECT_ARGUMENT_ORDER =

The order the options are passed to the ::connect method.

%w[host port options tty dbname user password]

Constants included from Constants

PG::Constants::CONNECTION_AUTH_OK, PG::Constants::CONNECTION_AWAITING_RESPONSE, PG::Constants::CONNECTION_BAD, PG::Constants::CONNECTION_MADE, PG::Constants::CONNECTION_NEEDED, PG::Constants::CONNECTION_OK, PG::Constants::CONNECTION_SETENV, PG::Constants::CONNECTION_SSL_STARTUP, PG::Constants::CONNECTION_STARTED, PG::Constants::INVALID_OID, PG::Constants::INV_READ, PG::Constants::INV_WRITE, PG::Constants::InvalidOid, PG::Constants::PGRES_BAD_RESPONSE, PG::Constants::PGRES_COMMAND_OK, PG::Constants::PGRES_COPY_BOTH, PG::Constants::PGRES_COPY_IN, PG::Constants::PGRES_COPY_OUT, PG::Constants::PGRES_EMPTY_QUERY, PG::Constants::PGRES_FATAL_ERROR, PG::Constants::PGRES_NONFATAL_ERROR, PG::Constants::PGRES_POLLING_FAILED, PG::Constants::PGRES_POLLING_OK, PG::Constants::PGRES_POLLING_READING, PG::Constants::PGRES_POLLING_WRITING, PG::Constants::PGRES_SINGLE_TUPLE, PG::Constants::PGRES_TUPLES_OK, PG::Constants::PG_DIAG_COLUMN_NAME, PG::Constants::PG_DIAG_CONSTRAINT_NAME, PG::Constants::PG_DIAG_CONTEXT, PG::Constants::PG_DIAG_DATATYPE_NAME, PG::Constants::PG_DIAG_INTERNAL_POSITION, PG::Constants::PG_DIAG_INTERNAL_QUERY, PG::Constants::PG_DIAG_MESSAGE_DETAIL, PG::Constants::PG_DIAG_MESSAGE_HINT, PG::Constants::PG_DIAG_MESSAGE_PRIMARY, PG::Constants::PG_DIAG_SCHEMA_NAME, PG::Constants::PG_DIAG_SEVERITY, PG::Constants::PG_DIAG_SOURCE_FILE, PG::Constants::PG_DIAG_SOURCE_FUNCTION, PG::Constants::PG_DIAG_SOURCE_LINE, PG::Constants::PG_DIAG_SQLSTATE, PG::Constants::PG_DIAG_STATEMENT_POSITION, PG::Constants::PG_DIAG_TABLE_NAME, PG::Constants::PQERRORS_DEFAULT, PG::Constants::PQERRORS_TERSE, PG::Constants::PQERRORS_VERBOSE, PG::Constants::PQPING_NO_ATTEMPT, PG::Constants::PQPING_NO_RESPONSE, PG::Constants::PQPING_OK, PG::Constants::PQPING_REJECT, PG::Constants::PQTRANS_ACTIVE, PG::Constants::PQTRANS_IDLE, PG::Constants::PQTRANS_INERROR, PG::Constants::PQTRANS_INTRANS, PG::Constants::PQTRANS_UNKNOWN, PG::Constants::SEEK_CUR, PG::Constants::SEEK_END, PG::Constants::SEEK_SET

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Object

call-seq:

PG::Connection.new -> conn
PG::Connection.new(connection_hash) -> conn
PG::Connection.new(connection_string) -> conn
PG::Connection.new(host, port, options, tty, dbname, user, password) ->  conn

Create a connection to the specified server.

host

server hostname

hostaddr

server address (avoids hostname lookup, overrides host)

port

server port number

dbname

connecting database name

user

login user name

password

login password

connect_timeout

maximum time to wait for connection to succeed

options

backend options

tty

(ignored in newer versions of PostgreSQL)

sslmode

(disable|allow|prefer|require)

krbsrvname

kerberos service name

gsslib

GSS library to use for GSSAPI authentication

service

service name to use for additional parameters

Examples:

# Connect using all defaults
PG::Connection.new

# As a Hash
PG::Connection.new( :dbname => 'test', :port => 5432 )

# As a String
PG::Connection.new( "dbname=test port=5432" )

# As an Array
PG::Connection.new( nil, 5432, nil, nil, 'test', nil, nil )

If the Ruby default internal encoding is set (i.e., Encoding.default_internal != nil), the connection will have its client_encoding set accordingly.

Raises a PG::Error if the connection fails.



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'ext/pg_connection.c', line 274

static VALUE
pgconn_init(int argc, VALUE *argv, VALUE self)
{
  t_pg_connection *this;
  VALUE conninfo;
  VALUE error;

  this = pg_get_connection( self );
  conninfo = rb_funcall2( rb_cPGconn, rb_intern("parse_connect_args"), argc, argv );
  this->pgconn = gvl_PQconnectdb(StringValueCStr(conninfo));

  if(this->pgconn == NULL)
    rb_raise(rb_ePGerror, "PQconnectdb() unable to allocate structure");

  if (PQstatus(this->pgconn) == CONNECTION_BAD) {
    error = rb_exc_new2(rb_eConnectionBad, PQerrorMessage(this->pgconn));
    rb_iv_set(error, "@connection", self);
    rb_exc_raise(error);
  }

#ifdef M17N_SUPPORTED
  pgconn_set_default_encoding( self );
#endif

  if (rb_block_given_p()) {
    return rb_ensure(rb_yield, self, pgconn_finish, self);
  }
  return self;
}

Class Method Details

.conndefaults ⇒ Object

call-seq:

PG::Connection.conndefaults() -> Array

Returns an array of hashes. Each hash has the keys:

:keyword

the name of the option

:envvar

the environment variable to fall back to

:compiled

the compiled in option as a secondary fallback

:val

the option’s current value, or nil if not known

:label

the label for the field

:dispchar

“” for normal, “D” for debug, and “*” for password

:dispsize

field size



407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'ext/pg_connection.c', line 407

static VALUE
pgconn_s_conndefaults(VALUE self)
{
  PQconninfoOption *options = PQconndefaults();
  VALUE array = pgconn_make_conninfo_array( options );

  PQconninfoFree(options);

  UNUSED( self );

  return array;
}

.conndefaults_hash ⇒ Object

Return the Postgres connection defaults structure as a Hash keyed by option keyword (as a Symbol).

See also #conndefaults



222
223
224
225
226
 
# File 'lib/pg/connection.rb', line 222

def self.conndefaults_hash
  return self.conndefaults.each_with_object({}) do |info, hash|
    hash[ info[:keyword].to_sym ] = info[:val]
  end
end

.PG::Connection.connect_start(connection_hash) ⇒ Object .PG::Connection.connect_start(connection_string) ⇒ Object .PG::Connection.connect_start(host, port, options, tty, dbname, login, password) ⇒ Object

This is an asynchronous version of PG::Connection.connect().

Use #connect_poll to poll the status of the connection.

NOTE: this does not set the connection’s client_encoding for you if Encoding.default_internal is set. To set it after the connection is established, call #internal_encoding=. You can also set it automatically by setting ENV, or include the ‘options’ connection parameter.



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'ext/pg_connection.c', line 320

static VALUE
pgconn_s_connect_start( int argc, VALUE *argv, VALUE klass )
{
  VALUE rb_conn;
  VALUE conninfo;
  VALUE error;
  t_pg_connection *this;

  /*
   * PG::Connection.connect_start must act as both alloc() and initialize()
   * because it is not invoked by calling new().
   */
  rb_conn  = pgconn_s_allocate( klass );
  this = pg_get_connection( rb_conn );
  conninfo = rb_funcall2( klass, rb_intern("parse_connect_args"), argc, argv );
  this->pgconn = gvl_PQconnectStart( StringValueCStr(conninfo) );

  if( this->pgconn == NULL )
    rb_raise(rb_ePGerror, "PQconnectStart() unable to allocate structure");

  if ( PQstatus(this->pgconn) == CONNECTION_BAD ) {
    error = rb_exc_new2(rb_eConnectionBad, PQerrorMessage(this->pgconn));
    rb_iv_set(error, "@connection", rb_conn);
    rb_exc_raise(error);
  }

  if ( rb_block_given_p() ) {
    return rb_ensure( rb_yield, rb_conn, pgconn_finish, rb_conn );
  }
  return rb_conn;
}

.PG::Connection.encrypt_password(password, username) ⇒ String

This function is intended to be used by client applications that send commands like: ALTER USER joe PASSWORD ‘pwd’. The arguments are the cleartext password, and the SQL name of the user it is for.

Return value is the encrypted password.

Returns:

  • (String) 


432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'ext/pg_connection.c', line 432

static VALUE
pgconn_s_encrypt_password(VALUE self, VALUE password, VALUE username)
{
  char *encrypted = NULL;
  VALUE rval = Qnil;

  UNUSED( self );

  Check_Type(password, T_STRING);
  Check_Type(username, T_STRING);

  encrypted = PQencryptPassword(StringValueCStr(password), StringValueCStr(username));
  rval = rb_str_new2( encrypted );
  PQfreemem( encrypted );

  OBJ_INFECT( rval, password );
  OBJ_INFECT( rval, username );

  return rval;
}

.escape_bytea(string) ⇒ String

Escapes binary data for use within an SQL command with the type bytea.

Certain byte values must be escaped (but all byte values may be escaped) when used as part of a bytea literal in an SQL statement. In general, to escape a byte, it is converted into the three digit octal number equal to the octet value, and preceded by two backslashes. The single quote (‘) and backslash () characters have special alternative escape sequences. #escape_bytea performs this operation, escaping only the minimally required bytes.

Consider using exec_params, which avoids the need for passing values inside of SQL commands.

NOTE: This class version of this method can only be used safely in client programs that use a single PostgreSQL connection at a time (in this case it can find out what it needs to know “behind the scenes”). It might give the wrong results if used in programs that use multiple database connections; use the same method on the connection object in such cases.

Returns:

  • (String) 


1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
 
# File 'ext/pg_connection.c', line 1596

static VALUE
pgconn_s_escape_bytea(VALUE self, VALUE str)
{
  unsigned char *from, *to;
  size_t from_len, to_len;
  VALUE ret;

  Check_Type(str, T_STRING);
  from      = (unsigned char*)RSTRING_PTR(str);
  from_len  = RSTRING_LEN(str);

  if ( rb_obj_is_kind_of(self, rb_cPGconn) ) {
    to = PQescapeByteaConn(pg_get_pgconn(self), from, from_len, &to_len);
  } else {
    to = PQescapeBytea( from, from_len, &to_len);
  }

  ret = rb_str_new((char*)to, to_len - 1);
  OBJ_INFECT(ret, str);
  PQfreemem(to);
  return ret;
}

.escape_string(str) ⇒ String

Returns a SQL-safe version of the String str. This is the preferred way to make strings safe for inclusion in SQL queries.

Consider using exec_params, which avoids the need for passing values inside of SQL commands.

Encoding of escaped string will be equal to client encoding of connection.

NOTE: This class version of this method can only be used safely in client programs that use a single PostgreSQL connection at a time (in this case it can find out what it needs to know “behind the scenes”). It might give the wrong results if used in programs that use multiple database connections; use the same method on the connection object in such cases.

Returns:

  • (String) 


1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
 
# File 'ext/pg_connection.c', line 1541

static VALUE
pgconn_s_escape(VALUE self, VALUE string)
{
  size_t size;
  int error;
  VALUE result;
  int enc_idx;
  int singleton = !rb_obj_is_kind_of(self, rb_cPGconn);

  Check_Type(string, T_STRING);
  enc_idx = ENCODING_GET( singleton ? string : self );
  if( ENCODING_GET(string) != enc_idx ){
    string = rb_str_export_to_enc(string, rb_enc_from_index(enc_idx));
  }

  result = rb_str_new(NULL, RSTRING_LEN(string) * 2 + 1);
  PG_ENCODING_SET_NOCHECK(result, enc_idx);
  if( !singleton ) {
    size = PQescapeStringConn(pg_get_pgconn(self), RSTRING_PTR(result),
      RSTRING_PTR(string), RSTRING_LEN(string), &error);
    if(error) {
      rb_raise(rb_ePGerror, "%s", PQerrorMessage(pg_get_pgconn(self)));
    }
  } else {
    size = PQescapeString(RSTRING_PTR(result), RSTRING_PTR(string), RSTRING_LEN(string));
  }
  rb_str_set_len(result, size);
  OBJ_INFECT(result, string);

  return result;
}

.parse_connect_args(*args) ⇒ Object

Parse the connection args into a connection-parameter string. See PG::Connection.new for valid arguments.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/pg/connection.rb', line 35

def self::parse_connect_args( *args )
  return '' if args.empty?

  hash_arg = args.last.is_a?( Hash ) ? args.pop : {}
  option_string = ''
  options = {}

  # Parameter 'fallback_application_name' was introduced in PostgreSQL 9.0
  # together with PQescapeLiteral().
  if PG::Connection.instance_methods.find {|m| m.to_sym == :escape_literal }
    options[:fallback_application_name] = $0.sub( /^(.{30}).{4,}(.{30})$/ ){ $1+"..."+$2 }
  end

  if args.length == 1
    case args.first
    when URI, URI.regexp
      uri = URI(args.first)
      options.merge!( Hash[URI.decode_www_form( uri.query )] ) if uri.query
    when /=/
      # Option string style
      option_string = args.first.to_s
    else
      # Positional parameters
      options[CONNECT_ARGUMENT_ORDER.first.to_sym] = args.first
    end
  else
    max = CONNECT_ARGUMENT_ORDER.length
    raise ArgumentError,
      "Extra positional parameter %d: %p" % [ max + 1, args[max] ] if args.length > max

    CONNECT_ARGUMENT_ORDER.zip( args ) do |(k,v)|
      options[ k.to_sym ] = v if v
    end
  end

  options.merge!( hash_arg )

  if uri
    uri.host     = nil if options[:host]
    uri.port     = nil if options[:port]
    uri.user     = nil if options[:user]
    uri.password = nil if options[:password]
    uri.path     = '' if options[:dbname]
    uri.query    = URI.encode_www_form( options )
    return uri.to_s.sub( /^#{uri.scheme}:(?!\/\/)/, "#{uri.scheme}://" )
  else
    option_string += ' ' unless option_string.empty? && options.empty?
    return option_string + options.map { |k,v| "#{k}=#{quote_connstr(v)}" }.join( ' ' )
  end
end

.PG::Connection.ping(connection_hash) ⇒ Integer .PG::Connection.ping(connection_string) ⇒ Integer .PG::Connection.ping(host, port, options, tty, dbname, login, password) ⇒ Integer

Check server status.

Returns one of:

PQPING_OK

server is accepting connections

PQPING_REJECT

server is alive but rejecting connections

PQPING_NO_RESPONSE

could not establish connection

PQPING_NO_ATTEMPT

connection not attempted (bad params)

Overloads:

  • .PG::Connection.ping(connection_hash) ⇒ Integer

    Returns:

    • (Integer)
  • .PG::Connection.ping(connection_string) ⇒ Integer

    Returns:

    • (Integer)
  • .PG::Connection.ping(host, port, options, tty, dbname, login, password) ⇒ Integer

    Returns:

    • (Integer) 


371
372
373
374
375
376
377
378
379
380
381
 
# File 'ext/pg_connection.c', line 371

static VALUE
pgconn_s_ping( int argc, VALUE *argv, VALUE klass )
{
  PGPing ping;
  VALUE conninfo;

  conninfo = rb_funcall2( klass, rb_intern("parse_connect_args"), argc, argv );
  ping     = PQping( StringValueCStr(conninfo) );

  return INT2FIX((int)ping);
}

.quote_connstr(value) ⇒ Object

Quote the given value for use in a connection-parameter string.



28
29
30
 
# File 'lib/pg/connection.rb', line 28

def self::quote_connstr( value )
  return "'" + value.to_s.gsub( /[\\']/ ) {|m| '\\' + m } + "'"
end

.quote_ident(str) ⇒ String .quote_ident(array) ⇒ String .PG::Connection.quote_ident(str) ⇒ String .PG::Connection.quote_ident(array) ⇒ String

Returns a string that is safe for inclusion in a SQL query as an identifier. Note: this is not a quote function for values, but for identifiers.

For example, in a typical SQL query: SELECT FOO FROM MYTABLE The identifier FOO is folded to lower case, so it actually means foo. If you really want to access the case-sensitive field name FOO, use this function like conn.quote_ident('FOO'), which will return "FOO" (with double-quotes). PostgreSQL will see the double-quotes, and it will not fold to lower case.

Similarly, this function also protects against special characters, and other things that might allow SQL injection if the identifier comes from an untrusted source.

If the parameter is an Array, then all it’s values are separately quoted and then joined by a “.” character. This can be used for identifiers in the form “schema”.“table”.“column” .

This method is functional identical to the encoder PG::TextEncoder::Identifier .

If the instance method form is used and the input string character encoding is different to the connection encoding, then the string is converted to this encoding, so that the returned string is always encoded as PG::Connection#internal_encoding .

In the singleton form (PG::Connection.quote_ident) the character encoding of the result string is set to the character encoding of the input string.

Overloads:

  • .quote_ident(str) ⇒ String

    Returns:

    • (String)
  • .quote_ident(array) ⇒ String

    Returns:

    • (String)
  • .PG::Connection.quote_ident(str) ⇒ String

    Returns:

    • (String)
  • .PG::Connection.quote_ident(array) ⇒ String

    Returns:

    • (String) 


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
 
# File 'ext/pg_connection.c', line 3060

static VALUE
pgconn_s_quote_ident(VALUE self, VALUE str_or_array)
{
  VALUE ret;
  int enc_idx;

  if( rb_obj_is_kind_of(self, rb_cPGconn) ){
    enc_idx = ENCODING_GET( self );
  }else{
    enc_idx = RB_TYPE_P(str_or_array, T_STRING) ? ENCODING_GET( str_or_array ) : rb_ascii8bit_encindex();
  }
  pg_text_enc_identifier(NULL, str_or_array, NULL, &ret, enc_idx);

  OBJ_INFECT(ret, str_or_array);

  return ret;
}

.PG::Connection.unescape_bytea(string) ⇒ Object

Converts an escaped string representation of binary data into binary data — the reverse of #escape_bytea. This is needed when retrieving bytea data in text format, but not when retrieving it in binary format.



1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
 
# File 'ext/pg_connection.c', line 1629

static VALUE
pgconn_s_unescape_bytea(VALUE self, VALUE str)
{
  unsigned char *from, *to;
  size_t to_len;
  VALUE ret;

  UNUSED( self );

  Check_Type(str, T_STRING);
  from = (unsigned char*)StringValueCStr(str);

  to = PQunescapeBytea(from, &to_len);

  ret = rb_str_new((char*)to, to_len);
  OBJ_INFECT(ret, str);
  PQfreemem(to);
  return ret;
}

Instance Method Details

#async_exec(sql[, params, result_format ]) ⇒ PG::Result #async_exec(sql[, params, result_format ]) {|pg_result| ... } ⇒ Object Also known as: async_query

This function has the same behavior as #exec, but is implemented using the asynchronous command processing API of libpq.

Overloads:

  • #async_exec(sql[, params, result_format ]) ⇒ PG::Result

    Returns:

  • #async_exec(sql[, params, result_format ]) {|pg_result| ... } ⇒ Object

    Yields:

    • (pg_result) 


3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
 
# File 'ext/pg_connection.c', line 3180

static VALUE
pgconn_async_exec(int argc, VALUE *argv, VALUE self)
{
  VALUE rb_pgresult = Qnil;

  /* remove any remaining results from the queue */
  pgconn_block( 0, NULL, self ); /* wait for input (without blocking) before reading the last result */
  pgconn_get_last_result( self );

  pgconn_send_query( argc, argv, self );
  pgconn_block( 0, NULL, self );
  rb_pgresult = pgconn_get_last_result( self );

  if ( rb_block_given_p() ) {
    return rb_ensure( rb_yield, rb_pgresult, pg_result_clear, rb_pgresult );
  }
  return rb_pgresult;
}

#backend_pid ⇒ Integer

Returns the process ID of the backend server process for this connection. Note that this is a PID on database server host.

Returns:

  • (Integer) 


889
890
891
892
893
 
# File 'ext/pg_connection.c', line 889

static VALUE
pgconn_backend_pid(VALUE self)
{
  return INT2NUM(PQbackendPID(pg_get_pgconn(self)));
}

#block([ timeout ]) ⇒ Boolean

Blocks until the server is no longer busy, or until the optional timeout is reached, whichever comes first. timeout is measured in seconds and can be fractional.

Returns false if timeout is reached, true otherwise.

If true is returned, conn.is_busy will return false and conn.get_result will not block.

Returns:

  • (Boolean) 


3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
 
# File 'ext/pg_connection.c', line 3099

static VALUE
pgconn_block( int argc, VALUE *argv, VALUE self ) {
  PGconn *conn = pg_get_pgconn( self );

  /* If WIN32 and Ruby 1.9 do not use rb_thread_select() which sometimes hangs
   * and does not wait (nor sleep) any time even if timeout is given.
   * Instead use the Winsock events and rb_w32_wait_events(). */

  struct timeval timeout;
  struct timeval *ptimeout = NULL;
  VALUE timeout_in;
  double timeout_sec;
  void *ret;

  if ( rb_scan_args(argc, argv, "01", &timeout_in) == 1 ) {
    timeout_sec = NUM2DBL( timeout_in );
    timeout.tv_sec = (time_t)timeout_sec;
    timeout.tv_usec = (suseconds_t)((timeout_sec - (long)timeout_sec) * 1e6);
    ptimeout = &timeout;
  }

  ret = wait_socket_readable( conn, ptimeout, get_result_readable);

  if( !ret )
    return Qfalse;

  return Qtrue;
}

#cancel ⇒ String

Requests cancellation of the command currently being processed. (Only implemented in PostgreSQL >= 8.0)

Returns nil on success, or a string containing the error message if a failure occurs.

Returns:

  • (String) 


2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
 
# File 'ext/pg_connection.c', line 2203

static VALUE
pgconn_cancel(VALUE self)
{
#ifdef HAVE_PQGETCANCEL
  char errbuf[256];
  PGcancel *cancel;
  VALUE retval;
  int ret;

  cancel = PQgetCancel(pg_get_pgconn(self));
  if(cancel == NULL)
    rb_raise(rb_ePGerror,"Invalid connection!");

  ret = gvl_PQcancel(cancel, errbuf, 256);
  if(ret == 1)
    retval = Qnil;
  else
    retval = rb_str_new2(errbuf);

  PQfreeCancel(cancel);
  return retval;
#else
  rb_notimplement();
#endif
}

#conndefaults ⇒ Object

Returns an array of Hashes with connection defaults. See ::conndefaults for details.



214
215
216
 
# File 'lib/pg/connection.rb', line 214

def conndefaults
  return self.class.conndefaults
end

#conndefaults_hash ⇒ Object

Returns a Hash with connection defaults. See ::conndefaults_hash for details.



230
231
232
 
# File 'lib/pg/connection.rb', line 230

def conndefaults_hash
  return self.class.conndefaults_hash
end

#connect_poll ⇒ Integer

Returns one of:

PGRES_POLLING_READING

wait until the socket is ready to read

PGRES_POLLING_WRITING

wait until the socket is ready to write

PGRES_POLLING_FAILED

the asynchronous connection has failed

PGRES_POLLING_OK

the asynchronous connection is ready

Example:

conn = PG::Connection.connect_start("dbname=mydatabase")
socket = conn.socket_io
status = conn.connect_poll
while(status != PG::PGRES_POLLING_OK) do
  # do some work while waiting for the connection to complete
  if(status == PG::PGRES_POLLING_READING)
    if(not select([socket], [], [], 10.0))
      raise "Asynchronous connection timed out!"
    end
  elsif(status == PG::PGRES_POLLING_WRITING)
    if(not select([], [socket], [], 10.0))
      raise "Asynchronous connection timed out!"
    end
  end
  status = conn.connect_poll
end
# now conn.status == CONNECTION_OK, and connection
# is ready.

Returns:

  • (Integer) 


492
493
494
495
496
497
498
 
# File 'ext/pg_connection.c', line 492

static VALUE
pgconn_connect_poll(VALUE self)
{
  PostgresPollingStatusType status;
  status = gvl_PQconnectPoll(pg_get_pgconn(self));
  return INT2FIX((int)status);
}

#connection_needs_password ⇒ Boolean

Returns true if the authentication method required a password, but none was available. false otherwise.

Returns:

  • (Boolean) 


902
903
904
905
906
 
# File 'ext/pg_connection.c', line 902

static VALUE
pgconn_connection_needs_password(VALUE self)
{
  return PQconnectionNeedsPassword(pg_get_pgconn(self)) ? Qtrue : Qfalse;
}

#connection_used_password ⇒ Boolean

Returns true if the authentication method used a caller-supplied password, false otherwise.

Returns:

  • (Boolean) 


915
916
917
918
919
 
# File 'ext/pg_connection.c', line 915

static VALUE
pgconn_connection_used_password(VALUE self)
{
  return PQconnectionUsedPassword(pg_get_pgconn(self)) ? Qtrue : Qfalse;
}

#conninfo ⇒ Hash

Returns the connection options used by a live connection.

Returns:

  • (Hash) 


690
691
692
693
694
695
696
697
698
699
700
 
# File 'ext/pg_connection.c', line 690

static VALUE
pgconn_conninfo( VALUE self )
{
  PGconn *conn = pg_get_pgconn(self);
  PQconninfoOption *options = PQconninfo( conn );
  VALUE array = pgconn_make_conninfo_array( options );

  PQconninfoFree(options);

  return array;
}

#conninfo_hash ⇒ Object

Return the Postgres connection info structure as a Hash keyed by option keyword (as a Symbol).

See also #conninfo



241
242
243
244
245
 
# File 'lib/pg/connection.rb', line 241

def conninfo_hash
  return self.conninfo.each_with_object({}) do |info, hash|
    hash[ info[:keyword].to_sym ] = info[:val]
  end
end

#consume_input ⇒ Object

If input is available from the server, consume it. After calling consume_input, you can check is_busy or notifies to see if the state has changed.



2085
2086
2087
 
# File 'ext/pg_connection.c', line 2085

static VALUE
pgconn_consume_input(self)
VALUE self;

#copy_data(sql, coder = nil) ⇒ Object

call-seq:

conn.copy_data( sql ) {|sql_result| ... } -> PG::Result

Execute a copy process for transfering data to or from the server.

This issues the SQL COPY command via #exec. The response to this (if there is no error in the command) is a PG::Result object that is passed to the block, bearing a status code of PGRES_COPY_OUT or PGRES_COPY_IN (depending on the specified copy direction). The application should then use #put_copy_data or #get_copy_data to receive or transmit data rows and should return from the block when finished.

#copy_data returns another PG::Result object when the data transfer is complete. An exception is raised if some problem was encountered, so it isn’t required to make use of any of them. At this point further SQL commands can be issued via #exec. (It is not possible to execute other SQL commands using the same connection while the COPY operation is in progress.)

This method ensures, that the copy process is properly terminated in case of client side or server side failures. Therefore, in case of blocking mode of operation, #copy_data is preferred to raw calls of #put_copy_data, #get_copy_data and #put_copy_end.

Example with CSV input format:

conn.exec "create table my_table (a text,b text,c text,d text)"
conn.copy_data "COPY my_table FROM STDIN CSV" do
  conn.put_copy_data "some,data,to,copy\n"
  conn.put_copy_data "more,data,to,copy\n"
end

This creates my_table and inserts two CSV rows.

The same with text format encoder PG::TextEncoder::CopyRow and Array input:

enco = PG::TextEncoder::CopyRow.new
conn.copy_data "COPY my_table FROM STDIN", enco do
  conn.put_copy_data ['some', 'data', 'to', 'copy']
  conn.put_copy_data ['more', 'data', 'to', 'copy']
end

Example with CSV output format:

conn.copy_data "COPY my_table TO STDOUT CSV" do
  while row=conn.get_copy_data
    p row
  end
end

This prints all rows of my_table to stdout:

"some,data,to,copy\n"
"more,data,to,copy\n"

The same with text format decoder PG::TextDecoder::CopyRow and Array output:

deco = PG::TextDecoder::CopyRow.new
conn.copy_data "COPY my_table TO STDOUT", deco do
  while row=conn.get_copy_data
    p row
  end
end

This receives all rows of my_table as ruby array:

["some", "data", "to", "copy"]
["more", "data", "to", "copy"]



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/pg/connection.rb', line 150

def copy_data( sql, coder=nil )
  res = exec( sql )

  case res.result_status
  when PGRES_COPY_IN
    begin
      if coder
        old_coder = self.encoder_for_put_copy_data
        self.encoder_for_put_copy_data = coder
      end
      yield res
    rescue Exception => err
      errmsg = "%s while copy data: %s" % [ err.class.name, err.message ]
      put_copy_end( errmsg )
      get_result
      raise
    else
      put_copy_end
      get_last_result
    ensure
      self.encoder_for_put_copy_data = old_coder if coder
    end

  when PGRES_COPY_OUT
    begin
      if coder
        old_coder = self.decoder_for_get_copy_data
        self.decoder_for_get_copy_data = coder
      end
      yield res
    rescue Exception => err
      cancel
      while get_copy_data
      end
      while get_result
      end
      raise
    else
      res = get_last_result
      if !res || res.result_status != PGRES_COMMAND_OK
        while get_copy_data
        end
        while get_result
        end
        raise PG::NotAllCopyDataRetrieved, "Not all COPY data retrieved"
      end
      res
    ensure
      self.decoder_for_get_copy_data = old_coder if coder
    end

  else
    raise ArgumentError, "SQL command is no COPY statement: #{sql}"
  end
end

#db ⇒ Object

Returns the connected database name.



590
591
592
593
594
595
596
 
# File 'ext/pg_connection.c', line 590

static VALUE
pgconn_db(VALUE self)
{
  char *db = PQdb(pg_get_pgconn(self));
  if (!db) return Qnil;
  return rb_tainted_str_new2(db);
}

#decoder_for_get_copy_data ⇒ PG::Coder

Returns the default coder object that is currently set for type casting of received data by #get_copy_data .

Returns either:

  • a kind of PG::Coder

  • nil - type encoding is disabled, returned data will be a String.

Returns:



3904
3905
3906
3907
3908
3909
3910
 
# File 'ext/pg_connection.c', line 3904

static VALUE
pgconn_decoder_for_get_copy_data_get(VALUE self)
{
  t_pg_connection *this = pg_get_connection( self );

  return this->decoder_for_get_copy_data;
}

#decoder_for_get_copy_data=(decoder) ⇒ Object

Set the default coder that is used for type casting of received data by #get_copy_data .

decoder can be:

  • a kind of PG::Coder

  • nil - disable type decoding, returned data will be a String.



3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
 
# File 'ext/pg_connection.c', line 3875

static VALUE
pgconn_decoder_for_get_copy_data_set(VALUE self, VALUE typemap)
{
  t_pg_connection *this = pg_get_connection( self );

  if( typemap != Qnil ){
    if ( !rb_obj_is_kind_of(typemap, rb_cPG_Coder) ) {
      rb_raise( rb_eTypeError, "wrong argument type %s (expected kind of PG::Coder)",
          rb_obj_classname( typemap ) );
    }
    Check_Type(typemap, T_DATA);
  }
  this->decoder_for_get_copy_data = typemap;

  return typemap;
}

#describe_portal(portal_name) ⇒ PG::Result

Retrieve information about the portal portal_name.

Returns:



1472
1473
1474
 
# File 'ext/pg_connection.c', line 1472

static VALUE
pgconn_describe_portal(self, stmt_name)
VALUE self, stmt_name;

#describe_prepared(statement_name) ⇒ PG::Result

Retrieve information about the prepared statement statement_name.

Returns:



1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
 
# File 'ext/pg_connection.c', line 1446

static VALUE
pgconn_describe_prepared(VALUE self, VALUE stmt_name)
{
  PGresult *result;
  VALUE rb_pgresult;
  PGconn *conn = pg_get_pgconn(self);
  const char *stmt;
  if(NIL_P(stmt_name)) {
    stmt = NULL;
  }
  else {
    stmt = pg_cstr_enc(stmt_name, ENCODING_GET(self));
  }
  result = gvl_PQdescribePrepared(conn, stmt);
  rb_pgresult = pg_new_result(result, self);
  pg_result_check(rb_pgresult);
  return rb_pgresult;
}

#encoder_for_put_copy_data ⇒ PG::Coder

Returns the default coder object that is currently set for type casting of parameters to #put_copy_data .

Returns either:

  • a kind of PG::Coder

  • nil - type encoding is disabled, data must be a String.

Returns:



3855
3856
3857
3858
3859
3860
3861
 
# File 'ext/pg_connection.c', line 3855

static VALUE
pgconn_encoder_for_put_copy_data_get(VALUE self)
{
  t_pg_connection *this = pg_get_connection( self );

  return this->encoder_for_put_copy_data;
}

#encoder_for_put_copy_data=(encoder) ⇒ Object

Set the default coder that is used for type casting of parameters to #put_copy_data .

encoder can be:

  • a kind of PG::Coder

  • nil - disable type encoding, data must be a String.



3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
 
# File 'ext/pg_connection.c', line 3826

static VALUE
pgconn_encoder_for_put_copy_data_set(VALUE self, VALUE typemap)
{
  t_pg_connection *this = pg_get_connection( self );

  if( typemap != Qnil ){
    if ( !rb_obj_is_kind_of(typemap, rb_cPG_Coder) ) {
      rb_raise( rb_eTypeError, "wrong argument type %s (expected kind of PG::Coder)",
          rb_obj_classname( typemap ) );
    }
    Check_Type(typemap, T_DATA);
  }
  this->encoder_for_put_copy_data = typemap;

  return typemap;
}

#error_message ⇒ String

Returns the error message about connection.

Returns:

  • (String) 


798
799
800
801
802
803
804
 
# File 'ext/pg_connection.c', line 798

static VALUE
pgconn_error_message(VALUE self)
{
  char *error = PQerrorMessage(pg_get_pgconn(self));
  if (!error) return Qnil;
  return rb_tainted_str_new2(error);
}

#escape_bytea(string) ⇒ String

Escapes binary data for use within an SQL command with the type bytea.

Certain byte values must be escaped (but all byte values may be escaped) when used as part of a bytea literal in an SQL statement. In general, to escape a byte, it is converted into the three digit octal number equal to the octet value, and preceded by two backslashes. The single quote (‘) and backslash () characters have special alternative escape sequences. #escape_bytea performs this operation, escaping only the minimally required bytes.

Consider using exec_params, which avoids the need for passing values inside of SQL commands.

NOTE: This class version of this method can only be used safely in client programs that use a single PostgreSQL connection at a time (in this case it can find out what it needs to know “behind the scenes”). It might give the wrong results if used in programs that use multiple database connections; use the same method on the connection object in such cases.

Returns:

  • (String) 


1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
 
# File 'ext/pg_connection.c', line 1596

static VALUE
pgconn_s_escape_bytea(VALUE self, VALUE str)
{
  unsigned char *from, *to;
  size_t from_len, to_len;
  VALUE ret;

  Check_Type(str, T_STRING);
  from      = (unsigned char*)RSTRING_PTR(str);
  from_len  = RSTRING_LEN(str);

  if ( rb_obj_is_kind_of(self, rb_cPGconn) ) {
    to = PQescapeByteaConn(pg_get_pgconn(self), from, from_len, &to_len);
  } else {
    to = PQescapeBytea( from, from_len, &to_len);
  }

  ret = rb_str_new((char*)to, to_len - 1);
  OBJ_INFECT(ret, str);
  PQfreemem(to);
  return ret;
}

#escape_identifier(str) ⇒ String

Escape an arbitrary String str as an identifier.

This method does the same as #quote_ident with a String argument, but it doesn’t support an Array argument and it makes use of libpq to process the string.

Returns:

  • (String) 


1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
 
# File 'ext/pg_connection.c', line 1698

static VALUE
pgconn_escape_identifier(VALUE self, VALUE string)
{
  PGconn *conn = pg_get_pgconn(self);
  char *escaped = NULL;
  VALUE error;
  VALUE result = Qnil;
  int enc_idx = ENCODING_GET(self);

  Check_Type(string, T_STRING);
  if( ENCODING_GET(string) != enc_idx ){
    string = rb_str_export_to_enc(string, rb_enc_from_index(enc_idx));
  }

  escaped = PQescapeIdentifier(conn, RSTRING_PTR(string), RSTRING_LEN(string));
  if (escaped == NULL)
  {
    error = rb_exc_new2(rb_ePGerror, PQerrorMessage(conn));
    rb_iv_set(error, "@connection", self);
    rb_exc_raise(error);
    return Qnil;
  }
  result = rb_str_new2(escaped);
  PQfreemem(escaped);
  OBJ_INFECT(result, string);
  PG_ENCODING_SET_NOCHECK(result, enc_idx);

  return result;
}

#escape_literal(str) ⇒ String

Escape an arbitrary String str as a literal.

Returns:

  • (String) 


1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
 
# File 'ext/pg_connection.c', line 1656

static VALUE
pgconn_escape_literal(VALUE self, VALUE string)
{
  PGconn *conn = pg_get_pgconn(self);
  char *escaped = NULL;
  VALUE error;
  VALUE result = Qnil;
  int enc_idx = ENCODING_GET(self);

  Check_Type(string, T_STRING);
  if( ENCODING_GET(string) != enc_idx ){
    string = rb_str_export_to_enc(string, rb_enc_from_index(enc_idx));
  }

  escaped = PQescapeLiteral(conn, RSTRING_PTR(string), RSTRING_LEN(string));
  if (escaped == NULL)
  {
    error = rb_exc_new2(rb_ePGerror, PQerrorMessage(conn));
    rb_iv_set(error, "@connection", self);
    rb_exc_raise(error);
    return Qnil;
  }
  result = rb_str_new2(escaped);
  PQfreemem(escaped);
  OBJ_INFECT(result, string);
  PG_ENCODING_SET_NOCHECK(result, enc_idx);

  return result;
}

#escape_string(str) ⇒ String Also known as: escape

Returns a SQL-safe version of the String str. This is the preferred way to make strings safe for inclusion in SQL queries.

Consider using exec_params, which avoids the need for passing values inside of SQL commands.

Encoding of escaped string will be equal to client encoding of connection.

NOTE: This class version of this method can only be used safely in client programs that use a single PostgreSQL connection at a time (in this case it can find out what it needs to know “behind the scenes”). It might give the wrong results if used in programs that use multiple database connections; use the same method on the connection object in such cases.

Returns:

  • (String) 


1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
 
# File 'ext/pg_connection.c', line 1541

static VALUE
pgconn_s_escape(VALUE self, VALUE string)
{
  size_t size;
  int error;
  VALUE result;
  int enc_idx;
  int singleton = !rb_obj_is_kind_of(self, rb_cPGconn);

  Check_Type(string, T_STRING);
  enc_idx = ENCODING_GET( singleton ? string : self );
  if( ENCODING_GET(string) != enc_idx ){
    string = rb_str_export_to_enc(string, rb_enc_from_index(enc_idx));
  }

  result = rb_str_new(NULL, RSTRING_LEN(string) * 2 + 1);
  PG_ENCODING_SET_NOCHECK(result, enc_idx);
  if( !singleton ) {
    size = PQescapeStringConn(pg_get_pgconn(self), RSTRING_PTR(result),
      RSTRING_PTR(string), RSTRING_LEN(string), &error);
    if(error) {
      rb_raise(rb_ePGerror, "%s", PQerrorMessage(pg_get_pgconn(self)));
    }
  } else {
    size = PQescapeString(RSTRING_PTR(result), RSTRING_PTR(string), RSTRING_LEN(string));
  }
  rb_str_set_len(result, size);
  OBJ_INFECT(result, string);

  return result;
}

#exec(sql) ⇒ PG::Result #exec(sql) {|pg_result| ... } ⇒ Object Also known as: query

Sends SQL query request specified by sql to PostgreSQL. Returns a PG::Result instance on success. On failure, it raises a PG::Error.

For backward compatibility, if you pass more than one parameter to this method, it will call #exec_params for you. New code should explicitly use #exec_params if argument placeholders are used.

If the optional code block is given, it will be passed result as an argument, and the PG::Result object will automatically be cleared when the block terminates. In this instance, conn.exec returns the value of the block.

#exec is implemented on the synchronous command processing API of libpq, whereas #async_exec is implemented on the asynchronous API. #exec is somewhat faster that #async_exec, but blocks any signals to be processed until the query is finished. This is most notably visible by a delayed reaction to Control+C. Both methods ensure that other threads can process while waiting for the server to complete the request.

Overloads:

  • #exec(sql) ⇒ PG::Result

    Returns:

  • #exec(sql) {|pg_result| ... } ⇒ Object

    Yields:

    • (pg_result) 


951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
 
# File 'ext/pg_connection.c', line 951

static VALUE
pgconn_exec(int argc, VALUE *argv, VALUE self)
{
  PGconn *conn = pg_get_pgconn(self);
  PGresult *result = NULL;
  VALUE rb_pgresult;

  /* If called with no parameters, use PQexec */
  if ( argc == 1 ) {
    VALUE query_str = argv[0];

    result = gvl_PQexec(conn, pg_cstr_enc(query_str, ENCODING_GET(self)));
    rb_pgresult = pg_new_result(result, self);
    pg_result_check(rb_pgresult);
    if (rb_block_given_p()) {
      return rb_ensure(rb_yield, rb_pgresult, pg_result_clear, rb_pgresult);
    }
    return rb_pgresult;
  }

  /* Otherwise, just call #exec_params instead for backward-compatibility */
  else {
    return pgconn_exec_params( argc, argv, self );
  }

}

#exec_params(sql, params[, result_format[, type_map]]) ⇒ PG::Result #exec_params(sql, params[, result_format[, type_map]]) {|pg_result| ... } ⇒ Object

Sends SQL query request specified by sql to PostgreSQL using placeholders for parameters.

Returns a PG::Result instance on success. On failure, it raises a PG::Error.

params is an array of the bind parameters for the SQL query. Each element of the params array may be either:

a hash of the form:
  {:value  => String (value of bind parameter)
   :type   => Integer (oid of type of bind parameter)
   :format => Integer (0 for text, 1 for binary)
  }
or, it may be a String. If it is a string, that is equivalent to the hash:
  { :value => <string value>, :type => 0, :format => 0 }

PostgreSQL bind parameters are represented as $1, $1, $2, etc., inside the SQL query. The 0th element of the params array is bound to $1, the 1st element is bound to $2, etc. nil is treated as NULL.

If the types are not specified, they will be inferred by PostgreSQL. Instead of specifying type oids, it’s recommended to simply add explicit casts in the query to ensure that the right type is used.

For example: “SELECT $1::int”

The optional result_format should be 0 for text results, 1 for binary.

type_map can be a PG::TypeMap derivation (such as PG::BasicTypeMapForQueries). This will type cast the params form various Ruby types before transmission based on the encoders defined by the type map. When a type encoder is used the format and oid of a given bind parameter are retrieved from the encoder instead out of the hash form described above.

If the optional code block is given, it will be passed result as an argument, and the PG::Result object will automatically be cleared when the block terminates. In this instance, conn.exec returns the value of the block.

Overloads:

  • #exec_params(sql, params[, result_format[, type_map]]) ⇒ PG::Result

    Returns:

  • #exec_params(sql, params[, result_format[, type_map]]) {|pg_result| ... } ⇒ Object

    Yields:

    • (pg_result) 


1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
 
# File 'ext/pg_connection.c', line 1266

static VALUE
pgconn_exec_params( int argc, VALUE *argv, VALUE self )
{
  PGconn *conn = pg_get_pgconn(self);
  PGresult *result = NULL;
  VALUE rb_pgresult;
  VALUE command, in_res_fmt;
  int nParams;
  int resultFormat;
  struct query_params_data paramsData = { ENCODING_GET(self) };

  rb_scan_args(argc, argv, "13", &command, &paramsData.params, &in_res_fmt, &paramsData.typemap);
  paramsData.with_types = 1;

  /*
   * Handle the edge-case where the caller is coming from #exec, but passed an explict +nil+
   * for the second parameter.
   */
  if ( NIL_P(paramsData.params) ) {
    return pgconn_exec( 1, argv, self );
  }
  pgconn_query_assign_typemap( self, &paramsData );

  resultFormat = NIL_P(in_res_fmt) ? 0 : NUM2INT(in_res_fmt);
  nParams = alloc_query_params( &paramsData );

  result = gvl_PQexecParams(conn, pg_cstr_enc(command, paramsData.enc_idx), nParams, paramsData.types,
    (const char * const *)paramsData.values, paramsData.lengths, paramsData.formats, resultFormat);

  free_query_params( &paramsData );

  rb_pgresult = pg_new_result(result, self);
  pg_result_check(rb_pgresult);

  if (rb_block_given_p()) {
    return rb_ensure(rb_yield, rb_pgresult, pg_result_clear, rb_pgresult);
  }

  return rb_pgresult;
}

#exec_prepared(statement_name[, params, result_format[, type_map]]) ⇒ PG::Result #exec_prepared(statement_name[, params, result_format[, type_map]]) {|pg_result| ... } ⇒ Object

Execute prepared named statement specified by statement_name. Returns a PG::Result instance on success. On failure, it raises a PG::Error.

params is an array of the optional bind parameters for the SQL query. Each element of the params array may be either:

a hash of the form:
  {:value  => String (value of bind parameter)
   :format => Integer (0 for text, 1 for binary)
  }
or, it may be a String. If it is a string, that is equivalent to the hash:
  { :value => <string value>, :format => 0 }

PostgreSQL bind parameters are represented as $1, $1, $2, etc., inside the SQL query. The 0th element of the params array is bound to $1, the 1st element is bound to $2, etc. nil is treated as NULL.

The optional result_format should be 0 for text results, 1 for binary.

type_map can be a PG::TypeMap derivation (such as PG::BasicTypeMapForQueries). This will type cast the params form various Ruby types before transmission based on the encoders defined by the type map. When a type encoder is used the format and oid of a given bind parameter are retrieved from the encoder instead out of the hash form described above.

If the optional code block is given, it will be passed result as an argument, and the PG::Result object will automatically be cleared when the block terminates. In this instance, conn.exec_prepared returns the value of the block.

Overloads:

  • #exec_prepared(statement_name[, params, result_format[, type_map]]) ⇒ PG::Result

    Returns:

  • #exec_prepared(statement_name[, params, result_format[, type_map]]) {|pg_result| ... } ⇒ Object

    Yields:

    • (pg_result) 


1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
 
# File 'ext/pg_connection.c', line 1402

static VALUE
pgconn_exec_prepared(int argc, VALUE *argv, VALUE self)
{
  PGconn *conn = pg_get_pgconn(self);
  PGresult *result = NULL;
  VALUE rb_pgresult;
  VALUE name, in_res_fmt;
  int nParams;
  int resultFormat;
  struct query_params_data paramsData = { ENCODING_GET(self) };

  rb_scan_args(argc, argv, "13", &name, &paramsData.params, &in_res_fmt, &paramsData.typemap);
  paramsData.with_types = 0;

  if(NIL_P(paramsData.params)) {
    paramsData.params = rb_ary_new2(0);
  }
  pgconn_query_assign_typemap( self, &paramsData );

  resultFormat = NIL_P(in_res_fmt) ? 0 : NUM2INT(in_res_fmt);
  nParams = alloc_query_params( &paramsData );

  result = gvl_PQexecPrepared(conn, pg_cstr_enc(name, paramsData.enc_idx), nParams,
    (const char * const *)paramsData.values, paramsData.lengths, paramsData.formats,
    resultFormat);

  free_query_params( &paramsData );

  rb_pgresult = pg_new_result(result, self);
  pg_result_check(rb_pgresult);
  if (rb_block_given_p()) {
    return rb_ensure(rb_yield, rb_pgresult,
      pg_result_clear, rb_pgresult);
  }
  return rb_pgresult;
}

#external_encoding ⇒ Encoding

Return the server_encoding of the connected database as a Ruby Encoding object. The SQL_ASCII encoding is mapped to to ASCII_8BIT.

Returns:

  • (Encoding) 


3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
 
# File 'ext/pg_connection.c', line 3656

static VALUE
pgconn_external_encoding(VALUE self)
{
  t_pg_connection *this = pg_get_connection_safe( self );
  rb_encoding *enc = NULL;
  const char *pg_encname = NULL;

  /* Use cached value if found */
  if ( RTEST(this->external_encoding) ) return this->external_encoding;

  pg_encname = PQparameterStatus( this->pgconn, "server_encoding" );
  enc = pg_get_pg_encname_as_rb_encoding( pg_encname );
  this->external_encoding = rb_enc_from_encoding( enc );

  return this->external_encoding;
}

#finish ⇒ Object Also known as: close

Closes the backend connection.



506
507
508
509
510
511
512
513
514
515
 
# File 'ext/pg_connection.c', line 506

static VALUE
pgconn_finish( VALUE self )
{
  t_pg_connection *this = pg_get_connection_safe( self );

  pgconn_close_socket_io( self );
  PQfinish( this->pgconn );
  this->pgconn = NULL;
  return Qnil;
}

#finished? ⇒ Boolean

Returns true if the backend connection has been closed.

Returns:

  • (Boolean) 


524
525
526
527
528
529
530
 
# File 'ext/pg_connection.c', line 524

static VALUE
pgconn_finished_p( VALUE self )
{
  t_pg_connection *this = pg_get_connection( self );
  if ( this->pgconn ) return Qfalse;
  return Qtrue;
}

#flush ⇒ Boolean

Attempts to flush any queued output data to the server. Returns true if data is successfully flushed, false if not (can only return false if connection is nonblocking. Raises PG::Error if some other failure occurred.

Returns:

  • (Boolean) 


2177
2178
2179
 
# File 'ext/pg_connection.c', line 2177

static VALUE
pgconn_flush(self)
VALUE self;

#get_client_encoding ⇒ String

Returns the client encoding as a String.

Returns:

  • (String) 


2949
2950
2951
2952
2953
2954
 
# File 'ext/pg_connection.c', line 2949

static VALUE
pgconn_get_client_encoding(VALUE self)
{
  char *encoding = (char *)pg_encoding_to_char(PQclientEncoding(pg_get_pgconn(self)));
  return rb_tainted_str_new2(encoding);
}

#get_copy_data([ async = false [, decoder = nil ]]) ⇒ String

Return a string containing one row of data, nil if the copy is done, or false if the call would block (only possible if async is true).

decoder can be a PG::Coder derivation (typically PG::TextDecoder::CopyRow). This decodes the received data fields as Array of Strings. Optionally the decoder can type cast the fields to various Ruby types in one step, if PG::TextDecoder::CopyRow#type_map is set accordingly.

See also #copy_data.

Returns:

  • (String) 


2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
 
# File 'ext/pg_connection.c', line 2676

static VALUE
pgconn_get_copy_data(int argc, VALUE *argv, VALUE self )
{
  VALUE async_in;
  VALUE error;
  VALUE result;
  int ret;
  char *buffer;
  VALUE decoder;
  t_pg_coder *p_coder = NULL;
  t_pg_connection *this = pg_get_connection_safe( self );

  rb_scan_args(argc, argv, "02", &async_in, &decoder);

  if( NIL_P(decoder) ){
    if( !NIL_P(this->decoder_for_get_copy_data) ){
      p_coder = DATA_PTR( this->decoder_for_get_copy_data );
    }
  } else if( rb_obj_is_kind_of(decoder, rb_cPG_Coder) ) {
    Data_Get_Struct( decoder, t_pg_coder, p_coder );
  } else {
    rb_raise( rb_eTypeError, "wrong decoder type %s (expected some kind of PG::Coder)",
        rb_obj_classname( decoder ) );
  }

  ret = gvl_PQgetCopyData(this->pgconn, &buffer, RTEST(async_in));
  if(ret == -2) { /* error */
    error = rb_exc_new2(rb_ePGerror, PQerrorMessage(this->pgconn));
    rb_iv_set(error, "@connection", self);
    rb_exc_raise(error);
  }
  if(ret == -1) { /* No data left */
    return Qnil;
  }
  if(ret == 0) { /* would block */
    return Qfalse;
  }

  if( p_coder ){
    t_pg_coder_dec_func dec_func = pg_coder_dec_func( p_coder, p_coder->format );
    result =  dec_func( p_coder, buffer, ret, 0, 0, ENCODING_GET(self) );
  } else {
    result = rb_tainted_str_new(buffer, ret);
  }

  PQfreemem(buffer);
  return result;
}

#get_last_result ⇒ PG::Result

This function retrieves all available results on the current connection (from previously issued asynchronous commands like send_query()) and returns the last non-NULL result, or nil if no results are available.

This function is similar to #get_result except that it is designed to get one and only one result.

Returns:



3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
 
# File 'ext/pg_connection.c', line 3143

static VALUE
pgconn_get_last_result(VALUE self)
{
  PGconn *conn = pg_get_pgconn(self);
  VALUE rb_pgresult = Qnil;
  PGresult *cur, *prev;


  cur = prev = NULL;
  while ((cur = gvl_PQgetResult(conn)) != NULL) {
    int status;

    if (prev) PQclear(prev);
    prev = cur;

    status = PQresultStatus(cur);
    if (status == PGRES_COPY_OUT || status == PGRES_COPY_IN)
      break;
  }

  if (prev) {
    rb_pgresult = pg_new_result( prev, self );
    pg_result_check(rb_pgresult);
  }

  return rb_pgresult;
}

#get_result ⇒ PG::Result #get_result {|pg_result| ... } ⇒ Object

Blocks waiting for the next result from a call to #send_query (or another asynchronous command), and returns it. Returns nil if no more results are available.

Note: call this function repeatedly until it returns nil, or else you will not be able to issue further commands.

If the optional code block is given, it will be passed result as an argument, and the PG::Result object will automatically be cleared when the block terminates. In this instance, conn.exec returns the value of the block.

Overloads:

  • #get_result ⇒ PG::Result

    Returns:

  • #get_result {|pg_result| ... } ⇒ Object

    Yields:

    • (pg_result) 


2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
 
# File 'ext/pg_connection.c', line 2059

static VALUE
pgconn_get_result(VALUE self)
{
  PGconn *conn = pg_get_pgconn(self);
  PGresult *result;
  VALUE rb_pgresult;

  result = gvl_PQgetResult(conn);
  if(result == NULL)
    return Qnil;
  rb_pgresult = pg_new_result(result, self);
  if (rb_block_given_p()) {
    return rb_ensure(rb_yield, rb_pgresult,
      pg_result_clear, rb_pgresult);
  }
  return rb_pgresult;
}

#host ⇒ Object

Returns the connected server name.



632
633
634
635
636
637
638
 
# File 'ext/pg_connection.c', line 632

static VALUE
pgconn_host(VALUE self)
{
  char *host = PQhost(pg_get_pgconn(self));
  if (!host) return Qnil;
  return rb_tainted_str_new2(host);
}

#internal_encoding ⇒ Encoding

defined in Ruby 1.9 or later.

Returns:

  • an Encoding - client_encoding of the connection as a Ruby Encoding object.

  • nil - the client_encoding is ‘SQL_ASCII’

Returns:

  • (Encoding) 


3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
 
# File 'ext/pg_connection.c', line 3589

static VALUE
pgconn_internal_encoding(VALUE self)
{
  PGconn *conn = pg_get_pgconn( self );
  rb_encoding *enc = pg_conn_enc_get( conn );

  if ( enc ) {
    return rb_enc_from_encoding( enc );
  } else {
    return Qnil;
  }
}

#internal_encoding=(value) ⇒ Object

A wrapper of #set_client_encoding. defined in Ruby 1.9 or later.

value can be one of:

  • an Encoding

  • a String - a name of Encoding

  • nil - sets the client_encoding to SQL_ASCII.



3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
 
# File 'ext/pg_connection.c', line 3616

static VALUE
pgconn_internal_encoding_set(VALUE self, VALUE enc)
{
  VALUE enc_inspect;
  if (NIL_P(enc)) {
    pgconn_set_client_encoding( self, rb_usascii_str_new_cstr("SQL_ASCII") );
    return enc;
  }
  else if ( TYPE(enc) == T_STRING && strcasecmp("JOHAB", StringValueCStr(enc)) == 0 ) {
    pgconn_set_client_encoding(self, rb_usascii_str_new_cstr("JOHAB"));
    return enc;
  }
  else {
    rb_encoding *rbenc = rb_to_encoding( enc );
    const char *name = pg_get_rb_encoding_as_pg_encoding( rbenc );

    if ( gvl_PQsetClientEncoding(pg_get_pgconn( self ), name) == -1 ) {
      VALUE server_encoding = pgconn_external_encoding( self );
      rb_raise( rb_eEncCompatError, "incompatible character encodings: %s and %s",
            rb_enc_name(rb_to_encoding(server_encoding)), name );
    }
    pgconn_set_internal_encoding_index( self );
    return enc;
  }

  enc_inspect = rb_inspect(enc);
  rb_raise( rb_ePGerror, "unknown encoding: %s", StringValueCStr(enc_inspect) );

  return Qnil;
}

#is_busy ⇒ Boolean

Returns true if a command is busy, that is, if PQgetResult would block. Otherwise returns false.

Returns:

  • (Boolean) 


2107
2108
2109
 
# File 'ext/pg_connection.c', line 2107

static VALUE
pgconn_is_busy(self)
VALUE self;

#isnonblocking ⇒ Boolean Also known as: nonblocking?

Returns true if a command is busy, that is, if PQgetResult would block. Otherwise returns false.

Returns:

  • (Boolean) 


2160
2161
2162
 
# File 'ext/pg_connection.c', line 2160

static VALUE
pgconn_isnonblocking(self)
VALUE self;

#lo_close(lo_desc) ⇒ nil Also known as: loclose

Closes the postgres large object of lo_desc.

Returns:

  • (nil) 


3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
 
# File 'ext/pg_connection.c', line 3538

static VALUE
pgconn_loclose(VALUE self, VALUE in_lo_desc)
{
  PGconn *conn = pg_get_pgconn(self);
  int lo_desc = NUM2INT(in_lo_desc);

  if(lo_close(conn,lo_desc) < 0)
    rb_raise(rb_ePGerror,"lo_close failed");

  return Qnil;
}

#lo_creat([mode]) ⇒ Integer Also known as: locreat

Creates a large object with mode mode. Returns a large object Oid. On failure, it raises PG::Error.

Returns:

  • (Integer) 


3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
 
# File 'ext/pg_connection.c', line 3288

static VALUE
pgconn_locreat(int argc, VALUE *argv, VALUE self)
{
  Oid lo_oid;
  int mode;
  VALUE nmode;
  PGconn *conn = pg_get_pgconn(self);

  if (rb_scan_args(argc, argv, "01", &nmode) == 0)
    mode = INV_READ;
  else
    mode = NUM2INT(nmode);

  lo_oid = lo_creat(conn, mode);
  if (lo_oid == 0)
    rb_raise(rb_ePGerror, "lo_creat failed");

  return UINT2NUM(lo_oid);
}

#lo_create(oid) ⇒ Integer Also known as: locreate

Creates a large object with oid oid. Returns the large object Oid. On failure, it raises PG::Error.

Returns:

  • (Integer) 


3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
 
# File 'ext/pg_connection.c', line 3315

static VALUE
pgconn_locreate(VALUE self, VALUE in_lo_oid)
{
  Oid ret, lo_oid;
  PGconn *conn = pg_get_pgconn(self);
  lo_oid = NUM2UINT(in_lo_oid);

  ret = lo_create(conn, lo_oid);
  if (ret == InvalidOid)
    rb_raise(rb_ePGerror, "lo_create failed");

  return UINT2NUM(ret);
}

#lo_export(oid, file) ⇒ nil Also known as: loexport

Saves a large object of oid to a file.

Returns:

  • (nil) 


3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
 
# File 'ext/pg_connection.c', line 3359

static VALUE
pgconn_loexport(VALUE self, VALUE lo_oid, VALUE filename)
{
  PGconn *conn = pg_get_pgconn(self);
  Oid oid;
  Check_Type(filename, T_STRING);

  oid = NUM2UINT(lo_oid);

  if (lo_export(conn, oid, StringValueCStr(filename)) < 0) {
    rb_raise(rb_ePGerror, "%s", PQerrorMessage(conn));
  }
  return Qnil;
}

#lo_import(file) ⇒ Integer Also known as: loimport

Import a file to a large object. Returns a large object Oid.

On failure, it raises a PG::Error.

Returns:

  • (Integer) 


3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
 
# File 'ext/pg_connection.c', line 3337

static VALUE
pgconn_loimport(VALUE self, VALUE filename)
{
  Oid lo_oid;

  PGconn *conn = pg_get_pgconn(self);

  Check_Type(filename, T_STRING);

  lo_oid = lo_import(conn, StringValueCStr(filename));
  if (lo_oid == 0) {
    rb_raise(rb_ePGerror, "%s", PQerrorMessage(conn));
  }
  return UINT2NUM(lo_oid);
}

#lo_lseek(lo_desc, offset, whence) ⇒ Integer Also known as: lolseek, lo_seek, loseek

Move the large object pointer lo_desc to offset offset. Valid values for whence are SEEK_SET, SEEK_CUR, and SEEK_END. (Or 0, 1, or 2.)

Returns:

  • (Integer) 


3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
 
# File 'ext/pg_connection.c', line 3480

static VALUE
pgconn_lolseek(VALUE self, VALUE in_lo_desc, VALUE offset, VALUE whence)
{
  PGconn *conn = pg_get_pgconn(self);
  int lo_desc = NUM2INT(in_lo_desc);
  int ret;

  if((ret = lo_lseek(conn, lo_desc, NUM2INT(offset), NUM2INT(whence))) < 0) {
    rb_raise(rb_ePGerror, "lo_lseek failed");
  }

  return INT2FIX(ret);
}

#lo_open(oid, [mode]) ⇒ Integer Also known as: loopen

Open a large object of oid. Returns a large object descriptor instance on success. The mode argument specifies the mode for the opened large object,which is either INV_READ, or INV_WRITE.

If mode is omitted, the default is INV_READ.

Returns:

  • (Integer) 


3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
 
# File 'ext/pg_connection.c', line 3384

static VALUE
pgconn_loopen(int argc, VALUE *argv, VALUE self)
{
  Oid lo_oid;
  int fd, mode;
  VALUE nmode, selfid;
  PGconn *conn = pg_get_pgconn(self);

  rb_scan_args(argc, argv, "11", &selfid, &nmode);
  lo_oid = NUM2UINT(selfid);
  if(NIL_P(nmode))
    mode = INV_READ;
  else
    mode = NUM2INT(nmode);

  if((fd = lo_open(conn, lo_oid, mode)) < 0) {
    rb_raise(rb_ePGerror, "can't open large object: %s", PQerrorMessage(conn));
  }
  return INT2FIX(fd);
}

#lo_read(lo_desc, len) ⇒ String Also known as: loread

Attempts to read len bytes from large object lo_desc, returns resulting data.

Returns:

  • (String) 


3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
 
# File 'ext/pg_connection.c', line 3439

static VALUE
pgconn_loread(VALUE self, VALUE in_lo_desc, VALUE in_len)
{
  int ret;
  PGconn *conn = pg_get_pgconn(self);
  int len = NUM2INT(in_len);
  int lo_desc = NUM2INT(in_lo_desc);
  VALUE str;
  char *buffer;

  buffer = ALLOC_N(char, len);
  if(buffer == NULL)
    rb_raise(rb_eNoMemError, "ALLOC failed!");

  if (len < 0){
    rb_raise(rb_ePGerror,"nagative length %d given", len);
  }

  if((ret = lo_read(conn, lo_desc, buffer, len)) < 0)
    rb_raise(rb_ePGerror, "lo_read failed");

  if(ret == 0) {
    xfree(buffer);
    return Qnil;
  }

  str = rb_tainted_str_new(buffer, ret);
  xfree(buffer);

  return str;
}

#lo_tell(lo_desc) ⇒ Integer Also known as: lotell

Returns the current position of the large object lo_desc.

Returns:

  • (Integer) 


3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
 
# File 'ext/pg_connection.c', line 3500

static VALUE
pgconn_lotell(VALUE self, VALUE in_lo_desc)
{
  int position;
  PGconn *conn = pg_get_pgconn(self);
  int lo_desc = NUM2INT(in_lo_desc);

  if((position = lo_tell(conn, lo_desc)) < 0)
    rb_raise(rb_ePGerror,"lo_tell failed");

  return INT2FIX(position);
}

#lo_truncate(lo_desc, len) ⇒ nil Also known as: lotruncate

Truncates the large object lo_desc to size len.

Returns:

  • (nil) 


3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
 
# File 'ext/pg_connection.c', line 3519

static VALUE
pgconn_lotruncate(VALUE self, VALUE in_lo_desc, VALUE in_len)
{
  PGconn *conn = pg_get_pgconn(self);
  int lo_desc = NUM2INT(in_lo_desc);
  size_t len = NUM2INT(in_len);

  if(lo_truncate(conn,lo_desc,len) < 0)
    rb_raise(rb_ePGerror,"lo_truncate failed");

  return Qnil;
}

#lo_unlink(oid) ⇒ nil Also known as: lounlink

Unlinks (deletes) the postgres large object of oid.

Returns:

  • (nil) 


3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
 
# File 'ext/pg_connection.c', line 3556

static VALUE
pgconn_lounlink(VALUE self, VALUE in_oid)
{
  PGconn *conn = pg_get_pgconn(self);
  Oid oid = NUM2UINT(in_oid);

  if(lo_unlink(conn,oid) < 0)
    rb_raise(rb_ePGerror,"lo_unlink failed");

  return Qnil;
}

#lo_write(lo_desc, buffer) ⇒ Integer Also known as: lowrite

Writes the string buffer to the large object lo_desc. Returns the number of bytes written.

Returns:

  • (Integer) 


3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
 
# File 'ext/pg_connection.c', line 3412

static VALUE
pgconn_lowrite(VALUE self, VALUE in_lo_desc, VALUE buffer)
{
  int n;
  PGconn *conn = pg_get_pgconn(self);
  int fd = NUM2INT(in_lo_desc);

  Check_Type(buffer, T_STRING);

  if( RSTRING_LEN(buffer) < 0) {
    rb_raise(rb_ePGerror, "write buffer zero string");
  }
  if((n = lo_write(conn, fd, StringValuePtr(buffer),
        RSTRING_LEN(buffer))) < 0) {
    rb_raise(rb_ePGerror, "lo_write failed: %s", PQerrorMessage(conn));
  }

  return INT2FIX(n);
}

#make_empty_pgresult(status) ⇒ PG::Result

Constructs and empty PG::Result with status status. status may be one of:

  • PGRES_EMPTY_QUERY

  • PGRES_COMMAND_OK

  • PGRES_TUPLES_OK

  • PGRES_COPY_OUT

  • PGRES_COPY_IN

  • PGRES_BAD_RESPONSE

  • PGRES_NONFATAL_ERROR

  • PGRES_FATAL_ERROR

  • PGRES_COPY_BOTH

Returns:



1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
 
# File 'ext/pg_connection.c', line 1509

static VALUE
pgconn_make_empty_pgresult(VALUE self, VALUE status)
{
  PGresult *result;
  VALUE rb_pgresult;
  PGconn *conn = pg_get_pgconn(self);
  result = PQmakeEmptyPGresult(conn, NUM2INT(status));
  rb_pgresult = pg_new_result(result, self);
  pg_result_check(rb_pgresult);
  return rb_pgresult;
}

#notifies ⇒ Object

Returns a hash of the unprocessed notifications. If there is no unprocessed notifier, it returns nil.



2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
 
# File 'ext/pg_connection.c', line 2237

static VALUE
pgconn_notifies(VALUE self)
{
  PGconn* conn = pg_get_pgconn(self);
  PGnotify *notification;
  VALUE hash;
  VALUE sym_relname, sym_be_pid, sym_extra;
  VALUE relname, be_pid, extra;

  sym_relname = ID2SYM(rb_intern("relname"));
  sym_be_pid = ID2SYM(rb_intern("be_pid"));
  sym_extra = ID2SYM(rb_intern("extra"));

  notification = gvl_PQnotifies(conn);
  if (notification == NULL) {
    return Qnil;
  }

  hash = rb_hash_new();
  relname = rb_tainted_str_new2(notification->relname);
  be_pid = INT2NUM(notification->be_pid);
  extra = rb_tainted_str_new2(notification->extra);
  PG_ENCODING_SET_NOCHECK( relname, ENCODING_GET(self) );
  PG_ENCODING_SET_NOCHECK( extra, ENCODING_GET(self) );

  rb_hash_aset(hash, sym_relname, relname);
  rb_hash_aset(hash, sym_be_pid, be_pid);
  rb_hash_aset(hash, sym_extra, extra);

  PQfreemem(notification);
  return hash;
}

#options ⇒ Object

Returns backend option string.



673
674
675
676
677
678
679
 
# File 'ext/pg_connection.c', line 673

static VALUE
pgconn_options(VALUE self)
{
  char *options = PQoptions(pg_get_pgconn(self));
  if (!options) return Qnil;
  return rb_tainted_str_new2(options);
}

#parameter_status(param_name) ⇒ String

Returns the setting of parameter param_name, where param_name is one of

  • server_version

  • server_encoding

  • client_encoding

  • is_superuser

  • session_authorization

  • DateStyle

  • TimeZone

  • integer_datetimes

  • standard_conforming_strings

Returns nil if the value of the parameter is not known.

Returns:

  • (String) 


751
752
753
754
755
756
757
758
759
 
# File 'ext/pg_connection.c', line 751

static VALUE
pgconn_parameter_status(VALUE self, VALUE param_name)
{
  const char *ret = PQparameterStatus(pg_get_pgconn(self), StringValueCStr(param_name));
  if(ret == NULL)
    return Qnil;
  else
    return rb_tainted_str_new2(ret);
}

#pass ⇒ Object

Returns the authenticated user name.



618
619
620
621
622
623
624
 
# File 'ext/pg_connection.c', line 618

static VALUE
pgconn_pass(VALUE self)
{
  char *user = PQpass(pg_get_pgconn(self));
  if (!user) return Qnil;
  return rb_tainted_str_new2(user);
}

#port ⇒ Object

Returns the connected server port number.



646
647
648
649
650
651
 
# File 'ext/pg_connection.c', line 646

static VALUE
pgconn_port(VALUE self)
{
  char* port = PQport(pg_get_pgconn(self));
  return INT2NUM(atol(port));
}

#prepare(stmt_name, sql[, param_types ]) ⇒ PG::Result

Prepares statement sql with name name to be executed later. Returns a PG::Result instance on success. On failure, it raises a PG::Error.

param_types is an optional parameter to specify the Oids of the types of the parameters.

If the types are not specified, they will be inferred by PostgreSQL. Instead of specifying type oids, it’s recommended to simply add explicit casts in the query to ensure that the right type is used.

For example: “SELECT $1::int”

PostgreSQL bind parameters are represented as $1, $1, $2, etc., inside the SQL query.

Returns:



1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
 
# File 'ext/pg_connection.c', line 1327

static VALUE
pgconn_prepare(int argc, VALUE *argv, VALUE self)
{
  PGconn *conn = pg_get_pgconn(self);
  PGresult *result = NULL;
  VALUE rb_pgresult;
  VALUE name, command, in_paramtypes;
  VALUE param;
  int i = 0;
  int nParams = 0;
  Oid *paramTypes = NULL;
  const char *name_cstr;
  const char *command_cstr;
  int enc_idx = ENCODING_GET(self);

  rb_scan_args(argc, argv, "21", &name, &command, &in_paramtypes);
  name_cstr = pg_cstr_enc(name, enc_idx);
  command_cstr = pg_cstr_enc(command, enc_idx);

  if(! NIL_P(in_paramtypes)) {
    Check_Type(in_paramtypes, T_ARRAY);
    nParams = (int)RARRAY_LEN(in_paramtypes);
    paramTypes = ALLOC_N(Oid, nParams);
    for(i = 0; i < nParams; i++) {
      param = rb_ary_entry(in_paramtypes, i);
      if(param == Qnil)
        paramTypes[i] = 0;
      else
        paramTypes[i] = NUM2UINT(param);
    }
  }
  result = gvl_PQprepare(conn, name_cstr, command_cstr, nParams, paramTypes);

  xfree(paramTypes);

  rb_pgresult = pg_new_result(result, self);
  pg_result_check(rb_pgresult);
  return rb_pgresult;
}

#protocol_version ⇒ Integer

The 3.0 protocol will normally be used when communicating with PostgreSQL 7.4 or later servers; pre-7.4 servers support only protocol 2.0. (Protocol 1.0 is obsolete and not supported by libpq.)

Returns:

  • (Integer) 


769
770
771
772
773
 
# File 'ext/pg_connection.c', line 769

static VALUE
pgconn_protocol_version(VALUE self)
{
  return INT2NUM(PQprotocolVersion(pg_get_pgconn(self)));
}

#put_copy_data(buffer[, encoder]) ⇒ Boolean

Transmits buffer as copy data to the server. Returns true if the data was sent, false if it was not sent (false is only possible if the connection is in nonblocking mode, and this command would block).

encoder can be a PG::Coder derivation (typically PG::TextEncoder::CopyRow). This encodes the received data fields from an Array of Strings. Optionally the encoder can type cast the fields form various Ruby types in one step, if PG::TextEncoder::CopyRow#type_map is set accordingly.

Raises an exception if an error occurs.

See also #copy_data.

Returns:

  • (Boolean) 


2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
 
# File 'ext/pg_connection.c', line 2565

static VALUE
pgconn_put_copy_data(int argc, VALUE *argv, VALUE self)
{
  int ret;
  int len;
  t_pg_connection *this = pg_get_connection_safe( self );
  VALUE value;
  VALUE buffer = Qnil;
  VALUE encoder;
  VALUE intermediate;
  t_pg_coder *p_coder = NULL;

  rb_scan_args( argc, argv, "11", &value, &encoder );

  if( NIL_P(encoder) ){
    if( NIL_P(this->encoder_for_put_copy_data) ){
      buffer = value;
    } else {
      p_coder = DATA_PTR( this->encoder_for_put_copy_data );
    }
  } else if( rb_obj_is_kind_of(encoder, rb_cPG_Coder) ) {
    Data_Get_Struct( encoder, t_pg_coder, p_coder );
  } else {
    rb_raise( rb_eTypeError, "wrong encoder type %s (expected some kind of PG::Coder)",
        rb_obj_classname( encoder ) );
  }

  if( p_coder ){
    t_pg_coder_enc_func enc_func;
    int enc_idx = ENCODING_GET(self);

    enc_func = pg_coder_enc_func( p_coder );
    len = enc_func( p_coder, value, NULL, &intermediate, enc_idx);

    if( len == -1 ){
      /* The intermediate value is a String that can be used directly. */
      buffer = intermediate;
    } else {
      buffer = rb_str_new(NULL, len);
      len = enc_func( p_coder, value, RSTRING_PTR(buffer), &intermediate, enc_idx);
      rb_str_set_len( buffer, len );
    }
  }

  Check_Type(buffer, T_STRING);

  ret = gvl_PQputCopyData(this->pgconn, RSTRING_PTR(buffer), RSTRING_LENINT(buffer));
  if(ret == -1) {
    VALUE error = rb_exc_new2(rb_ePGerror, PQerrorMessage(this->pgconn));
    rb_iv_set(error, "@connection", self);
    rb_exc_raise(error);
  }
  RB_GC_GUARD(intermediate);
  RB_GC_GUARD(buffer);

  return (ret) ? Qtrue : Qfalse;
}

#put_copy_end([ error_message ]) ⇒ Boolean

Sends end-of-data indication to the server.

error_message is an optional parameter, and if set, forces the COPY command to fail with the string error_message.

Returns true if the end-of-data was sent, false if it was not sent (false is only possible if the connection is in nonblocking mode, and this command would block).

Returns:

  • (Boolean) 


2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
 
# File 'ext/pg_connection.c', line 2637

static VALUE
pgconn_put_copy_end(int argc, VALUE *argv, VALUE self)
{
  VALUE str;
  VALUE error;
  int ret;
  const char *error_message = NULL;
  PGconn *conn = pg_get_pgconn(self);

  if (rb_scan_args(argc, argv, "01", &str) == 0)
    error_message = NULL;
  else
    error_message = pg_cstr_enc(str, ENCODING_GET(self));

  ret = gvl_PQputCopyEnd(conn, error_message);
  if(ret == -1) {
    error = rb_exc_new2(rb_ePGerror, PQerrorMessage(conn));
    rb_iv_set(error, "@connection", self);
    rb_exc_raise(error);
  }
  return (ret) ? Qtrue : Qfalse;
}

#quote_ident(str) ⇒ String #quote_ident(array) ⇒ String #PG::Connection.quote_ident(str) ⇒ String #PG::Connection.quote_ident(array) ⇒ String

Returns a string that is safe for inclusion in a SQL query as an identifier. Note: this is not a quote function for values, but for identifiers.

For example, in a typical SQL query: SELECT FOO FROM MYTABLE The identifier FOO is folded to lower case, so it actually means foo. If you really want to access the case-sensitive field name FOO, use this function like conn.quote_ident('FOO'), which will return "FOO" (with double-quotes). PostgreSQL will see the double-quotes, and it will not fold to lower case.

Similarly, this function also protects against special characters, and other things that might allow SQL injection if the identifier comes from an untrusted source.

If the parameter is an Array, then all it’s values are separately quoted and then joined by a “.” character. This can be used for identifiers in the form “schema”.“table”.“column” .

This method is functional identical to the encoder PG::TextEncoder::Identifier .

If the instance method form is used and the input string character encoding is different to the connection encoding, then the string is converted to this encoding, so that the returned string is always encoded as PG::Connection#internal_encoding .

In the singleton form (PG::Connection.quote_ident) the character encoding of the result string is set to the character encoding of the input string.

Overloads:

  • #quote_ident(str) ⇒ String

    Returns:

    • (String)
  • #quote_ident(array) ⇒ String

    Returns:

    • (String)
  • #PG::Connection.quote_ident(str) ⇒ String

    Returns:

    • (String)
  • #PG::Connection.quote_ident(array) ⇒ String

    Returns:

    • (String) 


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
 
# File 'ext/pg_connection.c', line 3060

static VALUE
pgconn_s_quote_ident(VALUE self, VALUE str_or_array)
{
  VALUE ret;
  int enc_idx;

  if( rb_obj_is_kind_of(self, rb_cPGconn) ){
    enc_idx = ENCODING_GET( self );
  }else{
    enc_idx = RB_TYPE_P(str_or_array, T_STRING) ? ENCODING_GET( str_or_array ) : rb_ascii8bit_encindex();
  }
  pg_text_enc_identifier(NULL, str_or_array, NULL, &ret, enc_idx);

  OBJ_INFECT(ret, str_or_array);

  return ret;
}

#reset ⇒ Object

Resets the backend connection. This method closes the backend connection and tries to re-connect.



540
541
542
543
544
545
546
 
# File 'ext/pg_connection.c', line 540

static VALUE
pgconn_reset( VALUE self )
{
  pgconn_close_socket_io( self );
  gvl_PQreset( pg_get_pgconn(self) );
  return self;
}

#reset_poll ⇒ Integer

Checks the status of a connection reset operation. See #connect_start and #connect_poll for usage information and return values.

Returns:

  • (Integer) 


575
576
577
578
579
580
581
 
# File 'ext/pg_connection.c', line 575

static VALUE
pgconn_reset_poll(VALUE self)
{
  PostgresPollingStatusType status;
  status = gvl_PQresetPoll(pg_get_pgconn(self));
  return INT2FIX((int)status);
}

#reset_start ⇒ nil

Initiate a connection reset in a nonblocking manner. This will close the current connection and attempt to reconnect using the same connection parameters. Use #reset_poll to check the status of the connection reset.

Returns:

  • (nil) 


558
559
560
561
562
563
564
565
 
# File 'ext/pg_connection.c', line 558

static VALUE
pgconn_reset_start(VALUE self)
{
  pgconn_close_socket_io( self );
  if(gvl_PQresetStart(pg_get_pgconn(self)) == 0)
    rb_raise(rb_eUnableToSend, "reset has failed");
  return Qnil;
}

#send_describe_portal(portal_name) ⇒ nil

Asynchronously send command to the server. Does not block. Use in combination with conn.get_result.

Returns:

  • (nil) 


2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
 
# File 'ext/pg_connection.c', line 2028

static VALUE
pgconn_send_describe_portal(VALUE self, VALUE portal)
{
  VALUE error;
  PGconn *conn = pg_get_pgconn(self);
  /* returns 0 on failure */
  if(gvl_PQsendDescribePortal(conn, pg_cstr_enc(portal, ENCODING_GET(self))) == 0) {
    error = rb_exc_new2(rb_eUnableToSend, PQerrorMessage(conn));
    rb_iv_set(error, "@connection", self);
    rb_exc_raise(error);
  }
  return Qnil;
}

#send_describe_prepared(statement_name) ⇒ nil

Asynchronously send command to the server. Does not block. Use in combination with conn.get_result.

Returns:

  • (nil) 


2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
 
# File 'ext/pg_connection.c', line 2006

static VALUE
pgconn_send_describe_prepared(VALUE self, VALUE stmt_name)
{
  VALUE error;
  PGconn *conn = pg_get_pgconn(self);
  /* returns 0 on failure */
  if(gvl_PQsendDescribePrepared(conn, pg_cstr_enc(stmt_name, ENCODING_GET(self))) == 0) {
    error = rb_exc_new2(rb_eUnableToSend, PQerrorMessage(conn));
    rb_iv_set(error, "@connection", self);
    rb_exc_raise(error);
  }
  return Qnil;
}

#send_prepare(stmt_name, sql[, param_types ]) ⇒ nil

Prepares statement sql with name name to be executed later. Sends prepare command asynchronously, and returns immediately. On failure, it raises a PG::Error.

param_types is an optional parameter to specify the Oids of the types of the parameters.

If the types are not specified, they will be inferred by PostgreSQL. Instead of specifying type oids, it’s recommended to simply add explicit casts in the query to ensure that the right type is used.

For example: “SELECT $1::int”

PostgreSQL bind parameters are represented as $1, $1, $2, etc., inside the SQL query.

Returns:

  • (nil) 


1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
 
# File 'ext/pg_connection.c', line 1887

static VALUE
pgconn_send_prepare(int argc, VALUE *argv, VALUE self)
{
  PGconn *conn = pg_get_pgconn(self);
  int result;
  VALUE name, command, in_paramtypes;
  VALUE param;
  VALUE error;
  int i = 0;
  int nParams = 0;
  Oid *paramTypes = NULL;
  const char *name_cstr;
  const char *command_cstr;
  int enc_idx = ENCODING_GET(self);

  rb_scan_args(argc, argv, "21", &name, &command, &in_paramtypes);
  name_cstr = pg_cstr_enc(name, enc_idx);
  command_cstr = pg_cstr_enc(command, enc_idx);

  if(! NIL_P(in_paramtypes)) {
    Check_Type(in_paramtypes, T_ARRAY);
    nParams = (int)RARRAY_LEN(in_paramtypes);
    paramTypes = ALLOC_N(Oid, nParams);
    for(i = 0; i < nParams; i++) {
      param = rb_ary_entry(in_paramtypes, i);
      if(param == Qnil)
        paramTypes[i] = 0;
      else
        paramTypes[i] = NUM2UINT(param);
    }
  }
  result = gvl_PQsendPrepare(conn, name_cstr, command_cstr, nParams, paramTypes);

  xfree(paramTypes);

  if(result == 0) {
    error = rb_exc_new2(rb_eUnableToSend, PQerrorMessage(conn));
    rb_iv_set(error, "@connection", self);
    rb_exc_raise(error);
  }
  return Qnil;
}

#send_query(sql[, params, result_format[, type_map ]]) ⇒ nil

Sends SQL query request specified by sql to PostgreSQL for asynchronous processing, and immediately returns. On failure, it raises a PG::Error.

params is an optional array of the bind parameters for the SQL query. Each element of the params array may be either:

a hash of the form:
  {:value  => String (value of bind parameter)
   :type   => Integer (oid of type of bind parameter)
   :format => Integer (0 for text, 1 for binary)
  }
or, it may be a String. If it is a string, that is equivalent to the hash:
  { :value => <string value>, :type => 0, :format => 0 }

PostgreSQL bind parameters are represented as $1, $1, $2, etc., inside the SQL query. The 0th element of the params array is bound to $1, the 1st element is bound to $2, etc. nil is treated as NULL.

If the types are not specified, they will be inferred by PostgreSQL. Instead of specifying type oids, it’s recommended to simply add explicit casts in the query to ensure that the right type is used.

For example: “SELECT $1::int”

The optional result_format should be 0 for text results, 1 for binary.

type_map can be a PG::TypeMap derivation (such as PG::BasicTypeMapForQueries). This will type cast the params form various Ruby types before transmission based on the encoders defined by the type map. When a type encoder is used the format and oid of a given bind parameter are retrieved from the encoder instead out of the hash form described above.

Returns:

  • (nil) 


1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'ext/pg_connection.c', line 1822

static VALUE
pgconn_send_query(int argc, VALUE *argv, VALUE self)
{
  PGconn *conn = pg_get_pgconn(self);
  int result;
  VALUE command, in_res_fmt;
  VALUE error;
  int nParams;
  int resultFormat;
  struct query_params_data paramsData = { ENCODING_GET(self) };

  rb_scan_args(argc, argv, "13", &command, &paramsData.params, &in_res_fmt, &paramsData.typemap);
  paramsData.with_types = 1;

  /* If called with no parameters, use PQsendQuery */
  if(NIL_P(paramsData.params)) {
    if(gvl_PQsendQuery(conn, pg_cstr_enc(command, paramsData.enc_idx)) == 0) {
      error = rb_exc_new2(rb_eUnableToSend, PQerrorMessage(conn));
      rb_iv_set(error, "@connection", self);
      rb_exc_raise(error);
    }
    return Qnil;
  }

  /* If called with parameters, and optionally result_format,
   * use PQsendQueryParams
   */

  pgconn_query_assign_typemap( self, &paramsData );
  resultFormat = NIL_P(in_res_fmt) ? 0 : NUM2INT(in_res_fmt);
  nParams = alloc_query_params( &paramsData );

  result = gvl_PQsendQueryParams(conn, pg_cstr_enc(command, paramsData.enc_idx), nParams, paramsData.types,
    (const char * const *)paramsData.values, paramsData.lengths, paramsData.formats, resultFormat);

  free_query_params( &paramsData );

  if(result == 0) {
    error = rb_exc_new2(rb_eUnableToSend, PQerrorMessage(conn));
    rb_iv_set(error, "@connection", self);
    rb_exc_raise(error);
  }
  return Qnil;
}

#send_query_prepared(statement_name[, params, result_format[, type_map ]]) ⇒ Object #- ⇒ Object

Execute prepared named statement specified by statement_name asynchronously, and returns immediately. On failure, it raises a PG::Error.

params is an array of the optional bind parameters for the SQL query. Each element of the params array may be either:

a hash of the form:
  {:value  => String (value of bind parameter)
   :format => Integer (0 for text, 1 for binary)
  }
or, it may be a String. If it is a string, that is equivalent to the hash:
  { :value => <string value>, :format => 0 }

PostgreSQL bind parameters are represented as $1, $1, $2, etc., inside the SQL query. The 0th element of the params array is bound to $1, the 1st element is bound to $2, etc. nil is treated as NULL.

The optional result_format should be 0 for text results, 1 for binary.

type_map can be a PG::TypeMap derivation (such as PG::BasicTypeMapForQueries). This will type cast the params form various Ruby types before transmission based on the encoders defined by the type map. When a type encoder is used the format and oid of a given bind parameter are retrieved from the encoder instead out of the hash form described above.



1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
 
# File 'ext/pg_connection.c', line 1962

static VALUE
pgconn_send_query_prepared(int argc, VALUE *argv, VALUE self)
{
  PGconn *conn = pg_get_pgconn(self);
  int result;
  VALUE name, in_res_fmt;
  VALUE error;
  int nParams;
  int resultFormat;
  struct query_params_data paramsData = { ENCODING_GET(self) };

  rb_scan_args(argc, argv, "13", &name, &paramsData.params, &in_res_fmt, &paramsData.typemap);
  paramsData.with_types = 0;

  if(NIL_P(paramsData.params)) {
    paramsData.params = rb_ary_new2(0);
    resultFormat = 0;
  }
  pgconn_query_assign_typemap( self, &paramsData );

  resultFormat = NIL_P(in_res_fmt) ? 0 : NUM2INT(in_res_fmt);
  nParams = alloc_query_params( &paramsData );

  result = gvl_PQsendQueryPrepared(conn, pg_cstr_enc(name, paramsData.enc_idx), nParams,
    (const char * const *)paramsData.values, paramsData.lengths, paramsData.formats,
    resultFormat);

  free_query_params( &paramsData );

  if(result == 0) {
    error = rb_exc_new2(rb_eUnableToSend, PQerrorMessage(conn));
    rb_iv_set(error, "@connection", self);
    rb_exc_raise(error);
  }
  return Qnil;
}

#server_version ⇒ Integer

The number is formed by converting the major, minor, and revision numbers into two-decimal-digit numbers and appending them together. For example, version 7.4.2 will be returned as 70402, and version 8.1 will be returned as 80100 (leading zeroes are not shown). Zero is returned if the connection is bad.

Returns:

  • (Integer) 


786
787
788
789
790
 
# File 'ext/pg_connection.c', line 786

static VALUE
pgconn_server_version(VALUE self)
{
  return INT2NUM(PQserverVersion(pg_get_pgconn(self)));
}

#set_client_encoding(encoding) ⇒ Object Also known as: client_encoding=

Sets the client encoding to the encoding String.



2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
 
# File 'ext/pg_connection.c', line 2963

static VALUE
pgconn_set_client_encoding(VALUE self, VALUE str)
{
  PGconn *conn = pg_get_pgconn( self );

  Check_Type(str, T_STRING);

  if ( (gvl_PQsetClientEncoding(conn, StringValueCStr(str))) == -1 ) {
    rb_raise(rb_ePGerror, "invalid encoding name: %s",StringValueCStr(str));
  }
#ifdef M17N_SUPPORTED
  pgconn_set_internal_encoding_index( self );
#endif

  return Qnil;
}

#set_default_encoding ⇒ Encoding

If Ruby has its Encoding.default_internal set, set PostgreSQL’s client_encoding to match. Returns the new Encoding, or nil if the default internal encoding wasn’t set.

Returns:

  • (Encoding) 


3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
 
# File 'ext/pg_connection.c', line 3711

static VALUE
pgconn_set_default_encoding( VALUE self )
{
  PGconn *conn = pg_get_pgconn( self );
  rb_encoding *enc;
  const char *encname;

  if (( enc = rb_default_internal_encoding() )) {
    encname = pg_get_rb_encoding_as_pg_encoding( enc );
    if ( pgconn_set_client_encoding_async(self, encname) != 0 )
      rb_warn( "Failed to set the default_internal encoding to %s: '%s'",
               encname, PQerrorMessage(conn) );
    pgconn_set_internal_encoding_index( self );
    return rb_enc_from_encoding( enc );
  } else {
    pgconn_set_internal_encoding_index( self );
    return Qnil;
  }
}

#set_error_verbosity(verbosity) ⇒ Integer

Sets connection’s verbosity to verbosity and returns the previous setting. Available settings are:

  • PQERRORS_TERSE

  • PQERRORS_DEFAULT

  • PQERRORS_VERBOSE

Returns:

  • (Integer) 


2735
2736
2737
2738
2739
2740
2741
 
# File 'ext/pg_connection.c', line 2735

static VALUE
pgconn_set_error_verbosity(VALUE self, VALUE in_verbosity)
{
  PGconn *conn = pg_get_pgconn(self);
  PGVerbosity verbosity = NUM2INT(in_verbosity);
  return INT2FIX(PQsetErrorVerbosity(conn, verbosity));
}

#set_notice_processor {|message| ... } ⇒ Proc

See #set_notice_receiver for the desription of what this and the notice_processor methods do.

This function takes a new block to act as the notice processor and returns the Proc object previously set, or nil if it was previously the default. The block should accept a single String object.

If you pass no arguments, it will reset the handler to the default.

Yields:

  • (message)

Returns:

  • (Proc) 


2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
 
# File 'ext/pg_connection.c', line 2914

static VALUE
pgconn_set_notice_processor(VALUE self)
{
  VALUE proc, old_proc;
  t_pg_connection *this = pg_get_connection_safe( self );

  /* If default_notice_processor is unset, assume that the current
   * notice processor is the default, and save it to a global variable.
   * This should not be a problem because the default processor is
   * always the same, so won't vary among connections.
   */
  if(default_notice_processor == NULL)
    default_notice_processor = PQsetNoticeProcessor(this->pgconn, NULL, NULL);

  old_proc = this->notice_receiver;
  if( rb_block_given_p() ) {
    proc = rb_block_proc();
    PQsetNoticeProcessor(this->pgconn, gvl_notice_processor_proxy, (void *)self);
  } else {
    /* if no block is given, set back to default */
    proc = Qnil;
    PQsetNoticeProcessor(this->pgconn, default_notice_processor, NULL);
  }

  this->notice_receiver = proc;
  return old_proc;
}

#set_notice_receiver {|result| ... } ⇒ Proc

Notice and warning messages generated by the server are not returned by the query execution functions, since they do not imply failure of the query. Instead they are passed to a notice handling function, and execution continues normally after the handler returns. The default notice handling function prints the message on stderr, but the application can override this behavior by supplying its own handling function.

For historical reasons, there are two levels of notice handling, called the notice receiver and notice processor. The default behavior is for the notice receiver to format the notice and pass a string to the notice processor for printing. However, an application that chooses to provide its own notice receiver will typically ignore the notice processor layer and just do all the work in the notice receiver.

This function takes a new block to act as the handler, which should accept a single parameter that will be a PG::Result object, and returns the Proc object previously set, or nil if it was previously the default.

If you pass no arguments, it will reset the handler to the default.

Note: The result passed to the block should not be used outside of the block, since the corresponding C object could be freed after the block finishes.

Yields:

  • (result)

Returns:

  • (Proc) 


2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
 
# File 'ext/pg_connection.c', line 2854

static VALUE
pgconn_set_notice_receiver(VALUE self)
{
  VALUE proc, old_proc;
  t_pg_connection *this = pg_get_connection_safe( self );

  /* If default_notice_receiver is unset, assume that the current
   * notice receiver is the default, and save it to a global variable.
   * This should not be a problem because the default receiver is
   * always the same, so won't vary among connections.
   */
  if(default_notice_receiver == NULL)
    default_notice_receiver = PQsetNoticeReceiver(this->pgconn, NULL, NULL);

  old_proc = this->notice_receiver;
  if( rb_block_given_p() ) {
    proc = rb_block_proc();
    PQsetNoticeReceiver(this->pgconn, gvl_notice_receiver_proxy, (void *)self);
  } else {
    /* if no block is given, set back to default */
    proc = Qnil;
    PQsetNoticeReceiver(this->pgconn, default_notice_receiver, NULL);
  }

  this->notice_receiver = proc;
  return old_proc;
}

#set_single_row_mode ⇒ self

To enter single-row mode, call this method immediately after a successful call of send_query (or a sibling function). This mode selection is effective only for the currently executing query. Then call Connection#get_result repeatedly, until it returns nil.

Each (but the last) received Result has exactly one row and a Result#result_status of PGRES_SINGLE_TUPLE. The last Result has zero rows and is used to indicate a successful execution of the query. All of these Result objects will contain the same row description data (column names, types, etc) that an ordinary Result object for the query would have.

Caution: While processing a query, the server may return some rows and then encounter an error, causing the query to be aborted. Ordinarily, pg discards any such rows and reports only the error. But in single-row mode, those rows will have already been returned to the application. Hence, the application will see some Result objects followed by an Error raised in get_result. For proper transactional behavior, the application must be designed to discard or undo whatever has been done with the previously-processed rows, if the query ultimately fails.

Example:

conn.send_query( "your SQL command" )
conn.set_single_row_mode
loop do
  res = conn.get_result or break
  res.check
  res.each do |row|
    # do something with the received row
  end
end

Returns:

  • (self) 


1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
 
# File 'ext/pg_connection.c', line 1767

static VALUE
pgconn_set_single_row_mode(VALUE self)
{
  PGconn *conn = pg_get_pgconn(self);
  VALUE error;

  if( PQsetSingleRowMode(conn) == 0 )
  {
    error = rb_exc_new2(rb_ePGerror, PQerrorMessage(conn));
    rb_iv_set(error, "@connection", self);
    rb_exc_raise(error);
  }

  return self;
}

#setnonblocking(Boolean) ⇒ nil

Sets the nonblocking status of the connection. In the blocking state, calls to #send_query will block until the message is sent to the server, but will not wait for the query results. In the nonblocking state, calls to #send_query will return an error if the socket is not ready for writing. Note: This function does not affect #exec, because that function doesn’t return until the server has processed the query and returned the results. Returns nil.

Returns:

  • (nil) 


2130
2131
2132
 
# File 'ext/pg_connection.c', line 2130

static VALUE
pgconn_setnonblocking(self, state)
VALUE self, state;

#socket ⇒ Integer

Returns the socket’s file descriptor for this connection. IO.for_fd() can be used to build a proper IO object to the socket. If you do so, you will likely also want to set autoclose=false on it to prevent Ruby from closing the socket to PostgreSQL if it goes out of scope. Alternatively, you can use #socket_io, which creates an IO that’s associated with the connection object itself, and so won’t go out of scope until the connection does.

Note: On Windows the file descriptor is not really usable, since it can not be used to build a Ruby IO object.

Returns:

  • (Integer) 


821
822
823
824
825
826
827
828
 
# File 'ext/pg_connection.c', line 821

static VALUE
pgconn_socket(VALUE self)
{
  int sd;
  if( (sd = PQsocket(pg_get_pgconn(self))) < 0)
    rb_raise(rb_eConnectionBad, "PQsocket() can't get socket descriptor");
  return INT2NUM(sd);
}

#socket_io ⇒ Object

Fetch a memoized IO object created from the Connection’s underlying socket. This object can be used for IO.select to wait for events while running asynchronous API calls.

Using this instead of #socket avoids the problem of the underlying connection being closed by Ruby when an IO created using IO.for_fd(conn.socket) goes out of scope.

This method can also be used on Windows but requires Ruby-2.0+.



847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
 
# File 'ext/pg_connection.c', line 847

static VALUE
pgconn_socket_io(VALUE self)
{
  int sd;
  int ruby_sd;
  ID id_autoclose = rb_intern("autoclose=");
  t_pg_connection *this = pg_get_connection_safe( self );
  VALUE socket_io = this->socket_io;

  if ( !RTEST(socket_io) ) {
    if( (sd = PQsocket(this->pgconn)) < 0)
      rb_raise(rb_eConnectionBad, "PQsocket() can't get socket descriptor");

    #ifdef _WIN32
      ruby_sd = rb_w32_wrap_io_handle((HANDLE)(intptr_t)sd, O_RDWR|O_BINARY|O_NOINHERIT);
    #else
      ruby_sd = sd;
    #endif

    socket_io = rb_funcall( rb_cIO, rb_intern("for_fd"), 1, INT2NUM(ruby_sd) );

    /* Disable autoclose feature, when supported */
    if( rb_respond_to(socket_io, id_autoclose) ){
      rb_funcall( socket_io, id_autoclose, 1, Qfalse );
    }

    this->socket_io = socket_io;
  }

  return socket_io;
}

#ssl_attribute(attribute_name) ⇒ String

Returns SSL-related information about the connection.

The list of available attributes varies depending on the SSL library being used, and the type of connection. If an attribute is not available, returns nil.

The following attributes are commonly available:

library

Name of the SSL implementation in use. (Currently, only “OpenSSL” is implemented)

protocol

SSL/TLS version in use. Common values are “SSLv2”, “SSLv3”, “TLSv1”, “TLSv1.1” and “TLSv1.2”, but an implementation may return other strings if some other protocol is used.

key_bits

Number of key bits used by the encryption algorithm.

cipher

A short name of the ciphersuite used, e.g. “DHE-RSA-DES-CBC3-SHA”. The names are specific to each SSL implementation.

compression

If SSL compression is in use, returns the name of the compression algorithm, or “on” if compression is used but the algorithm is not known. If compression is not in use, returns “off”.

See also #ssl_attribute_names and www.postgresql.org/docs/current/interactive/libpq-status.html#LIBPQ-PQSSLATTRIBUTE

Returns:

  • (String) 


3242
3243
3244
3245
3246
3247
3248
3249
 
# File 'ext/pg_connection.c', line 3242

static VALUE
pgconn_ssl_attribute(VALUE self, VALUE attribute_name)
{
  const char *p_attr;

  p_attr = PQsslAttribute(pg_get_pgconn(self), StringValueCStr(attribute_name));
  return p_attr ? rb_str_new_cstr(p_attr) : Qnil;
}

#ssl_attribute_names ⇒ Array<String>

Return an array of SSL attribute names available.

See also #ssl_attribute

Returns:

  • (Array<String>) 


3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
 
# File 'ext/pg_connection.c', line 3260

static VALUE
pgconn_ssl_attribute_names(VALUE self)
{
  int i;
  const char * const * p_list = PQsslAttributeNames(pg_get_pgconn(self));
  VALUE ary = rb_ary_new();

  for ( i = 0; p_list[i]; i++ ) {
    rb_ary_push( ary, rb_str_new_cstr( p_list[i] ));
  }
  return ary;
}

#ssl_attributes ⇒ Object

call-seq:

conn.ssl_attributes -> Hash<String,String>

Returns SSL-related information about the connection as key/value pairs

The available attributes varies depending on the SSL library being used, and the type of connection.

See also #ssl_attribute



259
260
261
262
263
 
# File 'lib/pg/connection.rb', line 259

def ssl_attributes
  ssl_attribute_names.each.with_object({}) do |n,h|
    h[n] = ssl_attribute(n)
  end
end

#ssl_in_use? ⇒ Boolean

Returns true if the connection uses SSL, false if not.

Returns:

  • (Boolean) 


3210
3211
3212
3213
3214
 
# File 'ext/pg_connection.c', line 3210

static VALUE
pgconn_ssl_in_use(VALUE self)
{
  return PQsslInUse(pg_get_pgconn(self)) ? Qtrue : Qfalse;
}

#status ⇒ Object

Returns status of connection : CONNECTION_OK or CONNECTION_BAD



710
711
712
713
714
 
# File 'ext/pg_connection.c', line 710

static VALUE
pgconn_status(VALUE self)
{
  return INT2NUM(PQstatus(pg_get_pgconn(self)));
}

#trace(stream) ⇒ nil

Enables tracing message passing between backend. The trace message will be written to the stream stream, which must implement a method fileno that returns a writable file descriptor.

Returns:

  • (nil) 


2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
 
# File 'ext/pg_connection.c', line 2752

static VALUE
pgconn_trace(VALUE self, VALUE stream)
{
  VALUE fileno;
  FILE *new_fp;
  int old_fd, new_fd;
  VALUE new_file;
  t_pg_connection *this = pg_get_connection_safe( self );

  if(rb_respond_to(stream,rb_intern("fileno")) == Qfalse)
    rb_raise(rb_eArgError, "stream does not respond to method: fileno");

  fileno = rb_funcall(stream, rb_intern("fileno"), 0);
  if(fileno == Qnil)
    rb_raise(rb_eArgError, "can't get file descriptor from stream");

  /* Duplicate the file descriptor and re-open
   * it. Then, make it into a ruby File object
   * and assign it to an instance variable.
   * This prevents a problem when the File
   * object passed to this function is closed
   * before the connection object is. */
  old_fd = NUM2INT(fileno);
  new_fd = dup(old_fd);
  new_fp = fdopen(new_fd, "w");

  if(new_fp == NULL)
    rb_raise(rb_eArgError, "stream is not writable");

  new_file = rb_funcall(rb_cIO, rb_intern("new"), 1, INT2NUM(new_fd));
  this->trace_stream = new_file;

  PQtrace(this->pgconn, new_fp);
  return Qnil;
}

#transaction {|conn| ... } ⇒ Object

Executes a BEGIN at the start of the block, and a COMMIT at the end of the block, or ROLLBACK if any exception occurs.

Yields:

  • (conn) 


2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
 
# File 'ext/pg_connection.c', line 2988

static VALUE
pgconn_transaction(VALUE self)
{
  PGconn *conn = pg_get_pgconn(self);
  PGresult *result;
  VALUE rb_pgresult;
  VALUE block_result = Qnil;
  int status;

  if (rb_block_given_p()) {
    result = gvl_PQexec(conn, "BEGIN");
    rb_pgresult = pg_new_result(result, self);
    pg_result_check(rb_pgresult);
    block_result = rb_protect(rb_yield, self, &status);
    if(status == 0) {
      result = gvl_PQexec(conn, "COMMIT");
      rb_pgresult = pg_new_result(result, self);
      pg_result_check(rb_pgresult);
    }
    else {
      /* exception occurred, ROLLBACK and re-raise */
      result = gvl_PQexec(conn, "ROLLBACK");
      rb_pgresult = pg_new_result(result, self);
      pg_result_check(rb_pgresult);
      rb_jump_tag(status);
    }

  }
  else {
    /* no block supplied? */
    rb_raise(rb_eArgError, "Must supply block for PG::Connection#transaction");
  }
  return block_result;
}

#transaction_status ⇒ Object

returns one of the following statuses:

PQTRANS_IDLE    = 0 (connection idle)
PQTRANS_ACTIVE  = 1 (command in progress)
PQTRANS_INTRANS = 2 (idle, within transaction block)
PQTRANS_INERROR = 3 (idle, within failed transaction)
PQTRANS_UNKNOWN = 4 (cannot determine status)



727
728
729
730
731
 
# File 'ext/pg_connection.c', line 727

static VALUE
pgconn_transaction_status(VALUE self)
{
  return INT2NUM(PQtransactionStatus(pg_get_pgconn(self)));
}

#tty ⇒ Object

Returns the connected pgtty. (Obsolete)



659
660
661
662
663
664
665
 
# File 'ext/pg_connection.c', line 659

static VALUE
pgconn_tty(VALUE self)
{
  char *tty = PQtty(pg_get_pgconn(self));
  if (!tty) return Qnil;
  return rb_tainted_str_new2(tty);
}

#type_map_for_queries ⇒ TypeMap

Returns the default TypeMap that is currently set for type casts of query bind parameters.

Returns:



3766
3767
3768
3769
3770
3771
3772
 
# File 'ext/pg_connection.c', line 3766

static VALUE
pgconn_type_map_for_queries_get(VALUE self)
{
  t_pg_connection *this = pg_get_connection( self );

  return this->type_map_for_queries;
}

#type_map_for_queries=(typemap) ⇒ Object

Set the default TypeMap that is used for type casts of query bind parameters.

typemap must be a kind of PG::TypeMap .



3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
 
# File 'ext/pg_connection.c', line 3743

static VALUE
pgconn_type_map_for_queries_set(VALUE self, VALUE typemap)
{
  t_pg_connection *this = pg_get_connection( self );

  if ( !rb_obj_is_kind_of(typemap, rb_cTypeMap) ) {
    rb_raise( rb_eTypeError, "wrong argument type %s (expected kind of PG::TypeMap)",
        rb_obj_classname( typemap ) );
  }
  Check_Type(typemap, T_DATA);
  this->type_map_for_queries = typemap;

  return typemap;
}

#type_map_for_results ⇒ TypeMap

Returns the default TypeMap that is currently set for type casts of result values.

Returns:



3805
3806
3807
3808
3809
3810
3811
 
# File 'ext/pg_connection.c', line 3805

static VALUE
pgconn_type_map_for_results_get(VALUE self)
{
  t_pg_connection *this = pg_get_connection( self );

  return this->type_map_for_results;
}

#type_map_for_results=(typemap) ⇒ Object

Set the default TypeMap that is used for type casts of result values.

typemap must be a kind of PG::TypeMap .



3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
 
# File 'ext/pg_connection.c', line 3783

static VALUE
pgconn_type_map_for_results_set(VALUE self, VALUE typemap)
{
  t_pg_connection *this = pg_get_connection( self );

  if ( !rb_obj_is_kind_of(typemap, rb_cTypeMap) ) {
    rb_raise( rb_eTypeError, "wrong argument type %s (expected kind of PG::TypeMap)",
        rb_obj_classname( typemap ) );
  }
  Check_Type(typemap, T_DATA);
  this->type_map_for_results = typemap;

  return typemap;
}

#PG::Connection.unescape_bytea(string) ⇒ Object

Converts an escaped string representation of binary data into binary data — the reverse of #escape_bytea. This is needed when retrieving bytea data in text format, but not when retrieving it in binary format.



1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
 
# File 'ext/pg_connection.c', line 1629

static VALUE
pgconn_s_unescape_bytea(VALUE self, VALUE str)
{
  unsigned char *from, *to;
  size_t to_len;
  VALUE ret;

  UNUSED( self );

  Check_Type(str, T_STRING);
  from = (unsigned char*)StringValueCStr(str);

  to = PQunescapeBytea(from, &to_len);

  ret = rb_str_new((char*)to, to_len);
  OBJ_INFECT(ret, str);
  PQfreemem(to);
  return ret;
}

#untrace ⇒ nil

Disables the message tracing.

Returns:

  • (nil) 


2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
 
# File 'ext/pg_connection.c', line 2794

static VALUE
pgconn_untrace(VALUE self)
{
  t_pg_connection *this = pg_get_connection_safe( self );

  PQuntrace(this->pgconn);
  rb_funcall(this->trace_stream, rb_intern("close"), 0);
  this->trace_stream = Qnil;
  return Qnil;
}

#user ⇒ Object

Returns the authenticated user name.



604
605
606
607
608
609
610
 
# File 'ext/pg_connection.c', line 604

static VALUE
pgconn_user(VALUE self)
{
  char *user = PQuser(pg_get_pgconn(self));
  if (!user) return Qnil;
  return rb_tainted_str_new2(user);
}

#wait_for_notify([ timeout ]) ⇒ String #wait_for_notify([ timeout ]) {|event, pid| ... } ⇒ Object #wait_for_notify([ timeout ]) ⇒ Object Also known as: notifies_wait

Blocks while waiting for notification(s), or until the optional timeout is reached, whichever comes first. timeout is measured in seconds and can be fractional.

Returns nil if timeout is reached, the name of the NOTIFY event otherwise. If used in block form, passes the name of the NOTIFY event and the generating pid into the block.

Under PostgreSQL 9.0 and later, if the notification is sent with the optional payload string, it will be given to the block as the third argument.

Overloads:

  • #wait_for_notify([ timeout ]) ⇒ String

    Returns:

    • (String)
  • #wait_for_notify([ timeout ]) {|event, pid| ... } ⇒ Object

    Yields:

    • (event, pid) 


2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
 
# File 'ext/pg_connection.c', line 2504

static VALUE
pgconn_wait_for_notify(int argc, VALUE *argv, VALUE self)
{
  PGconn *conn = pg_get_pgconn( self );
  PGnotify *pnotification;
  struct timeval timeout;
  struct timeval *ptimeout = NULL;
  VALUE timeout_in = Qnil, relname = Qnil, be_pid = Qnil, extra = Qnil;
  double timeout_sec;

  rb_scan_args( argc, argv, "01", &timeout_in );

  if ( RTEST(timeout_in) ) {
    timeout_sec = NUM2DBL( timeout_in );
    timeout.tv_sec = (time_t)timeout_sec;
    timeout.tv_usec = (suseconds_t)( (timeout_sec - (long)timeout_sec) * 1e6 );
    ptimeout = &timeout;
  }

  pnotification = (PGnotify*) wait_socket_readable( conn, ptimeout, notify_readable);

  /* Return nil if the select timed out */
  if ( !pnotification ) return Qnil;

  relname = rb_tainted_str_new2( pnotification->relname );
  PG_ENCODING_SET_NOCHECK( relname, ENCODING_GET(self) );
  be_pid = INT2NUM( pnotification->be_pid );
#ifdef HAVE_ST_NOTIFY_EXTRA
  if ( *pnotification->extra ) {
    extra = rb_tainted_str_new2( pnotification->extra );
    PG_ENCODING_SET_NOCHECK( extra, ENCODING_GET(self) );
  }
#endif
  PQfreemem( pnotification );

  if ( rb_block_given_p() )
    rb_yield_values( 3, relname, be_pid, extra );

  return relname;
}