Connection properties v13

The following table describes the connection properties that you can specify through the dialog boxes in the graphical connection manager tools or in the odbc.ini file that defines a named data source. The columns identify the connection property (as it appears in the ODBC Administrator dialogs), the corresponding keyword (as it appears in the odbc.ini file), the default value of the property, and a description of the connection property.

PropertyKeyword nameDefault valueDescription
DatabaseDatabaseNoneThe name of the database to which you're connecting.
DriverDriverEDB-ODBCThe name of the ODBC driver.
ServerServernameLocalhostThe name or IP address of the server that you're connecting to.
dbms_namedbms_nameEnterpriseDBDatabase system. Either EnterpriseDB or PostgreSQL.
DescriptionDescriptionDescriptive name of the data source.
User NameUsernameThe name of the user that this data source uses to connect to the server.
PasswordPasswordThe password of the user associated with this named data source.
CPTimeoutCPTimeout0Number of seconds before a connection times out (in a connection pooling environment).
PortPort5444The TCP port that the postmaster is listening on.
ProtocolProtocol7.4If specified, forces the driver to use the given protocol version.
Level of Rollback on ErrorsUse the Protocol option to specify rollback behavior.Transaction LevelSpecifies how the driver handles errors:

0 - Don't roll back

1 - Roll back the transaction

2 - Roll back the statement
Usage CountUsageCount1The number of installations using this driver.
Read OnlyReadOnlyNoSpecifies that the connection is READONLY.
Show System TablesShowSystemTablesNoIf enabled, the driver reports system tables in the result set of the SQLTables() function.
OID Options: Show ColumnShowOidColumnNoIf enabled, the SQLColumns() function reports the OID column.
OID Options: Fake IndexFakeOidIndexNoIf enabled, the SQLStatistics() function reports that a unique index exists on each OID column.
Keyset Query OptimizationKsqoOnIf enabled, enforces server-side support for keyset queries (generated by the MS Jet database engine).
Recognize Unique IndexesUniqueIndexOnIf enabled, the SQLStatistics() function reports unique indexes. If not enabled, the SQLStatistics() function reports that indexes allow duplicate values.
Use Declare/FetchUseDeclareFetchOffIf enabled, the driver uses server-side cursors. To enable UseDeclareFetch, specify a value of 1. To disable UseDeclareFetch, specify a value of 0.
CommLogCommLogOffIf enabled, records all client/server traffic in a log file.
Parse StatementsParseOffIf enabled, the driver parses simple SELECT statements when you call the SQLNumResultCols(), SQLDescribeCol(), or SQLColAttributes() functions.
Cancel as FreeStmtCancelAsFreeStmtOffIf enabled, the SQLCancel() function calls SQLFreeStmt(SQL_Close) on your behalf.
MyLogDebugOffIf enabled, the driver records its work in a log file. On Windows, the file name is C:m[ylog](<>)<process-id>. On Linux the file name is /tmp/[mylog](<>)<username><process-id>.log.
Unknown SizesUnknownSizesMaximumDetermines how the SQLDescribeCol() and SQLColAttributes() functions compute the size of a column. Specify 0 to force the driver to report the maximum size allowed for the type. Specify 1 to force the driver to report an unknown length or 2 to force the driver to search the result set to find the longest value. Don't specify 2 if you enabled UseDeclareFetch.
Text as LongVarcharTextAsLongVarChar8190If enabled, the driver treats TEXT columns as if they are of type SQL_LONGVARCHAR. If disabled, the driver treats TEXT columns as SQL_VARCHAR values.
Unknown as Long VarcharLongVarCharFalseIf enabled, the driver treats values of unknown type as SQL_LONGVARCHAR values. If disabled, the driver treats values of unknown type as SQL_VARCHAR values. By default, values of unknown type are treated as Y values.
Bools as CharBoolsAsCharOnIf enabled, the driver treats BOOL columns as SQL_CHAR values. If disabled, BOOL columns are treated as SQL_BIT values.
Max VarcharMaxVarcharSize255If enabled, the driver treats VARCHAR and BPCHAR values longer than MaxVarCharSize as SQL_LONGVARCHAR values
Max Long Varchar SizeMaxLongVarcharSize8190If TextAsLongVarChar is on, the driver reports TEXT values are MaxLongVarcharSize bytes long.

If UnknownAsLongVarChar is on, columns of unknown type are MaxLongVarcharSize bytes long. Otherwise, they are reported to be MaxVarcharSize bytes in length.
Cache SizeFetch100Determines the number of rows fetched by the driver when UseDeclareFetch is enabled.
SysTable PrefixesExtraSysTablePrefixesdd;Use the SysTablePrefixes field to specify a semicolon-delimited list of prefixes that indicate that a table is a system table. By default, the list contains [dd](<>);.
Cumulative Row Count for InsertMapSqlParcNoBatchOff/0If enabled, the SQLRowCount() function returns a single, cumulative row count for the entire array of parameter settings for an INSERT statement. If disabled, an individual row count is returned for each parameter setting. By default, this option is disabled.
LF<-> CR/LF conversionLFConversionSystem DependentThe LF<->CR/LF conversion option instructs the driver to convert line-feed characters to carriage-return/line-feed pairs when fetching character values from the server and convert them back to line-feed characters when sending character values to the server. By default, this option is enabled.
Updatable CursorsUpdatableCursorsOffPermits positioned UPDATE and DELETE operations using the SQLSetPos() or SQLBulkOperations() functions.
Bytea as Long VarBinaryByteaAsLongVarBinaryOffIf enabled, the driver treats BYTEA values as if they're of type SQL_LONGVARBINARY. If disabled, BYTEA values are treated as SQL_VARBINARY values.
Bytea as LOByteaAsLOFalseIf enabled, the driver treats BYTEA values as if they're large objects.
Row versioningRowVersioningOffThe Row Versioning option specifies if the driver includes the xmin column when reporting the columns in a table. The xmin value is the ID of the transaction that created the row. You must use row versioning if you plan to create cursors where SQL_CONCURRENCY = SQL_CONCUR_ROWVER.
Disallow PrematureDisallowPrematureNo/0Determines driver behavior if you try to retrieve information about a query without executing the query. If Yes, the driver declares a cursor for the query and fetches the metadata from the cursor. If No, the driver executes the command as soon as you request any metadata.
True is -1TrueIsMinus1Off/0TrueIsMinus1 tells the driver to return BOOL values of TRUE as -1. If this option isn't enabled, the driver returns BOOL values of TRUE as 1. The driver always returns BOOL values of FALSE as 0.
Server side prepareUseServerSidePrepareNo/0If enabled, the driver uses the PREPARE and EXECUTE commands to implement the Prepare/Execute model.
Use GSSAPI for GSS requestGssAuthUseGSSFalse/0If set to True/1, the driver sends a GSSAPI authentication request to the server. Windows only.
Int8 AsBI0The value of BI determines how the driver treats BIGINT values:

If -5 as a SQL_BIGINT,

If 2 as a SQL_NUMERIC,

If 8 as a SQL_DOUBLE,

If 4 as a SQL_INTEGER,

If 12 as a SQL_VARCHAR,

If 0 (on an MS Jet client), as a SQL_NUMERIC,

If 0 on any other client, as a SQL_BIGINT.
Extra options

Connect Settings
AB

ConnSettings
0x00x1 - Forces the output of short-length formatted connection strings. Specify this option if you're using the MFC CDatabase class.

0x2 - Allows MS Access to recognize PostgreSQL's serial type as AutoNumber type.

0x4 - Return ANSI character types for the inquiries from applications. Specify this option for applications that have difficulty handling Unicode data.

0x8 - If set, NULL dates are reported as empty strings and empty strings are interpreted as NULL dates on input.

0x10 - Determines if SQLGetInfo returns information about all tables or only accessible tables. If set, information is returned only for accessible tables.

0x20 - If set, each SQL command is processed in a separate network round trip. otherwise, SQL commands are grouped into as few round trips as possible to reduce network latency. Contains a semicolon-delimited list of SQL commands that are executed when the driver connects to the server.
Socket4096Specifies the buffer size that the driver uses to connect to the client.
LieOffIf enabled, the driver claims to support unsupported ODBC features.
Lowercase IdentifierLowerCaseIdentifierOffIf enabled, the driver translates identifiers to lower case.
Disable Genetic OptimizerOptimizerYes/1Disables the genetic query optimizer.
Allow KeysetUpdatableCursorsYes/1Allow Keyset-driven cursors
SSL modeSSLModeDisabledIf libpq (and its dependencies) are installed in the same directory as the EDB-ODBC driver, enabling SSL mode allows you to use SSL and other utilities.
Force Abbreviated Connection StringCXNo/0Enables the option to force abbreviation of connection string.
Fake MSSFakeOidIndexNo/0Impersonates MS SQL Server, enabling MS Access to recognize PostgreSQL’s serial type as AutoNumber type.
BDE EnvironmentBDENo/0Enabling this option tunes EDB-ODBC to cater to Borland Database Engine-compliant output (related to Unicode).
XA_OptINI_XAOPTYes/1If enabled, calls to SQL_TABLES include only user-accessible tables.

Adding a data source definition in Windows

The Windows ODBC Data Source Administrator is a graphical interface that creates named data sources. To open the ODBC Data Source Administrator, in the Control Panel, open the Administrative Tools menu and double-click the appropriate ODBC Data Sources icon (32-bit or 64-bit).

Select Add to open the Create New Data Source dialog box. Select EnterpriseDB (ANSI) or EnterpriseDB (UNICODE) from the list of drivers and select Finish.

Use the fields on the EnterpriseDB ODBC Driver dialog box to define the named data source:

  • Enter the database name in the Database field.
  • Enter the host name or IP address of EDB Postgres Advanced Server in the Server field.
  • Enter the name of a user in the User Name field.
  • Enter a descriptive name for the named data source in the Description field.
  • If libpq is installed in the same directory as the EDB-ODBC driver, the list next to the SSL Mode label is active, allowing you to use SSL and other EDB Postgres Advanced Server utilities.
  • Accept the default port number (5444), or enter an alternative number in the Port field.
  • Enter the password of the user in the Password field.

Select Datasource (located in the Options box) to open the Advanced Options dialog box and specify connection properties.

Select Global to open a dialog where you can specify logging options for the EDB-ODBC driver (not the data source, but the driver).

  • Select Disable Genetic Optimizer to disable the genetic query optimizer. By default, the query optimizer is on.
  • Select KSQO (Keyset Query Optimization) to enable server-side support for keyset queries. By default, Keyset Query Optimization is on.
  • Select Recognize Unique Indexes to force the SQLStatistics() function to report unique indexes. If the option is not selected, the SQLStatistics() function reports that all indexes allow duplicate values. By default, Recognize Unique Indexes is on.
  • Select Use Declare/Fetch to specify for the driver to use server-side cursors whenever your application executes a SELECT command. By default, Use Declare/Fetch is off.
  • Select CommLog (C:\psqlodbc_xxxx.log) to record all client/server traffic in a log file. By default, logging is off.
  • Select Parse Statements to specify for the driver (rather than the server) to attempt to parse simple SELECT statements when you call the SQLNumResultCols(), SQLDescribeCol(), or SQLColAttributes() function. By default, this option is off.
  • Select Cancel as FreeStmt (Exp) to specify for the SQLCancel() function to call SQLFreeStmt(SQLClose) on your behalf. By default, this option is off.
  • Select MyLog (C:\mylog_xxxx.log) to record a detailed record of driver activity in a log file. The log file is named c:\mylog\_\ *process-id*.log. By default, logging is off.

The radio buttons in the Unknown Sizes box specify how the SQLDescribeCol() and SQLColAttributes() functions compute the size of a column of unknown type.

  • Select Maximum to specify for the driver to report the maximum size allowed for a VARCHAR or LONGVARCHAR (dependent on the Unknowns as LongVarChar setting). If Unknowns as LongVarChar is enabled, the driver returns the maximum size of a LONGVARCHAR (specified in the Max LongVarChar field in the Miscellaneous box). If Unknowns as LongVarChar is cleared, the driver returns the size specified in the Max VarChar field in the Miscellaneous box.
  • Select Don’t know to specify for the driver to report a length of unknown.
  • Select Longest to specify for the driver to search the result set and report the longest value found. Don't specify Longest if UseDeclareFetch is enabled.)

The properties in the Data Type Options box determine how the driver treats columns of specific types:

  • Select Text as LongVarChar to treat TEXT values as if they are of type SQL_LONGVARCHAR. If cleared, the driver treats TEXT values as SQL_VARCHAR values. By default, TEXT values are treated as SQL_LONGVARCHAR values.
  • Select Unknowns as LongVarChar to specify for the driver to treat values of unknown type as SQL_LONGVARCHAR values. If cleared, the driver treats values of unknown type as SQL_VARCHAR values. By default, values of unknown type are treated as SQL_VARCHAR values.
  • Select Bools as Char to specify for the driver to treat BOOL values as SQL_CHAR values. If cleared, BOOL values are treated as SQL_BIT values. By default, BOOL values are treated as SQL_CHAR values.

You can specify values for some of the properties associated with the named data source in the fields in the Miscellaneous box:

  • Indicate the maximum length allowed for a VARCHAR value in the Max VarChar field. By default, this value is set to 255.
  • Enter the maximum length allowed for a LONGVARCHAR value in the Max LongVarChar field. By default, this value is set to 8190.
  • Specify the number of rows fetched by the driver (when UseDeclareFetch is enabled) in the Cache Size field. The default value is 100.
  • Use the SysTablePrefixes field to specify a semicolon-delimited list of prefixes that indicate that a table is a system table. By default, the list contains dd_;.

You can reset the values on this dialog box to their default settings by selecting Defaults.

Select Apply button to apply any changes to the data source properties. Select OK to apply any changes and exit.

Select Page 2 (in the upper-left corner of the Advanced Options dialog box) to access a second set of advanced options.

  • Select Read Only to prevent the driver from executing the following commands: INSERT, UPDATE, DELETE, CREATE, ALTER, DROP, GRANT, REVOKE or LOCK. Invoking the Read Only option also prevents any calls that use ODBC’s procedure call escape syntax (call=procedure-name?). By default, this option is off.
  • Select Show System Tables to include system tables in the result set of the SQLTables() function. If the option is enabled, the driver includes any table whose name starts with pg\_ or any of the prefixes listed in the SysTablePrefixes field of Page 1 of the Advanced Options dialog box. By default, this option is off.
  • Select Show sys/dbo Tables [Access] to access objects in the sys schema and dbo schema through the ODBC data source. By default, this option is on.
  • Select Show sys/SQL Tables to enable accessing database tables in a linked server with MS SQL.
  • Select Cumulative Row Count for Insert to cause a single, cumulative row count to be returned for the entire array of parameter settings for an INSERT statement when a call to the SQLRowCount() method is performed. If this option is cleared, then an individual row count is available for each parameter setting in the array and thus a call to SQLRowCount() returns the count for the last inserted row.
  • Select LF<->CR/LF conversion to instruct the driver to convert line-feed characters to carriage-return/line-feed pairs when fetching character values from the server and convert them back to line-feed characters when sending character values to the server. By default, this option is on.
  • Select Updatable Cursors to specify for the driver to permit positioned UPDATE and DELETE operations with the SQLSetPos() or SQLBulkOperations() functions. By default, this option is on.
  • Select bytea as LO to specify for the driver to treat BYTEA values as if they're SQL_LONGVARBINARY values. If cleared, EDB-ODBC treats BYTEA values as if they are SQL_VARBINARY values. By default, BYTEA values are treated as SQL_VARBINARY values.
  • Select Row Versioning to include the xmin column when reporting the columns in a table. The xmin column is the ID of the transaction that created the row. You must use row versioning if you plan to create cursors where SQL_CONCURRENCY = SQL_CONCUR_ROWVER. By default, this option is off.
  • Select Disallow Premature to specify for the driver to retrieve metadata about a query (the number of columns in a result set or the column types) without actually executing the query. If this option is cleared, the driver executes the query when you request metadata about the query. By default, this option is off.
  • Select True is -1 to tell the driver to return BOOL values of True as a -1. If this option is cleared, the driver returns BOOL values of True as 1. The driver always returns BOOL values of False as 0.
  • Select Server side prepare to tell the driver to use the PREPARE and EXECUTE commands to implement the Prepare/Execute model. By default, this option is on.
  • Select use gssapi for GSS request to instruct the driver to send a GSSAPI connection request to the server.
  • Enter the database system (either EnterpriseDB or PostgreSQL) in the dbms_name field. The value entered here is returned in the SQL_DBMS_NAME argument when the SQLGetInfo() function is called. The default is EnterpriseDB.

Use the options in the Int8 As box to specify how the driver returns BIGINT values to the client. Select default to specify the default type of NUMERIC if the client is MS Jet. Select BIGINT if the client is any other ODBC client. You can optionally specify for the driver to return BIGINT values as a bigint (SQL_BIGINT), numeric (SQL_NUMERIC), varchar (SQL_VARCHAR), double (SQL_DOUBLE), or int4 (SQL_INTEGER).

The default value of the Extra Opts field is 0x0. For Extra Opts, you can specify the options shown in the table.

OptionSpecifies
0x1Forces the output of short-length formatted connection string. Select this option when you're using the MFC CDatabase class.
0x2Allows MS Access to recognize PostgreSQL's serial type as AutoNumber type.
0x4Returns ANSI character types for the inquiries from applications. Select this option for applications that have difficulty handling Unicode data.
0x8If set, NULL dates are reported as empty strings, and empty strings are interpreted as NULL dates on input.
0x10Determines if SQLGetInfo returns information about all tables or only accessible tables. If set, information is returned only for accessible tables.
0x20If set, each SQL command is processed in a separate network round trip. Otherwise, SQL commands are grouped into as few round trips as possible to reduce network latency.

The Protocol box contains options that tell the driver to interact with the server using a specific front-end/back-end protocol version. By default, the protocol selected is 7.4+. You can optionally select from versions 6.4+, 6.3, or 6.2.

The Level of Rollback on Errors box contains options that specify how the driver handles error handling.

OptionSpecifies
TransactionIf the driver encounters an error, it rolls back the current transaction.
StatementIf the driver encounters an error, it rolls back the current statement.
NopIf the driver encounters an error, you must manually roll back the current transaction before the application can continue.

The OID Options box contains options that control the way the driver exposes the OID column contained in some tables:

  • Select Show Column to include the OID column in the result set of the SQLColumns() function. If cleared, the OID column is hidden from SQLColumns().
  • Select Fake Columns to specify for the SQLStatistics() function to report that a unique index exists on each OID column.

Use the Connect Settings field to specify a list of parameter assignments for the driver to use when opening this connection. Any configuration parameter that you can modify with a SET statement can be included in the semicolon-delimited list. For example:

set search_path to company1,public;

After you define the connection properties for the named data source, select Apply to apply the options. Select OK to save the options and exit.

Select Global (on the EnterpriseDB ODBC Driver dialog box) to open the Global Settings dialog box. The options on this dialog box control logging options for the EDB-ODBC driver. Use this dialog box to enforce logging when the driver is used without a named data source or for logging driver operations that occur before the connection string is parsed.

  • Select CommLog to record all client/server traffic in a log file. The log file is named C:\psqlodbc_<process-id>, where <process-id> is the name of the process in use.
  • Select Mylog to keep a log file of the driver’s activity. The log file is named c:\mylog_<process-id>, where <process-id> is the name of the process in use.
  • Specify a location for the log files in the Folder for logging field. After you entered the connection information for the named data source, select Test to verify that the driver manager can connect to the defined data source.

Select OK to exit the Connection Test dialog box. If the connection is successful, select Save to save the named data source. If there are problems establishing a connection, adjust the parameters and test again.

Adding a data source definition in Linux

The Linux ODBC Administrator is a graphical tool distributed with unixODBC. You can use the ODBC Administrator to manage ODBC drivers and named resources. To add the ODBC Administrator to your system, open a terminal window, assume superuser privileges, and enter:

yum install unixODBC

yum install unixODBC-kde

To invoke the ODBC Administrator, open a terminal window and enter ODBCConfig.

When you install the EDB Postgres Advanced Server Connectors component, the EDB-ODBC driver is added to the list of drivers in the ODBC Administrator. Select Advanced, and then select the Drivers tab to verify that the enterprisedb driver appears in the list.

If the EDB-ODBC driver doesn't appear in the list of drivers, you can add it using the ODBC Administrator. To add a driver definition, select the Drivers tab, and select Add.

In the Driver Properties window, register the EDB-ODBC driver with the driver manager:

  • Add a unique name for the driver to the Name field.

  • Add a driver description to the Description field.

  • Add the path to the location of the EDB-ODBC driver in the Driver field. By default, the complete path to the driver is /usr/edb/odbc/lib/edb-odbc.so.

  • Add the path to the location of the EDB-ODBC driver setup file in the Setup field. By default, the complete path to the driver setup file is /usr/edb/odbc/lib/libodbcedbS.so.

After you enter the driver properties for the EDB-ODBC driver, select OK. The ODBC Data Source Administrator window now includes the EDB-ODBC driver in the list of available ODBC drivers.

With the EDB-ODBC driver available to the driver manager, you can add a data source. Select the Data Source Names option in the left panel, and then select the appropriate DSN tab for the type of data source name you want to add:

  • Select the User tab to add a named data source that's available only to the current user. The data source is stored in /user/.odbc.ini.
  • Select the System tab to add a named data source that's available to all users. All system data sources are stored in a single file, usually /etc/odbc.ini.
  • Select the File tab to add a named data source that's available to all users but that's stored in a file of your choosing.

Select the appropriate tab and select Add. The Create a New Data Source window opens.

Select the EDB-ODBC driver from the list, and select OK to open the Data Source Properties window.

Complete the Data Source Properties (new) window, specifying the connection properties for the EDB-ODBC driver.

  • Enter the data source name in the Name field.
  • Enter a description of the named data source in the Description field.
  • The unixODBC driver includes a trace utility that records the sequence of calls made from an ODBC application to a log file. Specify Yes in the Trace field to turn the trace utility on. Using the trace utility can slow down an application.
  • Use the TraceFile field to specify a file to receive information returned by the Trace utility.
  • Enter the name of the EDB Postgres Advanced Server database in the Database field.
  • Enter the host name or IP address ofn EDB Postgres Advanced Server in the Servername field.
  • Enter the name of a user in the Username field.
  • Enter the password for the user in the Password field.
  • Enter a port number (or accept the default value of 5444) in the Port field.
  • Use the Protocol field to specify a front-end/back-end protocol version. The default value is 7.4. You can optionally select from protocol versions 7.4, 6.4, 6.3, or 6.2.
  • Use the ReadOnly field to specify Yes to prevent the driver from executing the following commands: INSERT, UPDATE, DELETE, CREATE, ALTER, DROP, GRANT, REVOKE or LOCK. Enabling the Read Only option also prevents any calls that use the ODBC procedure call escape syntax (call=procedure-name?). By default, ReadOnly is set to No.
  • Use the RowVersioning field to specify Yes if you want the driver to include the xmin column when reporting the columns in a table. The xmin column is the ID of the transaction that created the row. You must use row versioning if you plan to create cursors where SQL_CONCURRENCY = SQL_CONCUR_ROWVER. By default, Row Versioning is set to No.
  • Use the ShowSystemTables field to specify Yes if you want the driver to include system tables in the result set of the SQLTables() function. By default, this field is set to No.
  • Use the ShowOidColumn field to specify Yes if you want the driver to include the OID column in the result set of the SQLColumns() function. If ShowOidColumn is set to No, the OID column is hidden from SQLColumns(). By default, this option is set to No.
  • Use the FakeOidIndex field to specify Yes if you want the SQLStatistics() function to report that a unique index exists on each OID column. This is useful when your application needs a unique identifier and your table doesn’t include one. The default value is No.
  • Use the ConnSettings field to specify a list of parameter assignments for the driver to use when opening this connection.

After you define the connection properties, select OK. The new data source is added to the list of data source names.