Class: PGconn

Inherits:
Object
  • Object
show all
Defined in:
ext/pg.c,
ext/pg.c

Overview

******************************************************************

The class to access PostgreSQL RDBMS, based on the libpq interface,
provides convenient OO methods to interact with PostgreSQL.

For example, to send query to the database on the localhost:
   require 'pg'
   conn = PGconn.open(:dbname => 'test')
   res = conn.exec('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 PGresult class for information on working with the results of a query.

Constant Summary collapse

CONNECTION_OK =

Connection Status *****

****     PGconn CLASS CONSTANTS
CONNECTION_BAD = 
INT2FIX(CONNECTION_BAD)
CONNECTION_STARTED =

Nonblocking connection status *****

****     PGconn CLASS CONSTANTS
CONNECTION_MADE = 
INT2FIX(CONNECTION_MADE)
CONNECTION_AWAITING_RESPONSE = 
INT2FIX(CONNECTION_AWAITING_RESPONSE)
CONNECTION_AUTH_OK = 
INT2FIX(CONNECTION_AUTH_OK)
CONNECTION_SSL_STARTUP = 
INT2FIX(CONNECTION_SSL_STARTUP)
CONNECTION_SETENV = 
INT2FIX(CONNECTION_SETENV)
PGRES_POLLING_READING =

Nonblocking connection polling status *****

****     PGconn CLASS CONSTANTS
PGRES_POLLING_WRITING = 
INT2FIX(PGRES_POLLING_WRITING)
PGRES_POLLING_FAILED = 
INT2FIX(PGRES_POLLING_FAILED)
PGRES_POLLING_OK = 
INT2FIX(PGRES_POLLING_OK)
PQTRANS_IDLE =

Transaction Status *****

****     PGconn CLASS CONSTANTS
PQTRANS_ACTIVE = 
INT2FIX(PQTRANS_ACTIVE)
PQTRANS_INTRANS = 
INT2FIX(PQTRANS_INTRANS)
PQTRANS_INERROR = 
INT2FIX(PQTRANS_INERROR)
PQTRANS_UNKNOWN = 
INT2FIX(PQTRANS_UNKNOWN)
PQERRORS_TERSE =

Error Verbosity *****

****     PGconn CLASS CONSTANTS
PQERRORS_DEFAULT = 
INT2FIX(PQERRORS_DEFAULT)
PQERRORS_VERBOSE = 
INT2FIX(PQERRORS_VERBOSE)
INV_WRITE =

Large Objects *****

****     PGconn CLASS CONSTANTS
INV_READ = 
INT2FIX(INV_READ)
SEEK_SET = 
INT2FIX(SEEK_SET)
SEEK_CUR = 
INT2FIX(SEEK_CUR)
SEEK_END = 
INT2FIX(SEEK_END)

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Object

call-seq:

PGconn.new(connection_hash) -> PGconn
PGconn.new(connection_string) -> PGconn
PGconn.new(host, port, options, tty, dbname, login, password) ->  PGconn

  • 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

connection_hash example: PGconn.connect(:dbname=>‘test’, :port=>5432) connection_string example: PGconn.connect(“dbname=test port=5432”) connection_hash example: +PGconn.connect(nil,5432,nil,nil,‘test’,nil,nil)

On failure, it raises a PGError exception.



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'ext/pg.c', line 354

static VALUE
pgconn_init(int argc, VALUE *argv, VALUE self)
{
  PGconn *conn = NULL;
  VALUE conninfo;
  VALUE error;

  conninfo = parse_connect_args(argc, argv, self);
  conn = PQconnectdb(StringValuePtr(conninfo));

  if(conn == NULL)
    rb_raise(rb_ePGError, "PQconnectStart() unable to allocate structure");

  Check_Type(self, T_DATA);
  DATA_PTR(self) = conn;

  if (PQstatus(conn) == CONNECTION_BAD) {
    error = rb_exc_new2(rb_ePGError, PQerrorMessage(conn));
    rb_iv_set(error, "@connection", self);
    rb_exc_raise(error);
  }

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

Class Method Details

.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

Returns:

  • (Array) 


439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'ext/pg.c', line 439

static VALUE
pgconn_s_conndefaults(VALUE self)
{
  PQconninfoOption *options = PQconndefaults();
  VALUE ary = rb_ary_new();
  VALUE hash;
  int i = 0;

  for(i = 0; options[i].keyword != NULL; i++) {
    hash = rb_hash_new();
    if(options[i].keyword)
      rb_hash_aset(hash, ID2SYM(rb_intern("keyword")),
        STR_NEW2(options[i].keyword));
    if(options[i].envvar)
      rb_hash_aset(hash, ID2SYM(rb_intern("envvar")),
        STR_NEW2(options[i].envvar));
    if(options[i].compiled)
      rb_hash_aset(hash, ID2SYM(rb_intern("compiled")),
        STR_NEW2(options[i].compiled));
    if(options[i].val)
      rb_hash_aset(hash, ID2SYM(rb_intern("val")),
        STR_NEW2(options[i].val));
    if(options[i].label)
      rb_hash_aset(hash, ID2SYM(rb_intern("label")),
        STR_NEW2(options[i].label));
    if(options[i].dispchar)
      rb_hash_aset(hash, ID2SYM(rb_intern("dispchar")),
        STR_NEW2(options[i].dispchar));
    rb_hash_aset(hash, ID2SYM(rb_intern("dispsize")),
      INT2NUM(options[i].dispsize));
    rb_ary_push(ary, hash);
  }
  PQconninfoFree(options);
  return ary;
}

.connect_start(connection_hash) ⇒ PGconn .connect_start(connection_string) ⇒ PGconn .connect_start(host, port, options, tty, dbname, login, password) ⇒ PGconn

This is an asynchronous version of PGconn.connect().

Use PGconn#connect_poll to poll the status of the connection.

Overloads:

  • .connect_start(connection_hash) ⇒ PGconn

    Returns:

  • .connect_start(connection_string) ⇒ PGconn

    Returns:

  • .connect_start(host, port, options, tty, dbname, login, password) ⇒ PGconn

    Returns:



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'ext/pg.c', line 392

static VALUE
pgconn_s_connect_start(int argc, VALUE *argv, VALUE self)
{
  PGconn *conn = NULL;
  VALUE rb_conn;
  VALUE conninfo;
  VALUE error;

  /*
   * PGconn.connect_start must act as both alloc() and initialize()
   * because it is not invoked by calling new().
   */
  rb_conn = pgconn_alloc(rb_cPGconn);

  conninfo = parse_connect_args(argc, argv, self);
  conn = PQconnectdb(StringValuePtr(conninfo));

  if(conn == NULL)
    rb_raise(rb_ePGError, "PQconnectStart() unable to allocate structure");
  if (PQstatus(conn) == CONNECTION_BAD) {
    error = rb_exc_new2(rb_ePGError, PQerrorMessage(conn));
    rb_iv_set(error, "@connection", self);
    rb_exc_raise(error);
  }

  Check_Type(rb_conn, T_DATA);
  DATA_PTR(rb_conn) = conn;

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

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


487
488
489
490
491
492
493
494
495
496
 
# File 'ext/pg.c', line 487

static VALUE
pgconn_s_encrypt_password(VALUE self, VALUE password, VALUE username)
{
  char *ret;
  Check_Type(password, T_STRING);
  Check_Type(username, T_STRING);
  ret = PQencryptPassword(StringValuePtr(password),
    StringValuePtr(username));
  return rb_tainted_str_new2(ret);
}

.escape_bytea(string) ⇒ String .escape_bytea(string) ⇒ String #DEPRECATEDD

Connection instance method for versions of 8.1 and higher of libpq uses PQescapeByteaConn, which is safer. Avoid calling as a class method, the class method uses the deprecated PQescapeBytea() API function.

Use the instance method version of this function, it is safer than the class method.

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.

Overloads:

  • .escape_bytea(string) ⇒ String

    Returns:

    • (String)
  • .escape_bytea(string) ⇒ String #DEPRECATEDD

    Returns:

    • (String #DEPRECATEDD) 


1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
 
# File 'ext/pg.c', line 1352

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(CLASS_OF(self) == rb_cPGconn) {
    to = PQescapeByteaConn(get_pgconn(self), from, from_len, &to_len);
  } else {
    to = PQescapeBytea( from, from_len, &to_len);
  }

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

.escape_string(str) ⇒ String .escape_string(str) ⇒ String #DEPRECATEDD

Connection instance method for versions of 8.1 and higher of libpq uses PQescapeStringConn, which is safer. Avoid calling as a class method, the class method uses the deprecated PQescapeString() API function.

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.

Overloads:

  • .escape_string(str) ⇒ String

    Returns:

    • (String)
  • .escape_string(str) ⇒ String #DEPRECATEDD

    Returns:

    • (String #DEPRECATEDD) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
 
# File 'ext/pg.c', line 1301

static VALUE
pgconn_s_escape(VALUE self, VALUE string)
{
  char *escaped;
  int size,error;
  VALUE result;

  Check_Type(string, T_STRING);

  escaped = ALLOC_N(char, RSTRING_LEN(string) * 2 + 1);
  if(CLASS_OF(self) == rb_cPGconn) {
    size = PQescapeStringConn(get_pgconn(self), escaped,
      RSTRING_PTR(string), RSTRING_LEN(string), &error);
    if(error) {
      rb_raise(rb_ePGError, PQerrorMessage(get_pgconn(self)));
    }
  } else {
    size = PQescapeString(escaped, RSTRING_PTR(string),
      RSTRING_LEN(string));
  }
  result = STR_NEW(escaped, size);
  xfree(escaped);
  OBJ_INFECT(result, string);
  return result;
}

.isthreadsafe ⇒ Boolean

Returns true if libpq is thread safe, false otherwise.

Returns:

  • (Boolean) 


504
505
506
507
508
 
# File 'ext/pg.c', line 504

static VALUE
pgconn_s_isthreadsafe(VALUE self)
{
  return PQisthreadsafe() ? Qtrue : Qfalse;
}

.quote_ident(str) ⇒ String .quote_ident(str) ⇒ 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 PGconn.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.

Overloads:

  • .quote_ident(str) ⇒ String

    Returns:

    • (String)
  • .quote_ident(str) ⇒ String

    Returns:

    • (String) 


2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
 
# File 'ext/pg.c', line 2364

static VALUE
pgconn_s_quote_ident(VALUE self, VALUE in_str)
{
  VALUE ret;
  char *str = StringValuePtr(in_str);
  /* result size at most NAMEDATALEN*2 plus surrounding
   * double-quotes. */
  char buffer[NAMEDATALEN*2+2];
  unsigned int i=0,j=0;

  if(strlen(str) >= NAMEDATALEN) {
    rb_raise(rb_eArgError,
      "Input string is longer than NAMEDATALEN-1 (%d)",
      NAMEDATALEN-1);
  }
  buffer[j++] = '"';
  for(i = 0; i < strlen(str) && str[i]; i++) {
    if(str[i] == '"')
      buffer[j++] = '"';
    buffer[j++] = str[i];
  }
  buffer[j++] = '"';
  ret = STR_NEW(buffer,j);
  OBJ_INFECT(ret, in_str);
  return ret;
}

.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.



1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
 
# File 'ext/pg.c', line 1385

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

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

  to = PQunescapeBytea(from, &to_len);

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

Instance Method Details

#async_exec(sql[, params, result_format ]) ⇒ PGresult Also known as: async_query

This function has the same behavior as PGconn#exec, except that it’s implemented using asynchronous command processing and ruby’s rb_thread_select in order to allow other threads to process while waiting for the server to complete the request.

Returns:



2475
2476
2477
2478
2479
2480
2481
 
# File 'ext/pg.c', line 2475

static VALUE
pgconn_async_exec(int argc, VALUE *argv, VALUE self)
{
  pgconn_send_query(argc, argv, self);
  pgconn_block(0, NULL, self);
  return pgconn_get_last_result(self);
}

#backend_pid ⇒ Fixnum

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

Returns:

  • (Fixnum) 


833
834
835
836
837
 
# File 'ext/pg.c', line 833

static VALUE
pgconn_backend_pid(VALUE self)
{
  return INT2NUM(PQbackendPID(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) 


2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
 
# File 'ext/pg.c', line 2405

static VALUE
pgconn_block(int argc, VALUE *argv, VALUE self)
{
  PGconn *conn = get_pgconn(self);
  int sd = PQsocket(conn);
  int ret;
  struct timeval timeout;
  struct timeval *ptimeout = NULL;
  VALUE timeout_in;
  double timeout_sec;
  fd_set sd_rset;

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

  PQconsumeInput(conn);
  while(PQisBusy(conn)) {
    FD_ZERO(&sd_rset);
    FD_SET(sd, &sd_rset);
    ret = rb_thread_select(sd+1, &sd_rset, NULL, NULL, ptimeout);
    /* if select() times out, return false */
    if(ret == 0)
      return Qfalse;
    PQconsumeInput(conn);
  }

  return Qtrue;
}

#cancel ⇒ String

Requests cancellation of the command currently being processed.

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

Returns:

  • (String) 


1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
 
# File 'ext/pg.c', line 1933

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

  cancel = PQgetCancel(get_pgconn(self));
  if(cancel == NULL)
    rb_raise(rb_ePGError,"Invalid connection!");

  ret = PQcancel(cancel, errbuf, 256);
  if(ret == 1)
    retval = Qnil;
  else
    retval = STR_NEW2(errbuf);

  PQfreeCancel(cancel);
  return retval;
}

#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

Returns:

  • (Array) 


439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'ext/pg.c', line 439

static VALUE
pgconn_s_conndefaults(VALUE self)
{
  PQconninfoOption *options = PQconndefaults();
  VALUE ary = rb_ary_new();
  VALUE hash;
  int i = 0;

  for(i = 0; options[i].keyword != NULL; i++) {
    hash = rb_hash_new();
    if(options[i].keyword)
      rb_hash_aset(hash, ID2SYM(rb_intern("keyword")),
        STR_NEW2(options[i].keyword));
    if(options[i].envvar)
      rb_hash_aset(hash, ID2SYM(rb_intern("envvar")),
        STR_NEW2(options[i].envvar));
    if(options[i].compiled)
      rb_hash_aset(hash, ID2SYM(rb_intern("compiled")),
        STR_NEW2(options[i].compiled));
    if(options[i].val)
      rb_hash_aset(hash, ID2SYM(rb_intern("val")),
        STR_NEW2(options[i].val));
    if(options[i].label)
      rb_hash_aset(hash, ID2SYM(rb_intern("label")),
        STR_NEW2(options[i].label));
    if(options[i].dispchar)
      rb_hash_aset(hash, ID2SYM(rb_intern("dispchar")),
        STR_NEW2(options[i].dispchar));
    rb_hash_aset(hash, ID2SYM(rb_intern("dispsize")),
      INT2NUM(options[i].dispsize));
    rb_ary_push(ary, hash);
  }
  PQconninfoFree(options);
  return ary;
}

#connect_poll ⇒ Fixnum

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 = PGconn.connect_start("dbname=mydatabase")
socket = IO.for_fd(conn.socket)
status = conn.connect_poll
while(status != PGconn::PGRES_POLLING_OK) do
  # do some work while waiting for the connection to complete
  if(status == PGconn::PGRES_POLLING_READING)
    if(not select([socket], [], [], 10.0))
      raise "Asynchronous connection timed out!"
    end
  elsif(status == PGconn::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:

  • (Fixnum) 


544
545
546
547
548
549
550
 
# File 'ext/pg.c', line 544

static VALUE
pgconn_connect_poll(VALUE self)
{
  PostgresPollingStatusType status;
  status = PQconnectPoll(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) 


846
847
848
849
850
 
# File 'ext/pg.c', line 846

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

#connection_used_password ⇒ Boolean

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

Returns:

  • (Boolean) 


859
860
861
862
863
 
# File 'ext/pg.c', line 859

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

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



1815
1816
1817
 
# File 'ext/pg.c', line 1815

static VALUE
pgconn_consume_input(self)
VALUE self;

#db ⇒ Object

Returns the connected database name.



620
621
622
623
624
625
626
 
# File 'ext/pg.c', line 620

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

#describe_portal(portal_name) ⇒ PGresult

Retrieve information about the portal portal_name.

Returns:



1235
1236
1237
 
# File 'ext/pg.c', line 1235

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

#describe_prepared(statement_name) ⇒ PGresult

Retrieve information about the prepared statement statement_name.

Returns:



1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
 
# File 'ext/pg.c', line 1208

static VALUE
pgconn_describe_prepared(VALUE self, VALUE stmt_name)
{
  PGresult *result;
  VALUE rb_pgresult;
  PGconn *conn = get_pgconn(self);
  char *stmt;
  if(stmt_name == Qnil) {
    stmt = NULL;
  }
  else {
    Check_Type(stmt_name, T_STRING);
    stmt = StringValuePtr(stmt_name);
  }
  result = PQdescribePrepared(conn, stmt);
  rb_pgresult = new_pgresult(result);
  pgresult_check(self, rb_pgresult);
  return rb_pgresult;
}

#error ⇒ String

Returns the error message about connection.

Returns:

  • (String) 


801
802
803
804
805
806
807
 
# File 'ext/pg.c', line 801

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

#escape_bytea(string) ⇒ String #escape_bytea(string) ⇒ String #DEPRECATEDD

Connection instance method for versions of 8.1 and higher of libpq uses PQescapeByteaConn, which is safer. Avoid calling as a class method, the class method uses the deprecated PQescapeBytea() API function.

Use the instance method version of this function, it is safer than the class method.

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.

Overloads:

  • #escape_bytea(string) ⇒ String

    Returns:

    • (String)
  • #escape_bytea(string) ⇒ String #DEPRECATEDD

    Returns:

    • (String #DEPRECATEDD) 


1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
 
# File 'ext/pg.c', line 1352

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(CLASS_OF(self) == rb_cPGconn) {
    to = PQescapeByteaConn(get_pgconn(self), from, from_len, &to_len);
  } else {
    to = PQescapeBytea( from, from_len, &to_len);
  }

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

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

Connection instance method for versions of 8.1 and higher of libpq uses PQescapeStringConn, which is safer. Avoid calling as a class method, the class method uses the deprecated PQescapeString() API function.

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.

Overloads:

  • #escape_string(str) ⇒ String

    Returns:

    • (String)
  • #escape_string(str) ⇒ String #DEPRECATEDD

    Returns:

    • (String #DEPRECATEDD) 


1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
 
# File 'ext/pg.c', line 1301

static VALUE
pgconn_s_escape(VALUE self, VALUE string)
{
  char *escaped;
  int size,error;
  VALUE result;

  Check_Type(string, T_STRING);

  escaped = ALLOC_N(char, RSTRING_LEN(string) * 2 + 1);
  if(CLASS_OF(self) == rb_cPGconn) {
    size = PQescapeStringConn(get_pgconn(self), escaped,
      RSTRING_PTR(string), RSTRING_LEN(string), &error);
    if(error) {
      rb_raise(rb_ePGError, PQerrorMessage(get_pgconn(self)));
    }
  } else {
    size = PQescapeString(escaped, RSTRING_PTR(string),
      RSTRING_LEN(string));
  }
  result = STR_NEW(escaped, size);
  xfree(escaped);
  OBJ_INFECT(result, string);
  return result;
}

#exec(sql[, params, result_format ]) ⇒ PGresult Also known as: query

Sends SQL query request specified by sql to PostgreSQL. Returns a PGresult instance on success. On failure, it raises a PGError exception.

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   => Fixnum (oid of type of bind parameter)
   :format => Fixnum (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.

Returns:



900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
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
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
 
# File 'ext/pg.c', line 900

static VALUE
pgconn_exec(int argc, VALUE *argv, VALUE self)
{
  PGconn *conn = get_pgconn(self);
  PGresult *result = NULL;
  VALUE rb_pgresult;
  VALUE command, params, in_res_fmt;
  VALUE param, param_type, param_value, param_format;
  VALUE param_value_tmp;
  VALUE sym_type, sym_value, sym_format;
  VALUE gc_array;
  int i=0;
  int nParams;
  Oid *paramTypes;
  char ** paramValues;
  int *paramLengths;
  int *paramFormats;
  int resultFormat;

  rb_scan_args(argc, argv, "12", &command, &params, &in_res_fmt);

  Check_Type(command, T_STRING);

  /* If called with no parameters, use PQexec */
  if(NIL_P(params)) {
    result = PQexec(conn, StringValuePtr(command));
    rb_pgresult = new_pgresult(result);
    pgresult_check(self, rb_pgresult);
    if (rb_block_given_p()) {
      return rb_ensure(yield_pgresult, rb_pgresult,
        pgresult_clear, rb_pgresult);
    }
    return rb_pgresult;
  }

  /* If called with parameters, and optionally result_format,
   * use PQexecParams
   */
  Check_Type(params, T_ARRAY);

  if(NIL_P(in_res_fmt)) {
    resultFormat = 0;
  }
  else {
    resultFormat = NUM2INT(in_res_fmt);
  }

  gc_array = rb_ary_new();
  rb_gc_register_address(&gc_array);
  sym_type = ID2SYM(rb_intern("type"));
  sym_value = ID2SYM(rb_intern("value"));
  sym_format = ID2SYM(rb_intern("format"));
  nParams = RARRAY_LEN(params);
  paramTypes = ALLOC_N(Oid, nParams);
  paramValues = ALLOC_N(char *, nParams);
  paramLengths = ALLOC_N(int, nParams);
  paramFormats = ALLOC_N(int, nParams);
  for(i = 0; i < nParams; i++) {
    param = rb_ary_entry(params, i);
    if (TYPE(param) == T_HASH) {
      param_type = rb_hash_aref(param, sym_type);
      param_value_tmp = rb_hash_aref(param, sym_value);
      if(param_value_tmp == Qnil)
        param_value = param_value_tmp;
      else
        param_value = rb_obj_as_string(param_value_tmp);
      param_format = rb_hash_aref(param, sym_format);
    }
    else {
      param_type = Qnil;
      if(param == Qnil)
        param_value = param;
      else
        param_value = rb_obj_as_string(param);
      param_format = Qnil;
    }

    if(param_type == Qnil)
      paramTypes[i] = 0;
    else
      paramTypes[i] = NUM2INT(param_type);

    if(param_value == Qnil) {
      paramValues[i] = NULL;
      paramLengths[i] = 0;
    }
    else {
      Check_Type(param_value, T_STRING);
      /* make sure param_value doesn't get freed by the GC */
      rb_ary_push(gc_array, param_value);
      paramValues[i] = StringValuePtr(param_value);
      paramLengths[i] = RSTRING_LEN(param_value);
    }

    if(param_format == Qnil)
      paramFormats[i] = 0;
    else
      paramFormats[i] = NUM2INT(param_format);
  }

  result = PQexecParams(conn, StringValuePtr(command), nParams, paramTypes,
    (const char * const *)paramValues, paramLengths, paramFormats, resultFormat);

  rb_gc_unregister_address(&gc_array);

  xfree(paramTypes);
  xfree(paramValues);
  xfree(paramLengths);
  xfree(paramFormats);

  rb_pgresult = new_pgresult(result);
  pgresult_check(self, rb_pgresult);
  if (rb_block_given_p()) {
    return rb_ensure(yield_pgresult, rb_pgresult,
      pgresult_clear, rb_pgresult);
  }
  return rb_pgresult;
}

#exec_prepared(statement_name[, params, result_format ]) ⇒ PGresult

Execute prepared named statement specified by statement_name. Returns a PGresult instance on success. On failure, it raises a PGError exception.

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 => Fixnum (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.

Returns:



1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'ext/pg.c', line 1102

static VALUE
pgconn_exec_prepared(int argc, VALUE *argv, VALUE self)
{
  PGconn *conn = get_pgconn(self);
  PGresult *result = NULL;
  VALUE rb_pgresult;
  VALUE name, params, in_res_fmt;
  VALUE param, param_value, param_format;
  VALUE param_value_tmp;
  VALUE sym_value, sym_format;
  VALUE gc_array;
  int i = 0;
  int nParams;
  char ** paramValues;
  int *paramLengths;
  int *paramFormats;
  int resultFormat;


  rb_scan_args(argc, argv, "12", &name, &params, &in_res_fmt);
  Check_Type(name, T_STRING);

  if(NIL_P(params)) {
    params = rb_ary_new2(0);
    resultFormat = 0;
  }
  else {
    Check_Type(params, T_ARRAY);
  }

  if(NIL_P(in_res_fmt)) {
    resultFormat = 0;
  }
  else {
    resultFormat = NUM2INT(in_res_fmt);
  }

  gc_array = rb_ary_new();
  rb_gc_register_address(&gc_array);
  sym_value = ID2SYM(rb_intern("value"));
  sym_format = ID2SYM(rb_intern("format"));
  nParams = RARRAY_LEN(params);
  paramValues = ALLOC_N(char *, nParams);
  paramLengths = ALLOC_N(int, nParams);
  paramFormats = ALLOC_N(int, nParams);
  for(i = 0; i < nParams; i++) {
    param = rb_ary_entry(params, i);
    if (TYPE(param) == T_HASH) {
      param_value_tmp = rb_hash_aref(param, sym_value);
      if(param_value_tmp == Qnil)
        param_value = param_value_tmp;
      else
        param_value = rb_obj_as_string(param_value_tmp);
      param_format = rb_hash_aref(param, sym_format);
    }
    else {
      if(param == Qnil)
        param_value = param;
      else
        param_value = rb_obj_as_string(param);
      param_format = INT2NUM(0);
    }
    if(param_value == Qnil) {
      paramValues[i] = NULL;
      paramLengths[i] = 0;
    }
    else {
      Check_Type(param_value, T_STRING);
      /* make sure param_value doesn't get freed by the GC */
      rb_ary_push(gc_array, param_value);
      paramValues[i] = StringValuePtr(param_value);
      paramLengths[i] = RSTRING_LEN(param_value);
    }

    if(param_format == Qnil)
      paramFormats[i] = 0;
    else
      paramFormats[i] = NUM2INT(param_format);
  }

  result = PQexecPrepared(conn, StringValuePtr(name), nParams,
    (const char * const *)paramValues, paramLengths, paramFormats,
    resultFormat);

  rb_gc_unregister_address(&gc_array);

  xfree(paramValues);
  xfree(paramLengths);
  xfree(paramFormats);

  rb_pgresult = new_pgresult(result);
  pgresult_check(self, rb_pgresult);
  if (rb_block_given_p()) {
    return rb_ensure(yield_pgresult, rb_pgresult,
      pgresult_clear, rb_pgresult);
  }
  return rb_pgresult;
}

#finish ⇒ Object Also known as: close

Closes the backend connection.



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

static VALUE
pgconn_finish(VALUE self)
{
  PQfinish(get_pgconn(self));
  DATA_PTR(self) = NULL;
  return Qnil;
}

#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 PGError exception if some other failure occurred.

Returns:

  • (Boolean) 


1907
1908
1909
 
# File 'ext/pg.c', line 1907

static VALUE
pgconn_flush(self)
VALUE self;

#get_client_encoding ⇒ String

Returns the client encoding as a String.

Returns:

  • (String) 


2279
2280
2281
2282
2283
2284
 
# File 'ext/pg.c', line 2279

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

#get_copy_data([ async = false ]) ⇒ 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).

Returns:

  • (String) 


2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
 
# File 'ext/pg.c', line 2070

static VALUE
pgconn_get_copy_data(int argc, VALUE *argv, VALUE self )
{
  VALUE async_in;
  VALUE error;
  VALUE result_str;
  int ret;
  int async;
  char *buffer;
  PGconn *conn = get_pgconn(self);

  if (rb_scan_args(argc, argv, "01", &async_in) == 0)
    async = 0;
  else
    async = (async_in == Qfalse || async_in == Qnil) ? 0 : 1;

  ret = PQgetCopyData(conn, &buffer, async);
  if(ret == -2) { // error
    error = rb_exc_new2(rb_ePGError, PQerrorMessage(conn));
    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;
  }
  result_str = rb_tainted_str_new(buffer, ret);
  PQfreemem(buffer);
  return result_str;
}

#get_last_result ⇒ PGresult

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 PGconn#get_result except that it is designed to get one and only one result.

Returns:



2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
 
# File 'ext/pg.c', line 2452

static VALUE
pgconn_get_last_result(VALUE self)
{
  VALUE ret, result;
  ret = Qnil;
  while((result = pgconn_get_result(self)) != Qnil) {
    ret = result;
  }
  pgresult_check(self, ret);
  return ret;
}

#get_result ⇒ PGresult

Blocks waiting for the next result from a call to PGconn#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.

Returns:



1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
 
# File 'ext/pg.c', line 1789

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

  result = PQgetResult(conn);
  if(result == NULL)
    return Qnil;
  rb_pgresult = new_pgresult(result);
  if (rb_block_given_p()) {
    return rb_ensure(yield_pgresult, rb_pgresult,
      pgresult_clear, rb_pgresult);
  }
  return rb_pgresult;
}

#host ⇒ Object

Returns the connected server name.



662
663
664
665
666
667
668
 
# File 'ext/pg.c', line 662

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

#is_busy ⇒ Boolean

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

Returns:

  • (Boolean) 


1837
1838
1839
 
# File 'ext/pg.c', line 1837

static VALUE
pgconn_is_busy(self)
VALUE self;

#isnonblocking ⇒ Boolean

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

Returns:

  • (Boolean) 


1890
1891
1892
 
# File 'ext/pg.c', line 1890

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) 


2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
 
# File 'ext/pg.c', line 2747

static VALUE
pgconn_loclose(VALUE self, VALUE in_lo_desc)
{
  PGconn *conn = 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]) ⇒ Fixnum Also known as: locreat

Creates a large object with mode mode. Returns a large object Oid. On failure, it raises PGError exception.

Returns:

  • (Fixnum) 


2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
 
# File 'ext/pg.c', line 2494

static VALUE
pgconn_locreat(int argc, VALUE *argv, VALUE self)
{
  Oid lo_oid;
  int mode;
  VALUE nmode;
  PGconn *conn = 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 INT2FIX(lo_oid);
}

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

Creates a large object with oid oid. Returns the large object Oid. On failure, it raises PGError exception.

Returns:

  • (Fixnum) 


2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
 
# File 'ext/pg.c', line 2521

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

  ret = lo_create(conn, in_lo_oid);
  if (ret == InvalidOid)
    rb_raise(rb_ePGError, "lo_create failed");

  return INT2FIX(ret);
}

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

Saves a large object of oid to a file.

Returns:

  • (nil) 


2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
 
# File 'ext/pg.c', line 2565

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

  oid = NUM2INT(lo_oid);
  if (oid < 0) {
    rb_raise(rb_ePGError, "invalid large object oid %d",oid);
  }

  if (lo_export(conn, oid, StringValuePtr(filename)) < 0) {
    rb_raise(rb_ePGError, PQerrorMessage(conn));
  }
  return Qnil;
}

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

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

On failure, it raises a PGError exception.

Returns:

  • (Fixnum) 


2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
 
# File 'ext/pg.c', line 2543

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

  PGconn *conn = get_pgconn(self);

  Check_Type(filename, T_STRING);

  lo_oid = lo_import(conn, StringValuePtr(filename));
  if (lo_oid == 0) {
    rb_raise(rb_ePGError, PQerrorMessage(conn));
  }
  return INT2FIX(lo_oid);
}

#lo_lseek(in_lo_desc, offset, whence) ⇒ Object Also known as: lolseek, lo_seek, loseek

call-seq

conn.lo_lseek( lo_desc, offset, whence ) -> Fixnum

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



2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
 
# File 'ext/pg.c', line 2689

static VALUE
pgconn_lolseek(VALUE self, VALUE in_lo_desc, VALUE offset, VALUE whence)
{
  PGconn *conn = 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]) ⇒ Fixnum 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:

  • (Fixnum) 


2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
 
# File 'ext/pg.c', line 2593

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

  rb_scan_args(argc, argv, "11", &selfid, &nmode);
  lo_oid = NUM2INT(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");
  }
  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) 


2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
 
# File 'ext/pg.c', line 2648

static VALUE
pgconn_loread(VALUE self, VALUE in_lo_desc, VALUE in_len)
{
  int ret;
  PGconn *conn = 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, len);
  xfree(buffer);

  return str;
}

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

Returns the current position of the large object lo_desc.

Returns:

  • (Fixnum) 


2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
 
# File 'ext/pg.c', line 2709

static VALUE
pgconn_lotell(VALUE self, VALUE in_lo_desc)
{
  int position;
  PGconn *conn = 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) 


2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
 
# File 'ext/pg.c', line 2728

static VALUE
pgconn_lotruncate(VALUE self, VALUE in_lo_desc, VALUE in_len)
{
  PGconn *conn = 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) 


2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
 
# File 'ext/pg.c', line 2765

static VALUE
pgconn_lounlink(VALUE self, VALUE in_oid)
{
  PGconn *conn = get_pgconn(self);
  int oid = NUM2INT(in_oid);

  if (oid < 0)
    rb_raise(rb_ePGError, "invalid oid %d",oid);

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

  return Qnil;
}

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

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

Returns:

  • (Fixnum) 


2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
 
# File 'ext/pg.c', line 2621

static VALUE
pgconn_lowrite(VALUE self, VALUE in_lo_desc, VALUE buffer)
{
  int n;
  PGconn *conn = 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");
  }

  return INT2FIX(n);
}

#make_empty_pgresult(status) ⇒ PGresult

Constructs and empty PGresult 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

Returns:



1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
 
# File 'ext/pg.c', line 1272

static VALUE
pgconn_make_empty_pgresult(VALUE self, VALUE status)
{
  PGresult *result;
  VALUE rb_pgresult;
  PGconn *conn = get_pgconn(self);
  result = PQmakeEmptyPGresult(conn, NUM2INT(status));
  rb_pgresult = new_pgresult(result);
  pgresult_check(self, rb_pgresult);
  return rb_pgresult;
}

#notifies ⇒ Object

Returns an array of the unprocessed notifiers. If there is no unprocessed notifier, it returns nil.



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
 
# File 'ext/pg.c', line 1962

static VALUE
pgconn_notifies(VALUE self)
{
  PGconn* conn = get_pgconn(self);
  PGnotify *notify;
  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"));

  notify = PQnotifies(conn);
  if (notify == NULL) {
    return Qnil;
  }

  hash = rb_hash_new();
  relname = rb_tainted_str_new2(notify->relname);
  be_pid = INT2NUM(notify->be_pid);
  extra = rb_tainted_str_new2(PGNOTIFY_EXTRA(notify));

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

  PQfreemem(notify);
  return hash;
}

#options ⇒ Object

Returns backend option string.



703
704
705
706
707
708
709
 
# File 'ext/pg.c', line 703

static VALUE
pgconn_options(VALUE self)
{
  char *options = PQoptions(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) 


758
759
760
761
762
763
764
765
766
767
 
# File 'ext/pg.c', line 758

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

#pass ⇒ Object

Returns the authenticated user name.



648
649
650
651
652
653
654
 
# File 'ext/pg.c', line 648

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

#port ⇒ Object

Returns the connected server port number.



676
677
678
679
680
681
 
# File 'ext/pg.c', line 676

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

#prepare(stmt_name, sql[, param_types ]) ⇒ PGresult

Prepares statement sql with name name to be executed later. Returns a PGresult instance on success. On failure, it raises a PGError exception.

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:



1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
 
# File 'ext/pg.c', line 1039

static VALUE
pgconn_prepare(int argc, VALUE *argv, VALUE self)
{
  PGconn *conn = 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;

  rb_scan_args(argc, argv, "21", &name, &command, &in_paramtypes);
  Check_Type(name, T_STRING);
  Check_Type(command, T_STRING);

  if(! NIL_P(in_paramtypes)) {
    Check_Type(in_paramtypes, T_ARRAY);
    nParams = RARRAY_LEN(in_paramtypes);
    paramTypes = ALLOC_N(Oid, nParams);
    for(i = 0; i < nParams; i++) {
      param = rb_ary_entry(in_paramtypes, i);
      Check_Type(param, T_FIXNUM);
      if(param == Qnil)
        paramTypes[i] = 0;
      else
        paramTypes[i] = NUM2INT(param);
    }
  }
  result = PQprepare(conn, StringValuePtr(name), StringValuePtr(command),
      nParams, paramTypes);

  xfree(paramTypes);

  rb_pgresult = new_pgresult(result);
  pgresult_check(self, 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) 


777
778
779
780
781
 
# File 'ext/pg.c', line 777

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

#put_copy_data(buffer) ⇒ 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).

Raises an exception if an error occurs.

Returns:

  • (Boolean) 


2005
2006
2007
 
# File 'ext/pg.c', line 2005

static VALUE
pgconn_put_copy_data(self, buffer)
VALUE self, buffer;

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


2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
 
# File 'ext/pg.c', line 2038

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

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

  ret = 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(str) ⇒ 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 PGconn.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.

Overloads:

  • #quote_ident(str) ⇒ String

    Returns:

    • (String)
  • #quote_ident(str) ⇒ String

    Returns:

    • (String) 


2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
 
# File 'ext/pg.c', line 2364

static VALUE
pgconn_s_quote_ident(VALUE self, VALUE in_str)
{
  VALUE ret;
  char *str = StringValuePtr(in_str);
  /* result size at most NAMEDATALEN*2 plus surrounding
   * double-quotes. */
  char buffer[NAMEDATALEN*2+2];
  unsigned int i=0,j=0;

  if(strlen(str) >= NAMEDATALEN) {
    rb_raise(rb_eArgError,
      "Input string is longer than NAMEDATALEN-1 (%d)",
      NAMEDATALEN-1);
  }
  buffer[j++] = '"';
  for(i = 0; i < strlen(str) && str[i]; i++) {
    if(str[i] == '"')
      buffer[j++] = '"';
    buffer[j++] = str[i];
  }
  buffer[j++] = '"';
  ret = STR_NEW(buffer,j);
  OBJ_INFECT(ret, in_str);
  return ret;
}

#reset ⇒ Object

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



573
574
575
576
577
578
 
# File 'ext/pg.c', line 573

static VALUE
pgconn_reset(VALUE self)
{
  PQreset(get_pgconn(self));
  return self;
}

#reset_poll ⇒ Fixnum

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

Returns:

  • (Fixnum) 


606
607
608
609
610
611
612
 
# File 'ext/pg.c', line 606

static VALUE
pgconn_reset_poll(VALUE self)
{
  PostgresPollingStatusType status;
  status = PQresetPoll(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 PGconn#reset_poll to check the status of the connection reset.

Returns:

  • (nil) 


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

static VALUE
pgconn_reset_start(VALUE self)
{
  if(PQresetStart(get_pgconn(self)) == 0)
    rb_raise(rb_ePGError, "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) 


1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
 
# File 'ext/pg.c', line 1763

static VALUE
pgconn_send_describe_portal(VALUE self, VALUE portal)
{
  VALUE error;
  PGconn *conn = get_pgconn(self);
  /* returns 0 on failure */
  if(PQsendDescribePortal(conn,StringValuePtr(portal)) == 0) {
    error = rb_exc_new2(rb_ePGError, 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) 


1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
 
# File 'ext/pg.c', line 1741

static VALUE
pgconn_send_describe_prepared(VALUE self, VALUE stmt_name)
{
  VALUE error;
  PGconn *conn = get_pgconn(self);
  /* returns 0 on failure */
  if(PQsendDescribePrepared(conn,StringValuePtr(stmt_name)) == 0) {
    error = rb_exc_new2(rb_ePGError, 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 PGError exception.

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) 


1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
 
# File 'ext/pg.c', line 1569

static VALUE
pgconn_send_prepare(int argc, VALUE *argv, VALUE self)
{
  PGconn *conn = get_pgconn(self);
  int result;
  VALUE name, command, in_paramtypes;
  VALUE param;
  VALUE error;
  int i = 0;
  int nParams = 0;
  Oid *paramTypes = NULL;

  rb_scan_args(argc, argv, "21", &name, &command, &in_paramtypes);
  Check_Type(name, T_STRING);
  Check_Type(command, T_STRING);

  if(! NIL_P(in_paramtypes)) {
    Check_Type(in_paramtypes, T_ARRAY);
    nParams = RARRAY_LEN(in_paramtypes);
    paramTypes = ALLOC_N(Oid, nParams);
    for(i = 0; i < nParams; i++) {
      param = rb_ary_entry(in_paramtypes, i);
      Check_Type(param, T_FIXNUM);
      if(param == Qnil)
        paramTypes[i] = 0;
      else
        paramTypes[i] = NUM2INT(param);
    }
  }
  result = PQsendPrepare(conn, StringValuePtr(name), StringValuePtr(command),
      nParams, paramTypes);

  xfree(paramTypes);

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

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

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

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   => Fixnum (oid of type of bind parameter)
   :format => Fixnum (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.

Returns:

  • (nil) 


1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'ext/pg.c', line 1434

static VALUE
pgconn_send_query(int argc, VALUE *argv, VALUE self)
{
  PGconn *conn = get_pgconn(self);
  int result;
  VALUE command, params, in_res_fmt;
  VALUE param, param_type, param_value, param_format;
  VALUE param_value_tmp;
  VALUE sym_type, sym_value, sym_format;
  VALUE gc_array;
  VALUE error;
  int i=0;
  int nParams;
  Oid *paramTypes;
  char ** paramValues;
  int *paramLengths;
  int *paramFormats;
  int resultFormat;

  rb_scan_args(argc, argv, "12", &command, &params, &in_res_fmt);
  Check_Type(command, T_STRING);

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

  /* If called with parameters, and optionally result_format,
   * use PQsendQueryParams
   */
  Check_Type(params, T_ARRAY);

  if(NIL_P(in_res_fmt)) {
    resultFormat = 0;
  }
  else {
    resultFormat = NUM2INT(in_res_fmt);
  }

  gc_array = rb_ary_new();
  rb_gc_register_address(&gc_array);
  sym_type = ID2SYM(rb_intern("type"));
  sym_value = ID2SYM(rb_intern("value"));
  sym_format = ID2SYM(rb_intern("format"));
  nParams = RARRAY_LEN(params);
  paramTypes = ALLOC_N(Oid, nParams);
  paramValues = ALLOC_N(char *, nParams);
  paramLengths = ALLOC_N(int, nParams);
  paramFormats = ALLOC_N(int, nParams);
  for(i = 0; i < nParams; i++) {
    param = rb_ary_entry(params, i);
    if (TYPE(param) == T_HASH) {
      param_type = rb_hash_aref(param, sym_type);
      param_value_tmp = rb_hash_aref(param, sym_value);
      if(param_value_tmp == Qnil)
        param_value = param_value_tmp;
      else
        param_value = rb_obj_as_string(param_value_tmp);
      param_format = rb_hash_aref(param, sym_format);
    }
    else {
      param_type = INT2NUM(0);
      if(param == Qnil)
        param_value = param;
      else
        param_value = rb_obj_as_string(param);
      param_format = INT2NUM(0);
    }

    if(param_type == Qnil)
      paramTypes[i] = 0;
    else
      paramTypes[i] = NUM2INT(param_type);

    if(param_value == Qnil) {
      paramValues[i] = NULL;
      paramLengths[i] = 0;
    }
    else {
      Check_Type(param_value, T_STRING);
      /* make sure param_value doesn't get freed by the GC */
      rb_ary_push(gc_array, param_value);
      paramValues[i] = StringValuePtr(param_value);
      paramLengths[i] = RSTRING_LEN(param_value);
    }

    if(param_format == Qnil)
      paramFormats[i] = 0;
    else
      paramFormats[i] = NUM2INT(param_format);
  }

  result = PQsendQueryParams(conn, StringValuePtr(command), nParams, paramTypes,
    (const char * const *)paramValues, paramLengths, paramFormats, resultFormat);

  rb_gc_unregister_address(&gc_array);

  xfree(paramTypes);
  xfree(paramValues);
  xfree(paramLengths);
  xfree(paramFormats);

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

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

Execute prepared named statement specified by statement_name asynchronously, and returns immediately. On failure, it raises a PGError exception.

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 => Fixnum (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.



1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
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
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
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
1727
1728
1729
1730
1731
1732
 
# File 'ext/pg.c', line 1636

static VALUE
pgconn_send_query_prepared(int argc, VALUE *argv, VALUE self)
{
  PGconn *conn = get_pgconn(self);
  int result;
  VALUE name, params, in_res_fmt;
  VALUE param, param_value, param_format;
  VALUE param_value_tmp;
  VALUE sym_value, sym_format;
  VALUE gc_array;
  VALUE error;
  int i = 0;
  int nParams;
  char ** paramValues;
  int *paramLengths;
  int *paramFormats;
  int resultFormat;

  rb_scan_args(argc, argv, "12", &name, &params, &in_res_fmt);
  Check_Type(name, T_STRING);

  if(NIL_P(params)) {
    params = rb_ary_new2(0);
    resultFormat = 0;
  }
  else {
    Check_Type(params, T_ARRAY);
  }

  if(NIL_P(in_res_fmt)) {
    resultFormat = 0;
  }
  else {
    resultFormat = NUM2INT(in_res_fmt);
  }

  gc_array = rb_ary_new();
  rb_gc_register_address(&gc_array);
  sym_value = ID2SYM(rb_intern("value"));
  sym_format = ID2SYM(rb_intern("format"));
  nParams = RARRAY_LEN(params);
  paramValues = ALLOC_N(char *, nParams);
  paramLengths = ALLOC_N(int, nParams);
  paramFormats = ALLOC_N(int, nParams);
  for(i = 0; i < nParams; i++) {
    param = rb_ary_entry(params, i);
    if (TYPE(param) == T_HASH) {
      param_value_tmp = rb_hash_aref(param, sym_value);
      if(param_value_tmp == Qnil)
        param_value = param_value_tmp;
      else
        param_value = rb_obj_as_string(param_value_tmp);
      param_format = rb_hash_aref(param, sym_format);
    }
    else {
      if(param == Qnil)
        param_value = param;
      else
        param_value = rb_obj_as_string(param);
      param_format = INT2NUM(0);
    }

    if(param_value == Qnil) {
      paramValues[i] = NULL;
      paramLengths[i] = 0;
    }
    else {
      Check_Type(param_value, T_STRING);
      /* make sure param_value doesn't get freed by the GC */
      rb_ary_push(gc_array, param_value);
      paramValues[i] = StringValuePtr(param_value);
      paramLengths[i] = RSTRING_LEN(param_value);
    }

    if(param_format == Qnil)
      paramFormats[i] = 0;
    else
      paramFormats[i] = NUM2INT(param_format);
  }

  result = PQsendQueryPrepared(conn, StringValuePtr(name), nParams,
    (const char * const *)paramValues, paramLengths, paramFormats,
    resultFormat);

  rb_gc_unregister_address(&gc_array);

  xfree(paramValues);
  xfree(paramLengths);
  xfree(paramFormats);

  if(result == 0) {
    error = rb_exc_new2(rb_ePGError, 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) 


789
790
791
792
793
 
# File 'ext/pg.c', line 789

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

#set_client_encoding(encoding) ⇒ Object

Sets the client encoding to the encoding String.



2292
2293
2294
2295
2296
2297
2298
2299
2300
 
# File 'ext/pg.c', line 2292

static VALUE
pgconn_set_client_encoding(VALUE self, VALUE str)
{
  Check_Type(str, T_STRING);
  if ((PQsetClientEncoding(get_pgconn(self), StringValuePtr(str))) == -1){
    rb_raise(rb_ePGError, "invalid encoding name: %s",StringValuePtr(str));
  }
  return Qnil;
}

#set_error_verbosity(verbosity) ⇒ Fixnum

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

  • PQERRORS_TERSE

  • PQERRORS_DEFAULT

  • PQERRORS_VERBOSE

Returns:

  • (Fixnum) 


2113
2114
2115
2116
2117
2118
2119
 
# File 'ext/pg.c', line 2113

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

#set_notice_processor {|message| ... } ⇒ 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.

This function takes a new block to act as the handler, which should accept a single parameter that will be a PGresult 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.

Yields:

  • (message)

Returns:

  • (Proc) 


2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
 
# File 'ext/pg.c', line 2246

static VALUE
pgconn_set_notice_processor(VALUE self)
{
  VALUE proc, old_proc;
  PGconn *conn = get_pgconn(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(conn, NULL, NULL);

  old_proc = rb_iv_get(self, "@notice_processor");
  if( rb_block_given_p() ) {
    proc = rb_block_proc();
    PQsetNoticeProcessor(conn, notice_processor_proxy, (void *)self);
  } else {
    /* if no block is given, set back to default */
    proc = Qnil;
    PQsetNoticeProcessor(conn, default_notice_processor, NULL);
  }

  rb_iv_set(self, "@notice_processor", 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.

This function takes a new block to act as the handler, which should accept a single parameter that will be a PGresult 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.

Yields:

  • (result)

Returns:

  • (Proc) 


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

static VALUE
pgconn_set_notice_receiver(VALUE self)
{
  VALUE proc, old_proc;
  PGconn *conn = get_pgconn(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(conn, NULL, NULL);

  old_proc = rb_iv_get(self, "@notice_receiver");
  if( rb_block_given_p() ) {
    proc = rb_block_proc();
    PQsetNoticeReceiver(conn, notice_receiver_proxy, (void *)self);
  } else {
    /* if no block is given, set back to default */
    proc = Qnil;
    PQsetNoticeReceiver(conn, default_notice_receiver, NULL);
  }

  rb_iv_set(self, "@notice_receiver", proc);
  return old_proc;
}

#setnonblocking(Boolean) ⇒ nil

Sets the nonblocking status of the connection. In the blocking state, calls to PGconn#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 PGconn#send_query will return an error if the socket is not ready for writing. Note: This function does not affect PGconn#exec, because that function doesn’t return until the server has processed the query and returned the results. Returns nil.

Returns:

  • (nil) 


1860
1861
1862
 
# File 'ext/pg.c', line 1860

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

#socket ⇒ Fixnum

Returns the socket’s file descriptor for this connection.

Returns:

  • (Fixnum) 


815
816
817
818
819
820
821
822
 
# File 'ext/pg.c', line 815

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

#status ⇒ Object

Returns status of connection : CONNECTION_OK or CONNECTION_BAD



717
718
719
720
721
 
# File 'ext/pg.c', line 717

static VALUE
pgconn_status(VALUE self)
{
  return INT2NUM(PQstatus(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) 


2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
 
# File 'ext/pg.c', line 2130

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

  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));
  rb_iv_set(self, "@trace_stream", new_file);

  PQtrace(get_pgconn(self), new_fp);
  return Qnil;
}

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

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)

Returns:

  • (nil) 


2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
 
# File 'ext/pg.c', line 2310

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

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

  }
  else {
    /* no block supplied? */
    rb_raise(rb_eArgError, "Must supply block for PGconn#transaction");
  }
  return Qnil;
}

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



734
735
736
737
738
 
# File 'ext/pg.c', line 734

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

#tty ⇒ Object

Returns the connected pgtty. (Obsolete)



689
690
691
692
693
694
695
 
# File 'ext/pg.c', line 689

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

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



1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
 
# File 'ext/pg.c', line 1385

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

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

  to = PQunescapeBytea(from, &to_len);

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

#untrace ⇒ nil

Disables the message tracing.

Returns:

  • (nil) 


2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
 
# File 'ext/pg.c', line 2171

static VALUE
pgconn_untrace(VALUE self)
{
  VALUE trace_stream;
  PQuntrace(get_pgconn(self));
  trace_stream = rb_iv_get(self, "@trace_stream");
  rb_funcall(trace_stream, rb_intern("close"), 0);
  rb_iv_set(self, "@trace_stream", Qnil);
  return Qnil;
}

#user ⇒ Object

Returns the authenticated user name.



634
635
636
637
638
639
640
 
# File 'ext/pg.c', line 634

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