Class: PG::Result
- Inherits:
-
Object
- Object
- PG::Result
- Includes:
- Enumerable, Constants
- Defined in:
- ext/pg_result.c,
lib/pg/result.rb,
ext/pg_result.c
Overview
******************************************************************
The class to represent the query result tuples (rows).
An instance of this class is created as the result of every query.
You may need to invoke the #clear method of the instance when finished with
the result for better memory performance.
Example:
require 'pg'
conn = PGconn.open(:dbname => 'test')
res = conn.exec('SELECT 1 AS a, 2 AS b, NULL AS c')
res.getvalue(0,0) # '1'
res[0]['b'] # '2'
res[0]['c'] # nil
Constant Summary
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
Instance Method Summary collapse
-
#[](n) ⇒ Hash
Returns tuple n as a hash.
-
#check ⇒ nil
(also: #check_result)
Raises appropriate exception if PG::Result is in a bad state.
-
#clear ⇒ nil
Clears the PG::Result object as the result of the query.
-
#cmd_status ⇒ String
Returns the status string of the last query command.
-
#cmd_tuples ⇒ Fixnum
(also: #cmdtuples)
Returns the number of tuples (rows) affected by the SQL command.
-
#column_values(n) ⇒ Array
Returns an Array of the values from the nth column of each tuple in the result.
-
#each {|tuple| ... } ⇒ Object
Invokes block for each tuple in the result set.
-
#each_row {|row| ... } ⇒ Object
Yields each row of the result.
-
#error_field(fieldcode) ⇒ String
(also: #result_error_field)
Returns the individual field of an error.
-
#error_message ⇒ String
(also: #result_error_message)
Returns the error message of the command as a string.
-
#fformat(column_number) ⇒ Fixnum
Returns the format (0 for text, 1 for binary) of column column_number.
-
#field_values(field) ⇒ Array
Returns an Array of the values from the given field of each tuple in the result.
-
#fields ⇒ Array
Returns an array of Strings representing the names of the fields in the result.
-
#fmod(column_number) ⇒ Object
Returns the type modifier associated with column column_number.
-
#fname(index) ⇒ String
Returns the name of the column corresponding to index.
-
#fnumber(name) ⇒ Fixnum
Returns the index of the field specified by the string
name
. -
#fsize(index) ⇒ Object
Returns the size of the field type in bytes.
-
#ftable(column_number) ⇒ Fixnum
Returns the Oid of the table from which the column column_number was fetched.
-
#ftablecol(column_number) ⇒ Fixnum
Returns the column number (within its table) of the table from which the column column_number is made up.
-
#ftype(column_number) ⇒ Object
Returns the data type associated with column_number.
-
#getisnull(tuple_position, field_position) ⇒ Boolean
Returns
true
if the specified value isnil
;false
otherwise. -
#getlength(tup_num, field_num) ⇒ Fixnum
Returns the (String) length of the field in bytes.
-
#getvalue(tup_num, field_num) ⇒ Object
Returns the value in tuple number tup_num, field field_num, or
nil
if the field isNULL
. -
#nfields ⇒ Fixnum
(also: #num_fields)
Returns the number of columns in the query result.
-
#nparams ⇒ Fixnum
Returns the number of parameters of a prepared statement.
-
#ntuples ⇒ Fixnum
(also: #num_tuples)
Returns the number of tuples in the query result.
-
#oid_value ⇒ Fixnum
Returns the
oid
of the inserted row if applicable, otherwisenil
. -
#paramtype(param_number) ⇒ Oid
Returns the Oid of the data type of parameter param_number.
-
#res_status(status) ⇒ String
Returns the string representation of status
status
. -
#result_status ⇒ Fixnum
Returns the status of the query.
-
#values ⇒ Object
Returns all tuples as an array of arrays.
Instance Method Details
#[](n) ⇒ Hash
Returns tuple n as a hash.
707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 |
# File 'ext/pg_result.c', line 707
static VALUE
pgresult_aref(VALUE self, VALUE index)
{
PGresult *result = pgresult_get(self);
int tuple_num = NUM2INT(index);
int field_num;
VALUE fname;
VALUE tuple;
if ( tuple_num < 0 || tuple_num >= PQntuples(result) )
rb_raise( rb_eIndexError, "Index %d is out of range", tuple_num );
tuple = rb_hash_new();
for ( field_num = 0; field_num < PQnfields(result); field_num++ ) {
fname = rb_tainted_str_new2( PQfname(result,field_num) );
ASSOCIATE_INDEX(fname, self);
rb_hash_aset( tuple, fname, pgresult_value(self, result, tuple_num, field_num) );
}
return tuple;
}
|
#check ⇒ nil Also known as: check_result
Raises appropriate exception if PG::Result is in a bad state.
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 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'ext/pg_result.c', line 44
VALUE
pg_result_check( VALUE self )
{
VALUE error, exception, klass;
VALUE rb_pgconn = rb_iv_get( self, "@connection" );
PGconn *conn = pg_get_pgconn(rb_pgconn);
PGresult *result;
#ifdef M17N_SUPPORTED
rb_encoding *enc = pg_conn_enc_get( conn );
#endif
char * sqlstate;
Data_Get_Struct(self, PGresult, result);
if(result == NULL)
{
error = rb_str_new2( PQerrorMessage(conn) );
}
else
{
switch (PQresultStatus(result))
{
case PGRES_TUPLES_OK:
case PGRES_COPY_OUT:
case PGRES_COPY_IN:
#ifdef HAVE_CONST_PGRES_COPY_BOTH
case PGRES_COPY_BOTH:
#endif
#ifdef HAVE_CONST_PGRES_SINGLE_TUPLE
case PGRES_SINGLE_TUPLE:
#endif
case PGRES_EMPTY_QUERY:
case PGRES_COMMAND_OK:
return self;
case PGRES_BAD_RESPONSE:
case PGRES_FATAL_ERROR:
case PGRES_NONFATAL_ERROR:
error = rb_str_new2( PQresultErrorMessage(result) );
break;
default:
error = rb_str_new2( "internal error : unknown result status." );
}
}
#ifdef M17N_SUPPORTED
rb_enc_set_index( error, rb_enc_to_index(enc) );
#endif
sqlstate = PQresultErrorField( result, PG_DIAG_SQLSTATE );
klass = lookup_error_class( sqlstate );
exception = rb_exc_new3( klass, error );
rb_iv_set( exception, "@connection", rb_pgconn );
rb_iv_set( exception, "@result", result ? self : Qnil );
rb_exc_raise( exception );
/* Not reached */
return self;
}
|
#clear ⇒ nil
Clears the PG::Result object as the result of the query.
116 117 118 119 120 121 122 |
# File 'ext/pg_result.c', line 116
VALUE
pg_result_clear(VALUE self)
{
PQclear(pgresult_get(self));
DATA_PTR(self) = NULL;
return Qnil;
}
|
#cmd_status ⇒ String
Returns the status string of the last query command.
652 653 654 655 656 657 658 |
# File 'ext/pg_result.c', line 652
static VALUE
pgresult_cmd_status(VALUE self)
{
VALUE ret = rb_tainted_str_new2(PQcmdStatus(pgresult_get(self)));
ASSOCIATE_INDEX(ret, self);
return ret;
}
|
#cmd_tuples ⇒ Fixnum Also known as: cmdtuples
Returns the number of tuples (rows) affected by the SQL command.
If the SQL command that generated the PG::Result was not one of:
-
INSERT
-
UPDATE
-
DELETE
-
MOVE
-
FETCH
or if no tuples were affected, 0
is returned.
674 675 676 677 678 679 680 |
# File 'ext/pg_result.c', line 674
static VALUE
pgresult_cmd_tuples(VALUE self)
{
long n;
n = strtol(PQcmdTuples(pgresult_get(self)),NULL, 10);
return INT2NUM(n);
}
|
#column_values(n) ⇒ Array
Returns an Array of the values from the nth column of each tuple in the result.
801 802 803 804 805 806 |
# File 'ext/pg_result.c', line 801
static VALUE
pgresult_column_values(VALUE self, VALUE index)
{
int col = NUM2INT( index );
return make_column_result_array( self, col );
}
|
#each {|tuple| ... } ⇒ Object
Invokes block for each tuple in the result set.
836 837 838 839 840 841 842 843 844 845 846 |
# File 'ext/pg_result.c', line 836
static VALUE
pgresult_each(VALUE self)
{
PGresult *result = pgresult_get(self);
int tuple_num;
for(tuple_num = 0; tuple_num < PQntuples(result); tuple_num++) {
rb_yield(pgresult_aref(self, INT2NUM(tuple_num)));
}
return self;
}
|
#each_row {|row| ... } ⇒ Object
Yields each row of the result. The row is a list of column values.
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 |
# File 'ext/pg_result.c', line 734
static VALUE
pgresult_each_row(VALUE self)
{
PGresult* result = (PGresult*) pgresult_get(self);
int row;
int field;
int num_rows = PQntuples(result);
int num_fields = PQnfields(result);
for ( row = 0; row < num_rows; row++ ) {
VALUE new_row = rb_ary_new2(num_fields);
/* populate the row */
for ( field = 0; field < num_fields; field++ ) {
rb_ary_store( new_row, field, pgresult_value(self, result, row, field) );
}
rb_yield( new_row );
}
return Qnil;
}
|
#error_field(fieldcode) ⇒ String Also known as: result_error_field
Returns the individual field of an error.
fieldcode
is one of:
-
PG_DIAG_SEVERITY
-
PG_DIAG_SQLSTATE
-
PG_DIAG_MESSAGE_PRIMARY
-
PG_DIAG_MESSAGE_DETAIL
-
PG_DIAG_MESSAGE_HINT
-
PG_DIAG_STATEMENT_POSITION
-
PG_DIAG_INTERNAL_POSITION
-
PG_DIAG_INTERNAL_QUERY
-
PG_DIAG_CONTEXT
-
PG_DIAG_SOURCE_FILE
-
PG_DIAG_SOURCE_LINE
-
PG_DIAG_SOURCE_FUNCTION
An example:
begin
conn.exec( "SELECT * FROM nonexistant_table" )
rescue PG::Error => err
p [
err.result.error_field( PG::Result::PG_DIAG_SEVERITY ),
err.result.error_field( PG::Result::PG_DIAG_SQLSTATE ),
err.result.error_field( PG::Result::PG_DIAG_MESSAGE_PRIMARY ),
err.result.error_field( PG::Result::PG_DIAG_MESSAGE_DETAIL ),
err.result.error_field( PG::Result::PG_DIAG_MESSAGE_HINT ),
err.result.error_field( PG::Result::PG_DIAG_STATEMENT_POSITION ),
err.result.error_field( PG::Result::PG_DIAG_INTERNAL_POSITION ),
err.result.error_field( PG::Result::PG_DIAG_INTERNAL_QUERY ),
err.result.error_field( PG::Result::PG_DIAG_CONTEXT ),
err.result.error_field( PG::Result::PG_DIAG_SOURCE_FILE ),
err.result.error_field( PG::Result::PG_DIAG_SOURCE_LINE ),
err.result.error_field( PG::Result::PG_DIAG_SOURCE_FUNCTION ),
]
end
Outputs:
["ERROR", "42P01", "relation \"nonexistant_table\" does not exist", nil, nil,
"15", nil, nil, nil, "path/to/parse_relation.c", "857", "parserOpenTable"]
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 |
# File 'ext/pg_result.c', line 272
static VALUE
pgresult_error_field(VALUE self, VALUE field)
{
PGresult *result = pgresult_get( self );
int fieldcode = NUM2INT( field );
char * fieldstr = PQresultErrorField( result, fieldcode );
VALUE ret = Qnil;
if ( fieldstr ) {
ret = rb_tainted_str_new2( fieldstr );
ASSOCIATE_INDEX( ret, self );
}
return ret;
}
|
#error_message ⇒ String Also known as: result_error_message
Returns the error message of the command as a string.
218 219 220 221 222 223 224 |
# File 'ext/pg_result.c', line 218
static VALUE
pgresult_error_message(VALUE self)
{
VALUE ret = rb_tainted_str_new2(PQresultErrorMessage(pgresult_get(self)));
ASSOCIATE_INDEX(ret, self);
return ret;
}
|
#fformat(column_number) ⇒ Fixnum
Returns the format (0 for text, 1 for binary) of column column_number.
Raises ArgumentError if column_number is out of range.
429 430 431 432 433 434 435 436 437 438 439 |
# File 'ext/pg_result.c', line 429
static VALUE
pgresult_fformat(VALUE self, VALUE column_number)
{
PGresult *result = pgresult_get(self);
int fnumber = NUM2INT(column_number);
if (fnumber < 0 || fnumber >= PQnfields(result)) {
rb_raise(rb_eArgError, "Column number is out of range: %d",
fnumber);
}
return INT2FIX(PQfformat(result, fnumber));
}
|
#field_values(field) ⇒ Array
Returns an Array of the values from the given field of each tuple in the result.
816 817 818 819 820 821 822 823 824 825 826 827 |
# File 'ext/pg_result.c', line 816
static VALUE
pgresult_field_values( VALUE self, VALUE field )
{
PGresult *result = pgresult_get( self );
const char *fieldname = StringValuePtr( field );
int fnum = PQfnumber( result, fieldname );
if ( fnum < 0 )
rb_raise( rb_eIndexError, "no such field '%s' in result", fieldname );
return make_column_result_array( self, fnum );
}
|
#fields ⇒ Array
Returns an array of Strings representing the names of the fields in the result.
854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 |
# File 'ext/pg_result.c', line 854
static VALUE
pgresult_fields(VALUE self)
{
PGresult *result = pgresult_get( self );
int n = PQnfields( result );
VALUE fields = rb_ary_new2( n );
int i;
for ( i = 0; i < n; i++ ) {
VALUE val = rb_tainted_str_new2(PQfname(result, i));
ASSOCIATE_INDEX(val, self);
rb_ary_store( fields, i, val );
}
return fields;
}
|
#fmod(column_number) ⇒ Object
Returns the type modifier associated with column column_number. See the #ftype method for an example of how to use this.
Raises an ArgumentError if column_number is out of range.
479 480 481 482 483 484 485 486 487 488 489 490 491 492 |
# File 'ext/pg_result.c', line 479
static VALUE
pgresult_fmod(VALUE self, VALUE column_number)
{
PGresult *result = pgresult_get(self);
int fnumber = NUM2INT(column_number);
int modifier;
if (fnumber < 0 || fnumber >= PQnfields(result)) {
rb_raise(rb_eArgError, "Column number is out of range: %d",
fnumber);
}
modifier = PQfmod(result,fnumber);
return INT2NUM(modifier);
}
|
#fname(index) ⇒ String
Returns the name of the column corresponding to index.
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 |
# File 'ext/pg_result.c', line 318
static VALUE
pgresult_fname(VALUE self, VALUE index)
{
VALUE fname;
PGresult *result;
int i = NUM2INT(index);
result = pgresult_get(self);
if (i < 0 || i >= PQnfields(result)) {
rb_raise(rb_eArgError,"invalid field number %d", i);
}
fname = rb_tainted_str_new2(PQfname(result, i));
ASSOCIATE_INDEX(fname, self);
return fname;
}
|
#fnumber(name) ⇒ Fixnum
Returns the index of the field specified by the string name
. The given name
is treated like an identifier in an SQL command, that is, it is downcased unless double-quoted. For example, given a query result generated from the SQL command:
result = conn.exec( %{SELECT 1 AS FOO, 2 AS "BAR"} )
we would have the results:
result.fname( 0 ) # => "foo"
result.fname( 1 ) # => "BAR"
result.fnumber( "FOO" ) # => 0
result.fnumber( "foo" ) # => 0
result.fnumber( "BAR" ) # => ArgumentError
result.fnumber( %{"BAR"} ) # => 1
Raises an ArgumentError if the specified name
isn’t one of the field names; raises a TypeError if name
is not a String.
357 358 359 360 361 362 363 364 365 366 367 368 369 |
# File 'ext/pg_result.c', line 357
static VALUE
pgresult_fnumber(VALUE self, VALUE name)
{
int n;
Check_Type(name, T_STRING);
n = PQfnumber(pgresult_get(self), StringValuePtr(name));
if (n == -1) {
rb_raise(rb_eArgError,"Unknown field: %s", StringValuePtr(name));
}
return INT2FIX(n);
}
|
#fsize(index) ⇒ Object
Returns the size of the field type in bytes. Returns -1
if the field is variable sized.
res = conn.exec("SELECT myInt, myVarChar50 FROM foo")
res.size(0) => 4
res.size(1) => -1
504 505 506 507 508 509 510 511 512 513 514 515 |
# File 'ext/pg_result.c', line 504
static VALUE
pgresult_fsize(VALUE self, VALUE index)
{
PGresult *result;
int i = NUM2INT(index);
result = pgresult_get(self);
if (i < 0 || i >= PQnfields(result)) {
rb_raise(rb_eArgError,"invalid field number %d", i);
}
return INT2NUM(PQfsize(result, i));
}
|
#ftable(column_number) ⇒ Fixnum
Returns the Oid of the table from which the column column_number was fetched.
Raises ArgumentError if column_number is out of range or if the Oid is undefined for that column.
381 382 383 384 385 386 387 388 389 390 391 392 393 |
# File 'ext/pg_result.c', line 381
static VALUE
pgresult_ftable(VALUE self, VALUE column_number)
{
Oid n ;
int col_number = NUM2INT(column_number);
PGresult *pgresult = pgresult_get(self);
if( col_number < 0 || col_number >= PQnfields(pgresult))
rb_raise(rb_eArgError,"Invalid column index: %d", col_number);
n = PQftable(pgresult, col_number);
return INT2FIX(n);
}
|
#ftablecol(column_number) ⇒ Fixnum
Returns the column number (within its table) of the table from which the column column_number is made up.
Raises ArgumentError if column_number is out of range or if the column number from its table is undefined for that column.
405 406 407 408 409 410 411 412 413 414 415 416 417 418 |
# File 'ext/pg_result.c', line 405
static VALUE
pgresult_ftablecol(VALUE self, VALUE column_number)
{
int col_number = NUM2INT(column_number);
PGresult *pgresult = pgresult_get(self);
int n;
if( col_number < 0 || col_number >= PQnfields(pgresult))
rb_raise(rb_eArgError,"Invalid column index: %d", col_number);
n = PQftablecol(pgresult, col_number);
return INT2FIX(n);
}
|
#ftype(column_number) ⇒ Object
Returns the data type associated with column_number.
The integer returned is the internal OID
number (in PostgreSQL) of the type. To get a human-readable value for the type, use the returned OID and the field’s #fmod value with the format_type() SQL function:
# Get the type of the second column of the result 'res'
typename = conn.
exec( "SELECT format_type($1,$2)", [res.ftype(1), res.fmod(1)] ).
getvalue( 0, 0 )
Raises an ArgumentError if column_number is out of range.
459 460 461 462 463 464 465 466 467 468 |
# File 'ext/pg_result.c', line 459
static VALUE
pgresult_ftype(VALUE self, VALUE index)
{
PGresult* result = pgresult_get(self);
int i = NUM2INT(index);
if (i < 0 || i >= PQnfields(result)) {
rb_raise(rb_eArgError, "invalid field number %d", i);
}
return INT2NUM(PQftype(result, i));
}
|
#getisnull(tuple_position, field_position) ⇒ Boolean
Returns true
if the specified value is nil
; false
otherwise.
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 |
# File 'ext/pg_result.c', line 572
static VALUE
pgresult_getisnull(VALUE self, VALUE tup_num, VALUE field_num)
{
PGresult *result;
int i = NUM2INT(tup_num);
int j = NUM2INT(field_num);
result = pgresult_get(self);
if (i < 0 || i >= PQntuples(result)) {
rb_raise(rb_eArgError,"invalid tuple number %d", i);
}
if (j < 0 || j >= PQnfields(result)) {
rb_raise(rb_eArgError,"invalid field number %d", j);
}
return PQgetisnull(result, i, j) ? Qtrue : Qfalse;
}
|
#getlength(tup_num, field_num) ⇒ Fixnum
Returns the (String) length of the field in bytes.
Equivalent to res.value(tup_num,field_num).length
.
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 |
# File 'ext/pg_result.c', line 597
static VALUE
pgresult_getlength(VALUE self, VALUE tup_num, VALUE field_num)
{
PGresult *result;
int i = NUM2INT(tup_num);
int j = NUM2INT(field_num);
result = pgresult_get(self);
if (i < 0 || i >= PQntuples(result)) {
rb_raise(rb_eArgError,"invalid tuple number %d", i);
}
if (j < 0 || j >= PQnfields(result)) {
rb_raise(rb_eArgError,"invalid field number %d", j);
}
return INT2FIX(PQgetlength(result, i, j));
}
|
#getvalue(tup_num, field_num) ⇒ Object
Returns the value in tuple number tup_num, field field_num, or nil
if the field is NULL
.
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 |
# File 'ext/pg_result.c', line 549
static VALUE
pgresult_getvalue(VALUE self, VALUE tup_num, VALUE field_num)
{
PGresult *result;
int i = NUM2INT(tup_num);
int j = NUM2INT(field_num);
result = pgresult_get(self);
if(i < 0 || i >= PQntuples(result)) {
rb_raise(rb_eArgError,"invalid tuple number %d", i);
}
if(j < 0 || j >= PQnfields(result)) {
rb_raise(rb_eArgError,"invalid field number %d", j);
}
return pgresult_value(self, result, i, j);
}
|
#nfields ⇒ Fixnum Also known as: num_fields
Returns the number of columns in the query result.
306 307 308 309 310 |
# File 'ext/pg_result.c', line 306
static VALUE
pgresult_nfields(VALUE self)
{
return INT2NUM(PQnfields(pgresult_get(self)));
}
|
#nparams ⇒ Fixnum
Returns the number of parameters of a prepared statement. Only useful for the result returned by conn.describePrepared
621 622 623 624 625 626 627 628 |
# File 'ext/pg_result.c', line 621
static VALUE
pgresult_nparams(VALUE self)
{
PGresult *result;
result = pgresult_get(self);
return INT2FIX(PQnparams(result));
}
|
#ntuples ⇒ Fixnum Also known as: num_tuples
Returns the number of tuples in the query result.
294 295 296 297 298 |
# File 'ext/pg_result.c', line 294
static VALUE
pgresult_ntuples(VALUE self)
{
return INT2FIX(PQntuples(pgresult_get(self)));
}
|
#oid_value ⇒ Fixnum
Returns the oid
of the inserted row if applicable, otherwise nil
.
689 690 691 692 693 694 695 696 697 |
# File 'ext/pg_result.c', line 689
static VALUE
pgresult_oid_value(VALUE self)
{
Oid n = PQoidValue(pgresult_get(self));
if (n == InvalidOid)
return Qnil;
else
return INT2FIX(n);
}
|
#paramtype(param_number) ⇒ Oid
Returns the Oid of the data type of parameter param_number. Only useful for the result returned by conn.describePrepared
637 638 639 640 641 642 643 644 |
# File 'ext/pg_result.c', line 637
static VALUE
pgresult_paramtype(VALUE self, VALUE param_number)
{
PGresult *result;
result = pgresult_get(self);
return INT2FIX(PQparamtype(result,NUM2INT(param_number)));
}
|
#res_status(status) ⇒ String
Returns the string representation of status status
.
204 205 206 207 208 209 210 |
# File 'ext/pg_result.c', line 204
static VALUE
pgresult_res_status(VALUE self, VALUE status)
{
VALUE ret = rb_tainted_str_new2(PQresStatus(NUM2INT(status)));
ASSOCIATE_INDEX(ret, self);
return ret;
}
|
#result_status ⇒ Fixnum
Returns the status of the query. The status value is 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
191 192 193 194 195 |
# File 'ext/pg_result.c', line 191
static VALUE
pgresult_result_status(VALUE self)
{
return INT2FIX(PQresultStatus(pgresult_get(self)));
}
|
#values ⇒ Object
Returns all tuples as an array of arrays
9 10 11 |
# File 'lib/pg/result.rb', line 9 def values return enum_for(:each_row).to_a end |