rwlogo
SourcePro C++ 12.0

SourcePro® C++ API Reference Guide



   SourcePro C++
Documentation Home

RWDBPGSSystemHandle Class Reference
[DB Access Module for PostgreSQL]

Provides a mechanism for making direct calls to the PostgreSQL API, and some methods for setting access module-specific properties. More...

#include <rw/db/pgssrc/pgssysh.h>

Inheritance diagram for RWDBPGSSystemHandle:
RWDBSystemHandle

List of all members.

Public Member Functions

RWDBStatus rowsPerCursorFetch (unsigned long value)
unsigned long rowsPerCursorFetch () const
PGconn * dbc () const

Detailed Description

Class RWDBPGSSystemHandle provides methods for setting and retrieving options that affect performance. It also contains the PGconn used by the RWDBConnection.

Note:
Use of this class reduces an application's portability.

Synopsis

 #include <rw/db/pgssrc/pgssysh.h>

 RWDBPGSSystemHandle* sys =
       (RWDBPGSSystemHandle*)myConnection.systemHandle();

Examples

If it is necessary for your application to make calls directly to the PostgreSQL libpq API, proceed as in the following example.

 #include <rw/db/pgssrc/pgsdefs.h>
 #include <rw/db/pgssrc/pgssysh.h>

 RWDBConnection connect = myDbase.connection();
 RWDBPGSSystemHandle* handle =
                (RWDBPGSSystemHandle *) connect.systemHandle();
 PGconn* dbc = handle->dbc();
 // Use dbc for PostgreSQL libpq API calls.

Member Function Documentation

PGconn* RWDBPGSSystemHandle::dbc (  )  const [inline]

Returns a pointer to the PGconn encapsulated by the respective RWDBConnection.

unsigned long RWDBPGSSystemHandle::rowsPerCursorFetch (  )  const

Returns the number of rows that will be fetched from the server with cursor result sets in a single call. The default value is 10.

RWDBStatus RWDBPGSSystemHandle::rowsPerCursorFetch ( unsigned long  value  ) 

Sets value to the number of rows to be fetched from the server with cursor result sets in a single call, and returns an RWDBStatus indicating whether the operation succeeded.

 All Classes Functions Variables Typedefs Enumerations Enumerator Friends

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.