Module: PG
- Includes:
- Constants
- Defined in:
- lib/pg.rb,
lib/pg/coder.rb,
lib/pg/exceptions.rb,
lib/pg/text_decoder.rb,
lib/pg/text_encoder.rb,
ext/pg.c
Overview
The top-level PG namespace.
Defined Under Namespace
Modules: BasicTypeRegistry, BinaryDecoder, BinaryEncoder, Constants, TextDecoder, TextEncoder Classes: BasicTypeMapBasedOnResult, BasicTypeMapForQueries, BasicTypeMapForResults, Coder, CompositeCoder, CompositeDecoder, CompositeEncoder, Connection, ConnectionBad, CopyCoder, CopyDecoder, CopyEncoder, Error, InvalidChangeOfResultFields, InvalidResultStatus, NoResultError, NotAllCopyDataRetrieved, Result, ServerError, SimpleCoder, SimpleDecoder, SimpleEncoder, TypeMap, TypeMapAllStrings, TypeMapByClass, TypeMapByColumn, TypeMapByMriType, TypeMapByOid, TypeMapInRuby, UnableToSend
Constant Summary collapse
- VERSION =
Library version
'1.0.0'
- REVISION =
VCS revision
%q$Revision: fef434914848 $
- ERROR_CLASSES =
rb_hErrors
Constants included from Constants
Constants::CONNECTION_AUTH_OK, Constants::CONNECTION_AWAITING_RESPONSE, Constants::CONNECTION_BAD, Constants::CONNECTION_MADE, Constants::CONNECTION_NEEDED, Constants::CONNECTION_OK, Constants::CONNECTION_SETENV, Constants::CONNECTION_SSL_STARTUP, Constants::CONNECTION_STARTED, Constants::INVALID_OID, Constants::INV_READ, Constants::INV_WRITE, Constants::InvalidOid, Constants::PGRES_BAD_RESPONSE, Constants::PGRES_COMMAND_OK, Constants::PGRES_COPY_BOTH, Constants::PGRES_COPY_IN, Constants::PGRES_COPY_OUT, Constants::PGRES_EMPTY_QUERY, Constants::PGRES_FATAL_ERROR, Constants::PGRES_NONFATAL_ERROR, Constants::PGRES_POLLING_FAILED, Constants::PGRES_POLLING_OK, Constants::PGRES_POLLING_READING, Constants::PGRES_POLLING_WRITING, Constants::PGRES_SINGLE_TUPLE, Constants::PGRES_TUPLES_OK, Constants::PG_DIAG_COLUMN_NAME, Constants::PG_DIAG_CONSTRAINT_NAME, Constants::PG_DIAG_CONTEXT, Constants::PG_DIAG_DATATYPE_NAME, Constants::PG_DIAG_INTERNAL_POSITION, Constants::PG_DIAG_INTERNAL_QUERY, Constants::PG_DIAG_MESSAGE_DETAIL, Constants::PG_DIAG_MESSAGE_HINT, Constants::PG_DIAG_MESSAGE_PRIMARY, Constants::PG_DIAG_SCHEMA_NAME, Constants::PG_DIAG_SEVERITY, Constants::PG_DIAG_SOURCE_FILE, Constants::PG_DIAG_SOURCE_FUNCTION, Constants::PG_DIAG_SOURCE_LINE, Constants::PG_DIAG_SQLSTATE, Constants::PG_DIAG_STATEMENT_POSITION, Constants::PG_DIAG_TABLE_NAME, Constants::PQERRORS_DEFAULT, Constants::PQERRORS_TERSE, Constants::PQERRORS_VERBOSE, Constants::PQPING_NO_ATTEMPT, Constants::PQPING_NO_RESPONSE, Constants::PQPING_OK, Constants::PQPING_REJECT, Constants::PQTRANS_ACTIVE, Constants::PQTRANS_IDLE, Constants::PQTRANS_INERROR, Constants::PQTRANS_INTRANS, Constants::PQTRANS_UNKNOWN, Constants::SEEK_CUR, Constants::SEEK_END, Constants::SEEK_SET
Class Method Summary collapse
-
.connect(*args) ⇒ Object
Convenience alias for PG::Connection.new.
-
.init_openssl(do_ssl, do_crypto) ⇒ nil
Allows applications to select which security libraries to initialize.
-
.init_ssl(do_ssl) ⇒ nil
Allows applications to select which security libraries to initialize.
-
.isthreadsafe ⇒ Object
Returns
true
if libpq is thread-safe,false
otherwise. -
.library_version ⇒ Integer
Get the version of the libpq library in use.
-
.version_string(include_buildnum = false) ⇒ Object
Get the PG library version.
Class Method Details
.connect(*args) ⇒ Object
Convenience alias for PG::Connection.new.
55 56 57 |
# File 'lib/pg.rb', line 55 def self::connect( *args ) return PG::Connection.new( *args ) end |
.init_openssl(do_ssl, do_crypto) ⇒ nil
Allows applications to select which security libraries to initialize.
If your application initializes libssl and/or libcrypto libraries and libpq is built with SSL support, you should call PG.init_openssl() to tell libpq that the libssl and/or libcrypto libraries have been initialized by your application, so that libpq will not also initialize those libraries. See h71000.www7.hp.com/doc/83final/BA554_90007/ch04.html for details on the SSL API.
When do_ssl is true
, libpq will initialize the OpenSSL library before first opening a database connection. When do_crypto is true
, the libcrypto library will be initialized. By default (if PG.init_openssl() is not called), both libraries are initialized. When SSL support is not compiled in, this function is present but does nothing.
If your application uses and initializes either OpenSSL or its underlying libcrypto library, you must call this function with false
for the appropriate parameter(s) before first opening a database connection. Also be sure that you have done that initialization before opening a database connection.
350 351 352 353 354 355 356 |
# File 'ext/pg.c', line 350
static VALUE
pg_s_init_openssl(VALUE self, VALUE do_ssl, VALUE do_crypto)
{
UNUSED( self );
PQinitOpenSSL(pg_to_bool_int(do_ssl), pg_to_bool_int(do_crypto));
return Qnil;
}
|
.init_ssl(do_ssl) ⇒ nil
Allows applications to select which security libraries to initialize.
This function is equivalent to PG.init_openssl(do_ssl, do_ssl)
. It is sufficient for applications that initialize both or neither of OpenSSL and libcrypto.
368 369 370 371 372 373 374 |
# File 'ext/pg.c', line 368
static VALUE
pg_s_init_ssl(VALUE self, VALUE do_ssl)
{
UNUSED( self );
PQinitSSL(pg_to_bool_int(do_ssl));
return Qnil;
}
|
.isthreadsafe ⇒ Boolean .is_threadsafe? ⇒ Boolean .threadsafe? ⇒ Boolean
Returns true
if libpq is thread-safe, false
otherwise.
307 308 309 310 311 312 |
# File 'ext/pg.c', line 307
static VALUE
pg_s_threadsafe_p(VALUE self)
{
UNUSED( self );
return PQisthreadsafe() ? Qtrue : Qfalse;
}
|
.library_version ⇒ Integer
Get the version of the libpq library in use. 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.
291 292 293 294 295 296 |
# File 'ext/pg.c', line 291
static VALUE
pg_s_library_version(VALUE self)
{
UNUSED( self );
return INT2NUM(PQlibVersion());
}
|
.version_string(include_buildnum = false) ⇒ Object
Get the PG library version. If include_buildnum
is true
, include the build ID.
47 48 49 50 51 |
# File 'lib/pg.rb', line 47 def self::version_string( include_buildnum=false ) vstring = "%s %s" % [ self.name, VERSION ] vstring << " (build %s)" % [ REVISION[/: ([[:xdigit:]]+)/, 1] || '0' ] if include_buildnum return vstring end |