SourcePro® API Reference Guide

 
Loading...
Searching...
No Matches

Provides methods for setting and retrieving certain connect time and configuration parameters with PostgreSQL. More...

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

Inheritance diagram for RWDBPGSEnvironmentHandle:
RWDBEnvironmentHandle

Public Member Functions

bool binaryAsLo () const
 
void binaryAsLo (bool flag)
 
int connectTimeout () const
 
void connectTimeout (int value)
 
RWCString serviceName () const
 
void serviceName (const RWCString &name)
 
- Public Member Functions inherited from RWDBEnvironmentHandle
 RWDBEnvironmentHandle ()
 
bool cacheResultSchemas () const
 
bool cacheResultSchemas (bool value)
 
virtual bool foreignKeysFromView ()
 
virtual bool foreignKeysFromView (bool value)
 
size_t maxCachedResultSets () const
 
size_t maxCachedResultSets (size_t value)
 

Detailed Description

Class RWDBPGSEnvironmentHandle provides methods for setting and retrieving certain connect time and configuration parameters.

Please note that some connect time parameters are set only when a connection is established with the server. When the method returns a valid RWDBStatus for these parameters, it does not necessarily mean that the connection parameter has been accepted by the server. Appropriate error messages are fielded to the application only when a connection is established.

Note
Use of this class reduces an application's portability.
Synopsis
#include <rw/db/pgssrc/pgsenvh.h>
(RWDBPGSEnvironmentHandle*)myDatabase.environmentHandle();
Provides methods for setting and retrieving certain connect time and configuration parameters with Po...
Definition pgsenvh.h:65
Example
The following example shows how to gain access to RWDBPGSEnvironmentHandle to set the connection timeout value. Note that the application must be compiled with an include path to the PostgreSQL libpq include files.
#include <rw/db/pgssrc/pgsenvh.h>
RWDBEnvironmentHandle* enH = adb.environmentHandle();
pgsH->connectTimeout(30);
RWDBConnection conn = adb.connection();
Represents an explicit database connection object that can be used in place of the implicit database ...
Definition connect.h:81
Abstract base class from which all vendor-specific environment handles must derive....
Definition envhandl.h:64
void connectTimeout(int value)

Member Function Documentation

◆ binaryAsLo() [1/2]

bool RWDBPGSEnvironmentHandle::binaryAsLo ( ) const

Returns true if RWDBBlob should map to the user-defined datatype LO when selecting data or performing queries. The default is false.

◆ binaryAsLo() [2/2]

void RWDBPGSEnvironmentHandle::binaryAsLo ( bool flag)

Sets a flag indicating that RWDBBlob should map to the user-defined datatype LO when selecting data or performing queries.

◆ connectTimeout() [1/2]

int RWDBPGSEnvironmentHandle::connectTimeout ( ) const

Returns the current value for the maximum number of seconds the PostgreSQL library waits for a login response when making a connection attempt.

◆ connectTimeout() [2/2]

void RWDBPGSEnvironmentHandle::connectTimeout ( int value)

Sets the maximum number of seconds that the PostgreSQL library should wait for a login response when making a connection attempt. The default is 0.

◆ serviceName() [1/2]

RWCString RWDBPGSEnvironmentHandle::serviceName ( ) const

Returns the service name that is to be used in the connect string passed to PQconnectdb().

◆ serviceName() [2/2]

void RWDBPGSEnvironmentHandle::serviceName ( const RWCString & name)

Sets the service name to be passed to PQconnectdb(). The service name holds additional connection parameters.

Please see the PostgreSQL documentation for details.

Copyright © 2024 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.