Table 41 lists the driver keywords that can be set, along with a
brief explanation of each and default settings. All of the keywords are
not necessarily able to be set in all the methods described above (see Table 42).
Description | Keyword | (Format) Explanation | Default |
---|---|---|---|
Add ESCAPE Option | LKES |
This keyword is used to add an ESCAPE clause after each LIKE clause. The ESCAPE clause is only added if:
|
YES
|
Add WITH UR to Queries
|
WIUR
|
This keyword controls whether or not a WITH UR clause should be added to
queries. The WITH UR clause reduces the amount of CPU time needed for
some queries. There is also the possibility it could change the results
of these queries by allowing uncommitted data to be read. If this
keyword is set to YES, a WITH UR clause will be added to queries. If
this keyword is set to NO, a WITH UR clause will not be added to
queries.
|
NO
|
Alternate (Secondary) Userid
|
ALUS
|
This keyword is used to set the host secondary userid for client
applications. This keyword must be eight or fewer characters
long. If this keyword is set to a non-blank, non-null value, a SET
CURRENT SQLID statement is issued after DSNALI OPEN processing is
completed.
|
|
Always Convert Dynamic SQL
|
ALCD
|
This keyword controls what happens if dynamic SQL can not be converted to static SQL. If this keyword is set to YES, and dynamic SQL cannot be converted to static, an error is reported to the application. If this keyword is set to NO, the dynamic SQL is sent to the host for processing.
|
YES
|
Application Name
|
APNA
|
This keyword is the Application name. The Application Name is sent
to the host as part of the logon information. The Application Name is
normally used to group SQL statements within a plan. If the Application
Name is not set, all of the SQL associated with a plan will be consider to be
part of one large group. If the SQL used with one plan must be divided
into subgroups (for conversion to static SQL), the Application Name must be
set.
|
|
Application Server
|
SECN
|
This keyword is used to select the initial Application Server value on the
host. It must be sixteen or fewer characters long. If this
keyword is set to a non-blank, non-null value, the current application will be
connected to the specified Application Server after DSNALI OPEN processing is
completed.
|
|
Async Execution Timeout Value
|
ASTM
|
This keyword controls the default wait time for an ODBC function that is
executing asynchronously. This keyword is measured in seconds, and must
be an integer.
|
2
|
Binary Passthrough
|
BIPA
|
This keyword controls whether or not host binary data should be returned to
client applications without being converted to hexadecimal. If this
keyword is set to YES, host binary data is passed through to client
applications unchanged. If this keyword is set to NO, host binary data
is converted to hexadecimal (in accordance with the ODBC
specification).
|
NO
|
Bypass Double Quote
|
BYDB
|
This keyword is set to YES if double quotes should be left alone.
This keyword is provided to fix certain application bugs.
|
NO
|
CALL Lock Value
|
CALK
|
This keyword controls the type of lock associated with CALL statements on
the host. If this keyword is set to NONE, then the host code will
assume that CALL statements do not obtain any host database locks. The
other possible values are SHARE, UPDATE, and EXCLUSIVE.
|
EXCLUSIVE
|
Change Dynamic SQL to Static
|
AUST
|
This keyword is used to control whether or not Shadow Direct should try to convert dynamic SQL to Auto-Static SQL. Dynamic SQL can only be converted to Auto-Static SQL if this keyword is set to YES and if the host supports Auto-Static SQL.
|
YES
|
Client Certificate File
|
CLCT
|
No description is available.
|
|
Cognos Impromptu Compatibility
|
CGFX
|
This keyword is set to YES to resolve certain problems with Cognos
Impromptu. This keyword should not be set for any other reason.
|
YES
|
Column Order Option
|
CLOR
|
This keyword shows how column names should be returned by ODBC catalog
functions. Some functions explicitly specify an order. Other
functions don't. This keyword is used by the ODBC catalog
functions (SQLColumns) that don't specify a column name order.
|
NUMBER
|
Confirm New Password
|
CMNP
|
If this keyword is set, the user will be asked to confirm the new password
string if the new password is set in the ODBC PWD keyword.
|
NO
|
Connection Dialog Type
|
CNDG
|
This keyword shows what type of connection dialog should be
displayed. This keyword can be set using the ODBC.INI file or
using a connection string. If the dynamic dialog is specified, either
the simple or the detailed dialog is displayed depending on how much
information is needed.
|
DYNAMIC
|
Connection Mode
|
CNMD
|
This keyword controls the connection mode used by ODBC applications.
The connection mode determines how long each physical connection (session or
conversation) lasts and if SQL operations are blocked together. The
default is to use a permanent connection and to send each SQL operation
standalone to the server. In BLOCK mode, the session is
permanent. However, SQL operations are blocked and sent
together. In TRANSACTION mode each SQL operation is sent standalone but
the session is terminated at the end of each Logical Unit Of Work
(LUOW). In TRANSBLOCK mode the session is terminated at the end of each
LUOW, and SQL operations are blocked and sent together. In MESSAGE mode
SQL operations are blocked and sent together using messages. In MESSAGE
mode, no session is ever maintained.
|
PERMANENT
|
Connection Name
|
CNNA
|
This keyword is used to specify the connection name. The use of the
connection name is application specific. The name can be up to eight
(8) byte long, however, the application may or may not use all of the
bytes. The connection name is padded on the right with blanks.
|
|
Connection Timeout Value
|
CNTM
|
This keyword controls how many seconds the ODBC client will wait for a connection to the host server to complete. If this keyword is set to zero, then the system default value will be used. Otherwise, the specified value will be used. This value should never be negative, but can be zero. This value has no effect in UDP messaging.
|
0
|
Convert DB2 Date to CHAR
|
DTCH
|
When this keyword is set, the DB2 date keyword will be converted to
SQL_CHAR.
|
NO
|
Convert DB2 Time to CHAR
|
TSCH
|
When this keyword is set, the DB2 timestamp and time keyword will be
converted to SQL_CHAR. If the keyword AF (MS Access Compatibility) is
set to YES, this keyword does not need to be set. Keyword AF includes
the functionality of keyword TSCH.
|
NO
|
Convert Nulls to Blanks
|
CVNL
|
This keyword controls whether or not nulls (zero bytes) in character string
data should be returned from the server to the client, or should be converted
to blanks. Both fixed length and variable length character data are
affected by this keyword. If this keyword is set to YES, then nulls
will be converted to blanks. If this keyword is set to NO, then nulls
will not be converted.
|
NO
|
Convert Strings to Params
|
LGPA
|
This keyword controls whether or not long strings should be converted to
LONG VARCHAR parameters. This conversion is needed because some
applications produce literals that are longer than can be handled by the host
database. If this keyword is set to NO, each SQL string will not be
scanned for long strings. If this keyword is set to YES, then all long
strings will be converted to parameter markers.
|
NO
|
Convert Timestamps
|
CVTS
|
This keyword controls whether or not timestamp values should be converted
to other types. If this keyword is set to YES, timestamps that appear
to be dates will be converted to dates and timestamps that appear to be times
will be converted to times. These conversions are required to
circumvent bugs in several products including MS Access and Crystal
Reports. If this keyword is set to NO, timestamps will not be
modified.
|
NO
|
Correlation ID Support
|
COID
|
This keyword controls whether or not SQLGetInfo should return information
about Correlation IDs. If this keyword is set to YES, SQLGetInfo will
return information about Correlation IDs. If this keyword is set to NO,
no information about Correlation IDs will be returned. This keyword
must be set to NO to enable some ODBC tools to work.
|
YES
|
Count() Fix Type
|
COFX
|
This keyword controls how COUNT (column name) SQL functions are fixed. Microsoft Access uses the COUNT(column name) function two ways, both of which are wrong. In some cases, COUNT(column name) really means COUNT (DISTINCT column name). In other cases it means COUNT(*). If this keyword is set to DISTINCT, the DISTINCT keyword will be inserted. If this keyword is set to ASTERISK, the column name will be replaced with a "*". If this keyword is set to NONE, no changes will be made.
|
DISTINCT
|
Create Table Index Automatically
|
CRIN
|
This keyword controls whether or not an index is automatically created when
you create a table with a primary key or unique constraint. This index
enforces the uniqueness. To disable this option, set the value to
NO.
|
YES
|
Current Degree
|
SEDG
|
This keyword is used to set the initial Current Degree value on the
host. The only possible values for this keyword are ANY or 1. No
other values are supported at this time. If this keyword is set to a
non-blank, non-null value, a SET CURRENT DEGREE statement is issued after
DSNALI OPEN processing is completed.
|
|
Current Packageset
|
SEPK
|
This keyword is used to set the initial Current Packageset value on the
host. This value must be eighteen or fewer characters long. If
this keyword is set to a non-blank, non-null value, a SET CURRENT PACKAGESET
statement is issued after DSNALI OPEN processing is completed. The SET
statement assigns the specified value to the CURRENT PACKAGESET special
register.
|
|
Current Rules
|
SERL
|
This keyword is used to set the initial Current Rules value on the
host. The only possible values for this keyword are DB2 or STD.
No other values are supported at this time. If this keyword is set to a
non-blank, non-null value, a SET CURRENT RULES statement is issued after
DSNALI OPEN processing is completed.
|
|
Cursor Commit/Rollback Behavior
|
CRBH
|
This keyword controls what value to return for the cursor commit and
rollback behavior SQLGetInfo request. DELETE will close cursors and
delete prepared statements. To use the cursor again, the application
must re-prepare and re-execute the statement. CLOSE will only close
cursors. For prepared statements, the application can call SQLExecute
on the statement without calling SQLPrepare again.
|
DELETE
|
Customer Secret Key
|
SKEY
|
No description is available.
|
|
Date Format
|
DTFM
|
This keyword is used to specify how ODBC dates are converted to character
strings. If this keyword is set to ODBC, the standard ODBC/ISO format
yyyy-mm-dd will be used. If this keyword is set to UK, then the
dd-mm-yyyy format will be used. If this keyword is set to EUR, then the
dd.mm.yyyy format will be used.
|
ODBC
|
DB2 Version String
|
D2VR
|
This keyword can overwrite the host returned DB2 version string
data. This string should be in the following format:
x.y.z -- where x, y and z are all numeric digits. x is
the DB2 version byte. y is the DB2 modification level. z is the
DB2 release level. Both the version byte and the modification level
must be set. If the release level is not set, then 0 is assumed.
For example, 2.3 is for DB2 version 2, mod level 3.and
4.1.1 is for DB2 version 4, mod level 1, and rel 1.
|
|
DBCS Mode
|
DBMD
|
This keyword is used to specify how DBCS data is handled. If BINARY is specified, all DBCS data will be treated as binary data.
|
DEFAULT
|
DBCS Remove Blanks
|
DBQO
|
This keyword controls whether or not blanks are removed from within quoted
strings for double byte languages (such as Chinese, Japanese, and
Korean). If this keyword is set to YES, blanks, that are within quoted
strings in SQL being sent to the host, will be removed. If this keyword
is NO, blanks, that are inside quoted strings in SQL being sent to the host,
will not be changed.
|
YES
|
Default Column Names
|
DFCL
|
This keyword controls whether or not the driver will assign default column
names (of the form COLnnn, where nnn is the column number) when the DBMS does
not return names for the columns.
|
NO
|
Decimal Point is Comma
|
DCCM
|
This keyword controls if the decimal point is a comma or not. If
this keyword is set to YES, a comma is considered to be the decimal
point. If this keyword is set to NO, a period is considered to be the
decimal point. This keyword should only be set to YES, if the host uses
a comma as the decimal point. This keyword will cause commas to be
converted to periods before data is passed to the Auto-Static SQL conversion
facility.
|
NO
|
Defer Prepare for CALLS
|
DFPR
|
This keyword controls whether or not to defer prepare of CALL
statements. If this keyword is set to YES, prepare is always deferred
for CALL statements. If this keyword is set to NO, prepare is only
deferred for CALLs that have one or more parameter markers. In other
words, prepare is always deferred for CALLs that have parameter
markers. If this keyword is set to YES, prepare is deferred for CALLs
that do not have parameter markers.
|
NO
|
Disable Async Option
|
NOAS
|
This keyword is used to indicate whether or not asynchronous execution will
be allowed. Setting this option to YES will prevent all asynchronous
processing.
|
YES
|
Disable CTL3D
|
NO3D
|
This keyword is used to indicate whether or not CTL3D processing will
occur. Setting this option to YES will prevent the use of the CTL3D DLL
with the connection dialog. This option must be set to YES for some
applications if an old copy of CTL3D is installed.
|
NO
|
Disable Prepare/Open Optimization
|
DIPO
|
This keyword disables the prepare/open optimization and consequently adds a
network round-trip (for the SQLExecute). The RDO layer on top of VB
issues two SQLPrepares and only one SQLExecute for each select
statement. This causes two result-sets to be returned for every
query.
|
NO
|
Disable SQLCancel Tracing
|
DIPO
|
This keyword disables the prepare/open optimization and consequently adds a
network round-trip (for the SQLExecute). The RDO layer on top of VB
issues two SQLPrepares and only one SQLExecute for each select
statement. This causes two result-sets to be returned for every
query.
|
NO
|
Disable All Prompts
|
NOPM
|
This keyword when set to YES will disable all interactive prompts or
informational message boxes. This feature is required when the driver
is being called from a NT service, a UNIX daemon process, or any server type
applications which can not be interrupted.
|
NO
|
Display Wait Cursor
|
WACU
|
This keyword indicates whether or not to update the cursor (with an
hourglass). You may observe a dramatic improvement in performance by
setting this option to NO, which results in no updates to the cursor and no
display of the hourglass.
|
NO
|
Don't Get Passwords from ODBC.INI
|
NOPW
|
This keyword controls whether or not the password should be obtained from the ODBC.INI file. If this keyword is set to YES, then the password must be provided by the connection string or the connection dialogs.
|
NO
|
Don't Get Userids from ODBC.INI
|
NOUS
|
This keyword controls whether or not the userid should be obtained from the ODBC.INI file. If this keyword is set to YES, the userid must be provided by the connection string or the connection dialogs.
|
NO
|
DTS Plan File
|
DSFL
|
This keyword is used to specify the name of the local plan file used to
convert dynamic SQL to static SQL. The plan file name should end with
.pln and can be a full path name, if need be. This keyword
should only be used if the local plan file does not have the default name or
is not located in the working directory of the application. The default
name of the local plan file is always planname.pln, where planname is
the name of the DB2 plan used by the application.
|
|
Duplicate Socket Descriptor
|
DPSO
|
This keyword is a non-negative integer that is used to return a new and
unused file descriptor for the connecting socket. The new socket number
will be a descriptor number that is either equal to or greater than this
number. The old descriptor will be closed after the replacement.
This keyword is only enabled for the UNIX platforms, and is designed to allow
C run-time applications to get around the 255 maximum open file handle
limitation in studio library. For example, a good value to set this
keyword to is 256.
|
0
|
Enable Multitasking
|
MT
|
This keyword is used to control the multitasking capabilities of Shadow
Direct. This feature will keep your screen from locking up while ODBC
calls are pending. However, this feature should be used with extreme
caution! Many applications will not operate correctly with this feature
activated.
|
NO
|
Extended Cursor Pool
|
EXCU
|
This keyword controls whether or not the Extended Cursor Pool should be used. If this keyword is set to YES, the Extended Cursor Pool will be used. The Extended Cursor Pool is much larger than the standard cursor pool.
|
NO
|
Fast Logon
|
FALG
|
This keyword controls whether or not Fast Logon should be used. If
this keyword is set to YES, Logon processing will be done with a minimum of
network I/O. This is only possible if the host server supports Fast
Logon. Failures will result if Fast Logon is requested and the host
server does not support it. The ability of the server to handle Fast
Logon must be verified before this option is used. If this keyword is
set to NO, then normal Logon processing will be used
|
NO
|
Fix INSERT Statements
|
FXIS
|
This keyword controls whether or not the VALUES clause of each INSERT
statement should be scanned for dates, times, and timestamps, and whether or
not quotes should be added. If this keyword is set to YES, quotes will
be added to dates, times, and timestamps as need be. If this keyword is
set to NO, INSERT statements will be not modified.
|
NO
|
Fix DB2 Outer Joins
|
OJFX
|
If this keyword is set, parentheses around ON clauses of DB2 outer joins
will be removed. While this syntax is valid ANSI SQL, DB2 cannot handle
it in its current release (version 5). This kind of SQL is generated by
ODBC tools such as Brio.
|
NO
|
Fix Oracle 8.0.5 Bug
|
OJFX
|
This field is used to fix the oracle8.0.5 bug.
|
NO
|
Fix String Length
|
STFX
|
This keyword fixes a specific bug that can occur in some products, like
Microsoft Access, where the string length is incorrectly set to zero when the
SQL_CHAR keyword only contains blanks. If the keyword AF (MS Access
Compatibility) is set to YES, this keyword does not need to be set.
Keyword AF includes the functionality of keyword STFX.
|
NO
|
Floating to Character Digits
|
MXDG
|
This keyword controls the maximum number of digits that should be generated
for a floating point to character conversion. This keyword should only
be specified if the default value is not acceptable.
|
6
|
GAIJI Extension Support
|
GAJI
|
This keyword enables GAIJI extension support in a codepage
|
YES
|
GAIJI Extension Table Name
|
GATB
|
This keyword sets the GAIJI extension table name. There is no
default name. If this keyword is left blank, a server-side default
table name will be used. This keyword has a max keyword size of 4
characters.
|
|
German NLS support
|
NLGR
|
This keyword is set to YES to resolve certain problems handling SQL in the
German language environment. This keyword should not be set for any
other reason.
|
NO
|
Host Debugging Values
|
HODB
|
This keyword is used to control the debugging of host programs (generally
Stored Procedures). This keyword is either set to the type of language
the host program was written in, or NONE. The host program language
must be specified correctly so that the program can be invoked with the
correct debugging options. The supported values are COBOL, PLI, C, and
C++.
|
NONE
|
Host User Parm
|
USERPARM
|
This keyword is sent to the host as part of the logon information.
The host uses this keyword to complete logon to the host security system or
host databases.
|
|
Identifier Quote Option
|
IDQO
|
This keyword is used to show what identifier quote character should be
returned to the application using SQLGetInfo with
SQL_IDENTIFER_QUOTE_CHAR. This keyword is needed to fix certain
application bugs.
|
BLANK
|
Ignore High Bound Column Errors
|
IGHI
|
This keyword controls whether or not SQLFetch should ignore high bound
column errors. If this keyword is set to YES, SQLFetch will ignore
column binding errors. If this keyword is set to NO, column binding
errors will be handled normally. This keyword must be set to YES to
enable some ODBC tools (such as Microsoft Excel) to work.
|
NO
|
Ignore Underscore Characters
|
IGUN
|
This keyword controls whether or not the underscore character should be
considered as a wild card or a regular character. If this keyword is
set to YES, underscore ("_") will be handled as a normal byte.
If this keyword is set to NO, underscore will be treated as a wildcard
character that matches any other single byte. This keyword is used to
solve problems in which a table or procedure name actually has an underscore
in the name and the underscore is misinterpreted as a wildcard.
|
NO
|
Keep Literal Quotes
|
KEQU
|
This keyword is used to keep quotes around and embedded in string literals. If this keyword is set to YES, quotes around and embedded in string literals will be retained.
|
NO
|
Language ID
|
LGID
|
This keyword is used to specify the language to be used. The
possible values are Arabic (ARB), Simplified Chinese (CHS), Traditional
Chinese (CHT), Danish (DAN), Default (DFT), German (DEU), U.S.
English Compatibility (ENC), U.K. English (ENG),
U.S. English (ENU), Modern Spanish (ESN), Castilian Spanish
(ESP), Finish (FIN), French (FRA), Canadian French (FRC), Icelandic (ISL),
Italian (ITA), Japanese (JPL), Japanese Latin Extended (JPX), Korean (KOR),
Micro Decisionware (MDI), Dutch (NLD), Norwegian (NOR), PeopleSoft English
(PPS), Portuguese (PTG), Swedish (SVE) and Turkish (TUR).
|
ENU
|
Long Data Fix
|
LGFX
|
This keyword controls whether or not a large number should be returned for
the length and precision of LONG VARCHAR keywords, rather than the actual
length and precision. This fix is needed to resolve certain problems in
ODBCDirect GetChunk processing. If this keyword is set to YES, a large
number will be returned for the length and precision of LONG VARCHAR
keywords. If this keyword is set to NO, the actual values will be
returned for the length and precision of LONG VARCHAR keywords.
|
NO
|
Lotus Approach Compatibility
|
LAFX
|
This keyword is set to YES to resolve certain problems with Lotus
Approach. This keyword should not be set for any other reason.
|
NO
|
LZ Compression
|
LZCM
|
If this keyword is set to YES and the server supports this feature, a
variant of Lempel-Ziv compression will be used to compress all data flow
between the client and the server.
|
YES
|
Maximum Buffer Size
|
MXBU
|
This keyword sets the driver side maximum communication buffer size for all data exchanges. The default for this keyword is 0 which currently sets the maximum buffer size to 100,000 bytes (32K bytes in 16-bit windows).
|
0
|
Message Type
|
MGTY
|
This keyword controls the type of messages used for message oriented
connections. It is only used if a message connection mode is
employed. The default value is NETWORK, which creates a TCP/IP or LU
6.2 session or conversation for each message. When the link type
is set to TCP/IP, users can also choose the UDP message type as the messaging
protocol. Using UDP datagrams for messaging usually incurs lower
network overhead, however UDP communication is not reliable and is discouraged
when connecting over a WAN. HTTP and HTTPS methods will tunnel the
communication session inside the HTTP protocol stream to allow the session to
be established over firewalls and HTTP proxies. HTTPS is the Netscape
secured HTTP protocol which implements SSL and can be used when a secured
channel between the two endpoints is required.
|
NETWORK
|
MS Access Compatibility
|
AF
|
If this keyword is set to YES, all host decimal data values are returned to
the ODBC client application without any trailing zeroes to the right of the
decimal point. This keyword must be set to YES in order for Microsoft
Access to work with DB2 decimal data. This keyword may be needed with
any other product that uses the Microsoft Jet Database Engine, such as Visual
Basic.
|
NO
|
MTS Security SID Type
|
MSMT
|
This keyword is the security SID option when using the MS Transaction
Server based network authentication/single sig-on model.
|
DIRECT CALLER SID
|
MultiNet TCP/IP Compatibility
|
MUNT
|
This keyword is needed to support applications using the Multi-Net TCP/IP
product for host access.
|
NO
|
Network Authentication
|
SECU
|
When the DOMAIN-base authentication is selected, the driver will verify if
the userid associated with the current process has been authenticated by a
domain-based system. For the Win32 platforms, this requires the user to
first log on to a NT domain. For the UNIX platforms, the local machine
must be a member of a NIS domain, and the password database used to
authenticate the user must be NIS-mapped. The MTS-based authentication
model allows a MTS server COM component to pass on the account name of the
client applications invoking the object. MyNet setting is used with the
CKS MyNet single signon product support. The SNA setting works with the
MS SNA server single signon facility. The ODBC client must be a MS/SNA
CPI-C client.
|
NONE
|
No Nulls
|
NONL
|
This keyword controls whether or not zero length strings should be
returned. If this keyword is set to YES, zero length strings will be
replaced by one blank. If this keyword is set to NO, zero length
strings will not be modified.
|
NO
|
Non-blocking Network I/O
|
NBIO
|
This keyword controls whether or not TCP/IP network I/O operations should
be blocking. If this keyword is set to YES, non-blocking network I/O
operations will be used and the Windows message queue will be used to wait for
I/O operation completion. If this keyword is set to NO, blocking
network I/O operations will be used.
|
NO
|
ODBC Client Code Page
|
ODPG
|
This keyword is used to specify the ODBC client code page. The
default is a set of UNIX code pages for UNIX and Windows Latin 1 (ANSI) for
Windows 95/NT. Windows Latin 1 is also known as ISO 8859.
Specifying LATIN1 will force the use of the Windows Latin 1 code page in any
environment. Specifying UNIX will force the use of the UNIX code pages
in any environment.
|
DEFAULT
|
One-Way Messages
|
ONWY
|
This keyword controls whether or not responses to messages should be sent to the ODBC client. If this keyword is set to YES, one-way message processing will be used. This means that no responses will be returned to ODBC client applications. If this keyword is set to NO, normal responses will be returned for messages.
|
NO
|
Operation Timeout Value
|
OPTM
|
This keyword controls the timeout value (in seconds) for all client network operations (i.e. query preparation, execution, retrieving result set) AFTER the connection has been established. This value should never be negative, but can be zero. This value has no effect in UDP messaging.
|
0
|
Optimal Row Count
|
OPRW
|
This keyword limits the number of rows that will be returned from the host
each time a request for rows is made. Since any number of requests for
rows can be made for one query, this value will have no effect on the total
number or rows returned by a query. This value can be used to control
the size of the buffers used to return rows from the host.
|
0
|
Parameter Handling
|
PAHN
|
This keyword is used to control how parameters are handled when they are
passed by ODBC applications. In some cases, special processing is
needed to fix values passed by some applications. For example, Crystal
Reports passes parameters using obsolete values that must be modified before
they can be used. This keyword should be set to INPUT for Crystal
Reports. This keyword should be set to LENGTH to fix some application
parameter length errors. This value should be set to ADO to fix some
ADO related errors. If this keyword is set to NONE, the parameter
values passed by applications are not changed.
|
NONE
|
PowerBuilder Compatibility
|
PBFU
|
This keyword is set to YES to resolve certain problems with
PowerBuilder. This keyword should not be set for any other
reason.
|
NO
|
Procedure Name Filter
|
PRNF
|
This keyword is used to filter the procedure names returned by the
product. This keyword is used only if it is set to a non-blank value
and if the host application does not provide a procedure name filter
string. The procedure name filter string from either the application or
from this keyword restricts the information returned by procedure catalog
inquiries (SQLProcedures and SQLProcedureColumns). Only rows that match
the procedure name pattern provided will be returned. If this keyword
is set to a single percent sign, then all procedures will be returned.
There is no default value for this keyword.
|
|
Procedure Owner Filter
|
PROF
|
This keyword is used to filter the procedure owners returned by the
product. This keyword is used only if it is set to a non-blank value
and if the host application does not provide a procedure owner filter
string. The procedure owner filter string from either the application
or from this keyword restricts the information returned by procedure catalog
inquiries (SQLProcedures and SQLProcedureColumns). Only rows with owner
ID's that match the procedure owner pattern provided will be
returned. If this keyword is set to a single percent sign, then all
procedures will be returned. This keyword defaults to the current
userid or alternate userid.
|
|
Procedure Owner Handling
|
PROW
|
This keyword is used to control how procedure owner values are returned to
ODBC applications. If this keyword is set to NULL, the actual owner
value is used as a prefix to the procedure name and the owner keyword is
returned as a null value. If this keyword is set to EMPTY, the actual
owner value is used as a prefix to the procedure name and the owner keyword is
returned as an empty string. If this keyword is set to NONE, the
procedure owner value is not changed.
|
NONE
|
Process Escapes
|
PRES
|
This keyword is used to turn off escape clause processing. PRES=NO
will set escape clause processing off and may result in improved performance
by reducing CPU overhead. This keyword is optional and, if not
specified, will default to PRES=YES.
|
YES
|
Proxy Server Information
|
PXSR
|
When HTTP tunneling is used for messaging the server, and the HTTP stream must first connect to a proxy server, this keyword should be set to identify the proxy server's hostname (or IP address) and the port number. The accepted formats for this keyword are MY_PROXY:80 or 10.22.33.44:1200. The first part of the value is the hostname or the IP address of the proxy server and the second part is the port number on which the proxy server is listening.
|
|
Proxy Server Userid
|
PXUS
|
When HTTP tunneling messaging mode is enabled, and the HTTP proxy server
requires user authentication, this keyword allow the user to specify the proxy
user ID (or name) string. At this moment, Basic HTTP Access
authentication is the only method supported
|
|
Proxy Server Password
|
PXPW
|
When HTTP tunneling messaging mode is enabled, and the HTTP proxy server
requires user authentication, this keyword allows the user to specify the
proxy user password string. At this moment, Basic HTTP Access
authentication is the only method supported.
|
|
Qualifier Name Separator
|
QUNA
|
This keyword is set to YES if SQLGetInfo to return a period when it is
called to obtain the SQL_QUALIFIER_NAME_SEPARATOR. This keyword is
provided to fix certain application bugs.
|
NO
|
RDO Compatibility
|
RDFX
|
This keyword is set to YES to resolve certain problems with Remote Data
Objects. This keyword should not be set for any other reason.
|
NO
|
Read Only
|
RDON
|
This keyword is set to YES to make the data source read-only. Setting the data source to read-only will not actually prevent update operations. However, setting this keyword to read-only will prevent any index information from being returned to the application. This will generally prevent any updates from being attempted.
|
NO
|
Result-set Cache Size
|
RSBK
|
This keyword indicates the number of SQL statements contained by the result-set cache.
|
256
|
Result-set Caching
|
RSCH
|
If this keyword is set to YES, the ODBC driver will cache result-sets of
SQL statements. When the same SQL statement is encountered, results are
retrieved from a local cache if the underlying tables have not changed since
the last cache update.
|
NO
|
Result-set Caching Interval
|
RSIN
|
This keyword specifies an interval in seconds, within which stale results are tolerated. If result-set caching is enabled, a previously cached SQL statement is encountered, and the number of seconds since the result-set was stored is within this interval, the result-set will be returned without host processing. A value of zero will guarantee no stale results: all statements will be submitted to the host, where the underlying tables will be checked for changes. A value of -1 will always retrieve from a local cache if one is available.
|
0
|
Return code if no rows affected
|
NODA
|
This keyword controls what the return code should be set to, when an
INSERT/UPDATE/DELETE does not affect any rows. If this keyword is set
to NODATA, the return code from an SQL operation that does affect any rows
will be SQL_NO_DATA_FOUND. If this keyword is set to INFO, the return
code will be set to SQL_SUCESS_WITH_INFO (in accordance with the ODBC
specification). This keyword can also be set to SUCCESS or
ERROR. In these cases, the return code will be SQL_SUCCESS or
SQL_ERROR.
|
INFO
|
Return Global Tables
|
RTGL
|
This keyword controls whether or not global temporary tables will be
returned as normal tables. If this keyword is set to YES, global
temporary tables will be treated and described as normal tables. If
this keyword is set to NO, global temporary tables will be handled as system
tables. This keyword is provided to allow standard ODBC tools to be
used with global temporary tables. Many of these tools bypass global
temporary tables that are described as global temporary tables.
However, the same tools will work correctly with global temporary tables if
they are described as normal tables.
|
YES
|
Return Logon Messages
|
LGMG
|
This keyword controls whether or not non-error Logon messages should be
returned to ODBC client applications. If this keyword is set to YES,
and a message is returned to the application, the return code will be set to
SQL_SUCCESS_WITH_INFO and the error message text will be available using the
Solderer function (or some higher level API). If this keyword is set to
NO, the message will be displayed using a dialog box.
|
NO
|
Return System Tables
|
RTSY
|
This keyword controls whether or not system tables (SYSIBM) will be
returned as normal tables. If this keyword is set to YES, system tables
will be treated and described as normal tables. If this keyword is set
to NO, system tables will be handled as system tables. This keyword is
provided to allow standard ODBC tools to be used with system tables.
Many of these tools bypass system tables that are described as system
tables. However, the same tools will work correctly with system tables
if they are described as normal tables.
|
NO
|
Remove Equals
|
RMEQ
|
This keyword controls whether or not the equals byte should be removed from MDI keyword names as part of MDI RSP (Remote Stored Procedure) invocation. If this keyword is set to YES, the equals byte will be removed from each keyword name. If this keyword is set to NO, the equals will not be removed from the keyword name.
|
NO
|
SBCS Mode
|
SBMD
|
This keyword is used to specify how SBCS data is handled. SBCS strings are assumed to contain a mixture of single byte characters and double byte characters. Each set of DBCS characters starts with a SO and end with a SI byte. If BLANK is specified, all SO/SI bytes will be converted to blanks. If DELETE is specified, all SO/SI bytes will be deleted from each string.
|
DEFAULT
|
Secured Channel Protocol
|
SSLX
|
This keyword allows the user to select a secured channel protocol to
encrypt and authenticate the client/server session. The default is the
standard NEON secured data stream which provides optimal performance but does
not support strong encryption and authentication. SSL2 (SSL version 2)
and SSL3 (SSL version 3) are based on the SSL standard.
|
STANDARD
|
SQLGetData out of order
|
GTDA
|
This keyword is used to control whether or not SQLGetData calls should be
allowed out of order. Normally, SQLGetData calls can only be made in
ascending column order starting after the last bound column. However,
if this keyword is set to YES, SQLGetData calls can be made in any
order. If this keyword is set to NO, the normal restrictions on
SQLGetData calls are enforced.
|
NO
|
SQL ParamOptions support
|
PAOP
|
This keyword controls whether or not we should support SQLParamOptions in a
limited form. If this keyword is set to YES, SQLParamOptions is
supported to a limited extent. If this keyword is set to NO,
SQLParamOptions is not supported at all. If this keyword is set to
SERVER, the server codes will decide whether this support is enabled.
|
YES
|
SQL Server Support
|
SQVA
|
This keyword is used to control whether or not SQLTypeInfo calls should
show that variable data is 255 bytes long. DB2 variable data is
actually only 254 bytes long. However, some applications do not support
this. If this keyword is set to YES, SQLTypeInfo will return 255 as the
length of variable data. If this keyword is set to NO, SQLTypeInfo will
return 254. NOTE: If this keyword is set to YES, the behavior of
SQLCancel is modified to circumvent vendor implementation errors.
|
NO
|
Suppress Decimal Trailing Zeros
|
STZO
|
This keyword controls whether or not trailing zeros should be removed from
decimal keywords. The default is NO. If the keyword AF (MS
Access Compatibility) is set to YES, this keyword does not need to be
set. Keyword AF includes the functionality of keyword STZO.
|
NO
|
Sybase Compatibility
|
SYFU
|
If this keyword is set to YES, a set of Sybase fixes will be used.
These fixes bypass bugs in the Sybase ODBC support. If this keyword is
set to NO, the Sybase fixes will not be used.
|
NO
|
System Engineering Value
|
SEVL
|
The System Engineering Value is set to various values to obtain diagnostic
and debugging data. This keyword should only be used at the specific
request of the Technical Support staff.
|
0
|
Table Name Filter
|
TBFL
|
This keyword is used to filter the table names returned by the product. This keyword is only used if it is set to a non-blank value and if the host application does not provide a table name filter string. The table name filter string from either the application or from this keyword restricts the information returned by catalog inquiries (SQLTables, SQLColumns, SQLTablePrivileges). Only rows that match the table name pattern provided will be returned. If this keyword is set to a single percent sign, all tables will be returned. There is no default value for this keyword. Example: TBFL=STAFF will cause only information from the
table labeled STAFF to be displayed; TBFL=STA% will cause information
from all tables that begin with STA to be displayed; TBFL=STAFF BOOK%
will cause information from the table labeled STAFF and all tables that begin
with BOOK to be displayed.
|
|
Table Owner/Synonym Option
|
SYOP
|
This keyword is used to show how table owners should be handled for tables
that are actually synonyms. Some of these choices are required to make
specific desktop productivity tools work with the NEON ODBC driver.
|
ZERO
|
Table Qualifier Option
|
TQOP
|
This keyword is used to specify how Table Qualifiers should be returned to
ODBC application programs. Some databases use Table Qualifiers as part
of the overall name of each table. In other words, two tables can have
exactly the same name in all other respects, if their Table Qualifiers are
different. The TQOP option is used to control how Table Qualifier
information is returned to ODBC applications. There are three possible
values: NORMAL, NULL, and ZERO.
|
NORMAL
|
Transaction Name
|
TRNA
|
This keyword is used to specify the transaction name. The use of the
transaction name is application specific. It can be up to eight (8)
bytes long. The transaction name is padded on the right with
blanks.
|
|
Truncate Literal String
|
TRLT
|
This keyword is used to turn off literal string truncation. TRLT=NO
will not truncate the literal string even if the string length is greater than
20.
|
YES
|
Unload Communication DLLs
|
FEDL
|
This keyword is used to determine whether the communication DLL
(i.e. WINSOCK.DLL or CPIC.DLL) should be unloaded
after an application disconnects. By default, Shadow Direct always
unloads the communication DLL after the application disconnects.
Setting this keyword to NO, if unloading the communication DLL while the
communication service is still active, causes errors. Setting this
keyword to NO will prevent the DLL from being unloaded by the ODBC
driver.
|
YES
|
Upcase all character data
|
UPCH
|
This keyword controls whether or not all character data sent to the host
should be converted to upper case. If this keyword is set to YES, all
character data will be converted to upper case. If this keyword is set
to NO, character data will not be converted to upper case.
|
NO
|
Upcase double quote string
|
UPDB
|
This keyword controls whether or not strings in double quotes should be
converted to upper case. If this keyword is set to YES, strings in
double quotes will be converted to upper case. If this keyword is set
to NO, strings in double quotes will not be modified. Strings must be
converted to upper case in some cases because DB2 treats table names in double
quotes as literals.
|
NO
|
UDP Maximum Retry Attempts
|
MXRT
|
This keyword controls the maximum number of UDP retries for an
unacknowledged request. This value must be a non-negative
number. If this keyword is set to ZERO, the UDP request retry is
disabled.
|
10
|
UDP Datagram Retry Timeout
|
RTTM
|
This keyword controls the initial timeout period before an UDP request is
retransmitted. This timeout value is doubled on successive
retries; however, this value will not increase without bound. The
maximum timeout allowable is 30 seconds. If the maximum retry attempts
is set to ZERO, this keyword will have no effect.
|
30
|
Visual Age Compatibility
|
VAFX
|
This keyword is set to YES to resolve certain problems with Visual
Age. This keyword should not be set for any other reason.
|
NO
|
Wollongong Pathworks 3.1 Support
|
WGPH
|
This keyword is needed when running in the Wollongong Pathworks 3.1
16-bit TCP/IP environment
|
NO
|
X/OPEN XA Support
|
XAEN
|
This keyword should be set if the target server will participate in an
X/OPEN XA transaction. The value, TWO-PHASE, should be used in a
situation where the transaction involves more than one resource manager, and
the target server supports the two-phase commit protocol. The value
TWO-PHASE also allows for the one-phase commit scenario whenever the
coordinator thinks it is appropriate. The default is NONE, which
implies that no part of the transaction will use the XA protocol.
|
NONE
|
X/OPEN XA Transaction Manager
|
XAOP
|
This keyword is used to set the XA Transaction Manager type. This
option must be set correctly when participating in a distributed transaction
coordinated by a monitor. MSDTC is the Microsoft Distributed
Transaction Manager used mostly by the MTS applications. Two possible
values are available for a BEA Tuxedo coordinated transaction.
TUXEDO-TMS is to identify that the ODBC connection will be owned by the Tuxedo
TMS server. TUXEDO-SQL is to identify that the ODBC connection will be
owned by the Tuxedo SQL application server. The default is NONE which
means that this is not a distributed transaction.
|
NONE
|
Zero Active Statements
|
ZEAS
|
This keyword controls whether or not zero should be returned for the number
of active statements. If this keyword is set to YES, zero will be
returned for the number of active statements supported by the ODBC
driver. If this keyword is set to NO, the actual number of supported
active statements will be returned.
|
NO
|
Zero Column Names
|
ZECL
|
This keyword is set to YES if column names should be set to binary
zeros. This is a performance optimization for production
applications.
|
NO
|