PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Overview
  • List of keywords
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Overview
When defining the connections in the data model editor or when defining the connections by programming, you have the ability to specifier the optional connection information.
In the data model editor, this information is typed in the connection description, "Advanced" tab.
By programming, this extended information is configured:
This information is defined via the following keywords.
Caution: This help page only presents the optional connection information available for the Native Accesses and for OLE DB.
Note: From version 19, HFSQL is the new name of HyperFileSQL.
List of keywords
KeywordDescription
ANSI_NULLSSpecifies the behavior, compatible with ISO, of the Equal to (=) and Different from (< >) operators when they are used with Null values.
The possible values are as follows:
  • 0: Forces the parameter to FALSE on the server
  • 1: Forces the parameter to TRUE on the server
  • Not specified: Uses the current configuration of the server
Native Accesses This keyword is supported by the native SQL Server access (SQLnCLI and DBLib).
ANSI_PADDINGChecks the mode for storing in the column the values whose length is less than the size defined for the column and the values containing space characters on the right for the char, varchar, binary and varbinary data
The possible values are as follows:
  • 0: Forces the parameter to OFF
  • 1: Forces the parameter to ON
  • Not specified: Uses the current configuration of the server
Native Accesses This keyword is supported by the native SQL Server access (SQLnCLI and DBLib).
ANSI_WARNINGSSpecifies whether the behavior in accordance with the ISO standard must be respected for several error conditions.
The possible values are as follows:
  • 0: Forces the parameter to OFF
  • 1: Forces the parameter to ON
  • Not specified: Uses the current configuration of the server
Native Accesses This keyword is supported by the native SQL Server access (SQLnCLI and DBLib).
ARITHABORTStops a query when a capacity overflow or a division by zero occurs during its execution.
The possible values are as follows:
  • 0: Forces the parameter to OFF
  • 1: Forces the parameter to ON
  • Not specified: Uses the current configuration of the server
Native Accesses This keyword is supported by the native Sybase access and by the native SQL Server access (SQLnCLI and DBLib).
CHARSETDefines the charset during the call to dbsetlname.
Native Accesses This keyword is supported by the native Sybase access only.
Client FlagSee the documentation about MySQL (keyword = 'mysql_real_connect') for more details.
Native Accesses This keyword is supported by Native MySQL Access.
CONCAT_NULL_YIELDS_NULLDefines whether the concatenation results are considered as being null values or empty strings.
The possible values are as follows:
  • 0: Forces the parameter to OFF
  • 1: Forces the parameter to ON
  • Not specified: Uses the current configuration of the server
Native Accesses This keyword is supported by the native SQL Server access (SQLnCLI and DBLib).
DTSUsed to specify whether the distributed transactions must be used or not.
  • If "DTS = 0", the management of distributed transactions is disabled.
  • If "DTS = 1" (default value), the management of distributed transactions is enabled.
Native Accesses This keyword is supported by the native Oracle access only.
Initial CatalogName of database that will be used on the data source.
File NameName of the UDL file used to establish a connection via OLE DB.
To create a UDL file:
  1. Create a text file whose extension is "UDL".
  2. Double-click this file. The window for the properties of the data links is opened.
  3. Configure the connection.
  4. Run the test of the connection.
  5. Validate ("OK" button). The UDL file can now be used.
Note: This method is not recommended. Indeed, the OLE DB access is using the connection information to avoid the limits implemented by some providers.
OLE DB This keyword is supported by OLE DB.
MODELOCKAllows you to specify the type of lock used in the SQLxxx functions.
Native Accesses SQLServer, Sybase:
  • SQLLock(Table) is using TABLOCKX by default.
    Example: MODELOCK = TABLOCKX
    SELECT * FROM MyTable WITH (TABLOCKX)
  • SQLLock(qry) is using UPDLOCK by default. Example:
    SELECT * FROM MyTable WITH (UPDLOCK) WHERE MyItm>2 ORDER BY MyItm
Native Accesses Oracle:
  • SQLLock(Table) is using the "EXCLUSIVE" mode by default. Example: MODELOCK = EXCLUSIVE
    LOCK TABLE MyTable IN EXCLUSIVE MODE NOWAIT
  • SQLLock(qry) adds "FOR UPDATE" to the query (cannot be configured)
NLS_DATE_FORMATIf this keyword is specified, the Native Access runs the following query when the connections is established:
ALTER SESSION SET NLS_DATE_FORMAT = format
This format does not concern the consultation of Oracle columns by WLanguage but the date conversions performed by the Oracle engine itself. For example, when running a query containing TO_CHAR of a date
Native Accesses This keyword is supported by the native Oracle access only.
NUMERIC_ROUNDABORTSpecifies the level of gravity for the error when a rounding operation performed in an expression triggers a loss of precision.
The possible values are as follows:
  • 0: Forces the parameter to OFF
  • 1: Forces the parameter to ON
  • Not specified: Uses the current configuration of the server
Native Accesses This keyword is supported by the native SQL Server access (SQLnCLI and DBLib).
OLDDATEFORMATModifies the return format of the date values in the SQLxxx functions in order to be compatible with the format of the Native Accesses of WINDEV 5.5.
The possible values are as follows:
  • 0: (default value) Date format supported by HFSQL.
  • 1: Format of dates compatible with the Native Accesses of WINDEV 5.5.
This keyword is supported by:
  • Native Accesses SQLServer (YYYY-MM-DD HH:MM:SS.CCC)
  • Native Accesses Sybase (YYYY-MM-DD HH:MM:SS.CCC)
  • Native Accesses Oracle (DD-MM-YYYY HH24:MI:SS)
PREFETCHMEMORYSize of the memory in bytes (corresponds to the OCI_ATTR_PREFETCH_MEMORY parameter of OCI_HTYPE_STMT).
The default value is 10485760 (=10 MB).
Native Accesses This keyword is supported by the native Oracle access only.
PREFETCHROWNumber of rows in the prefetch (corresponds to the OCI_ATTR_PREFETCH_ROWS parameter of OCI_HTYPE_STMT).
The possible values are as follows:
  • 0: Disables the management of prefetch
  • Default value: 1000
Native Accesses This keyword is supported by the native Oracle access only.
QUOTED_IDENTIFIERForces SQL Server to follow the ISO rules regarding the quotes that delimit the identifiers and the literal strings. The identifiers between double quotes can be reserved Transact-SQL keywords or they can contain characters not allowed in the conventions of Transact-SQL syntax regarding the identifiers.
The possible values are as follows:
  • 0: Forces the parameter to OFF
  • 1: Forces the parameter to ON
  • Not specified: Uses the current configuration of the server
Native Accesses This keyword is supported by the native Sybase access and by the native SQL Server access (SQLnCLI and DBLib).
Server PortServer port.
See the documentation about MySQL (keyword = 'mysql_real_connect') for more details.
Native Accesses This keyword is supported by Native MySQL Access and by Native PostgreSQL Access.
Versions 18 and later
SSL CA
New in version 18
SSL CA
SSL CA
Name (and path) of certification authority file.
Native Accesses This keyword is supported by Native MySQL Access and by Native PostgreSQL Access.
Versions 18 and later
SSL CAPath
New in version 18
SSL CAPath
SSL CAPath
Name (and path) of directory that contains the SSL CA certificate in PEM format.
Native Accesses This keyword is supported by Native MySQL Access.
Versions 18 and later
SSL Cert
New in version 18
SSL Cert
SSL Cert
Name (and path) of certificate file.
Native Accesses This keyword is supported by Native MySQL Access and by Native PostgreSQL Access.
Versions 18 and later
SSL Cipher
New in version 18
SSL Cipher
SSL Cipher
List of "ciphers" allowed during the SSL encryption.
Native Accesses This keyword is supported by Native MySQL Access.
Versions 18 and later
SSL CRL
New in version 18
SSL CRL
SSL CRL
List of revoked certificates (CRL = Certificate Revocation List).
Native Accesses This keyword is supported by Native PostgreSQL Access.
Versions 18 and later
SSL Key
New in version 18
SSL Key
SSL Key
Name (and path) of the key file.
Native Accesses This keyword is supported by Native MySQL Access and by Native PostgreSQL Access.
Versions 18 and later
SSL Mode
New in version 18
SSL Mode
SSL Mode
SSL connection mode:
  • allow: Try a non-SSL connection then a SSL connection in case of failure.
  • disable: Disable the SSL on the connection.
  • prefer (default mode): Try a SSL connection then a non-SSL connection in case of failure.
  • require: Force the SSL on the connection. If the certificate file of certification authority is supplied, check the server certificate.
  • verify-ca: Force the SSL on the connection and check the server certificate.
  • verify-full: Force the SSL on the connection and check whether the server name corresponds to the certificate.
Native Accesses This keyword is supported by Native PostgreSQL Access.
Versions 21 and later
TRANS_NO_NEW_SESSION
New in version 21
TRANS_NO_NEW_SESSION
TRANS_NO_NEW_SESSION
Management of new sessions when starting a transaction.
If this keyword is set to 1, no new session will be created when starting a transaction. This option allows you to use the temporary tables created per session.
This option can also impact the use of nested transactions.
Native Accesses This keyword is supported by Native SQL Server Access via SQLnCli OLEDB.
Unix SocketSee the documentation about MySQL (keyword = 'mysql_real_connect') for more details.
Native Accesses This keyword is supported by Native MySQL Access.
UNUSEDPROCESSESMaximum number of unused processes (3 by default) stored in cache in a WLanguage connection on SQLServer.
In the native SQLServer access and native Sybase access, the unused processes (and their connections) are stored in a cache in order to speed up the execution of a new query
Reminder: Creating a process and its connection is a long operation.
Native Accesses This keyword is supported by the native Sybase access and by the native SQL Server access (DBLib only).
USECOUNTKeyword specific to the SQLxxx functions.
The possible values are as follows:
  • 0: (default value): the result of the query is browsed for counting.
  • 1: Uses a query of query (SELECT COUNT FROM ...) to count the number of records in the queries run by the SQLxxx functions
Native Accesses This keyword is supported by the native Sybase access and by the native SQL Server access (SQLnCLI and DBLib).
WD Cache SizeSize of the cache for retrieving the records returned by a query.
For the native MySQL access and for the native PostgreSQL access, used to specify the size of the cache in the optional information of the connection. If this parameter is specified, the setting defined by ..CtCacheSize is ignored.
For the native MySQL access via SQLnCli, defines the number of records that must be read at once by a server cursor. This value is set to 100. by default
The possible values are as follows:
  • -2: Default value of the Native Access or client layer (100 in most cases)
  • -1: All the records are placed in the cache.
This keyword is supported by:
  • Native Accesses Native Sybase, SQL Server (SQLnCli) and PostgreSQL accesses.
  • OLE DB OLE DB.
Versions 17 and later
WD CLIENT LIBRARY
New in version 17
WD CLIENT LIBRARY
WD CLIENT LIBRARY
Specifies the DLL of the client layer that must be used for the native Progress access.
Example:
"WD CLIENT LIBRARY= C:\Program Files (x86)\Progress\OpenEdge\bin\pgoe1023.dll"
If this keyword is used, the content of the WDPRGS.INI file is ignored.
Native Accesses This keyword is supported by the native Progress access.
WD CLIENT VERSIONSpecifies the version number of the client layer to use.
This keyword is supported by:
  • Native Accesses SQLServer SQLnCLI: The possible values are as follows:
    • 2000: Uses the SQLOLEDB client layer (supplied with SQLServer 2005)
    • 2005: Uses the SQLnCli client layer (supplied with SQLServer 2005)
    • 2008: Uses the SQLnCli10 client layer (supplied with SQLServer 2008)
    • Versions 18 and later
      2012: Forces the use of the SQLnCli12 client layer (supplied with SQL Server 2012)
      New in version 18
      2012: Forces the use of the SQLnCli12 client layer (supplied with SQL Server 2012)
      2012: Forces the use of the SQLnCli12 client layer (supplied with SQL Server 2012)
  • Native Accesses Oracle: The possible values are as follows:
    • 7: Forces the use of the Oracle 7 client layer (ociw32.dll)
    • 8: Uses the Oracle 8 (and later) client layer (oci.dll)
WD Connection TimeoutDefines the maximum time-out (in seconds) for establishing the connection (connection time-out).
The possible values are as follows:
  • -1: Default value of the client layer (30 seconds in most cases)
  • 0: No time-out (infinite wait)
  • value greater than 0: Value of time-out in seconds
This keyword is supported by:
  • Native Accesses Native Sybase, SQL Server (DBLib and SQLnCli) and PostgreSQL accesses.
  • OLE DB OLE DB.
WD Command TimeoutDefines the maximum time-out (in seconds) for running a command (command time-out).
The possible values are as follows:
  • -1: Default value of the client layer (30 seconds in most cases)
  • 0: No time-out. In this case, there is an endless wait (caution: the application may be locked).
  • value greater than 0: Value of time-out in seconds
This keyword is supported by:
  • Native Accesses Native Sybase, SQL Server (DBLib and SQLnCli) and PostgreSQL accesses.
  • OLE DB OLE DB.
WD Cursor LocationIn most cases, the default cursor is the fastest . It corresponds to the "default result set" of the SQL Server documentation.
You have the ability to specify specific cursors:
  • "WD Cursor Location = CLIENT" allows you to request the use of a client cursor for all the browse operations performed on this connection.
  • "WD Cursor Location = SERVER" allows you to request the use of a server cursor for all the browse operations performed on this connection. The type of the server cursors used is FAST_FORWARD. See the documentation about SQLServer for more details.
This type of cursor can be used to:
  • Limit the resources reserved on the server during the browse operations.
  • Limit the number of connections opened by the native access to manage the multiple browses in parallel.
Caution:
  • In most cases, the browses performed with the server cursors are slower than the browses performed in default mode.
  • The server cursors may not be compatible with some types of queries.
  • The performances are affected by the size of the cache.
Note: The server cursors are automatically used when a connection is in transaction.
This keyword is supported by:
  • Native Accesses Native SQL Server access (SQLnCli).
  • OLE DB OLE DB.
WD Lock TimeoutDefines the maximum time-out (in seconds) for implementing a lock (lock time-out).
The possible values are as follows:
  • -2: Immediate response (is using NOWAIT on Oracle)
  • -1: Default value (30 seconds in most cases)
  • 0: No time-out (infinite wait)
  • value greater than 0: Value of time-out in seconds
Native Accesses This keyword is supported by the native SQL Server access (DBLib and SQLnCli) and by the native Oracle access (-2 only).
WD RECORD LOCKUsed to specify whether the management of locks is enabled (or not) on the connection.
  • If "WD RECORD LOCK = WITH (NOLOCK)", the management of locks is disabled on the connection. In this case, the native access adds "WITH (NOLOCK)" into all the generated SELECT queries. Therefore, the selected records are not locked.
  • If this option is not specified (default case), the management of locks is enabled on the connection. All the selected records are automatically locked.
Caution: "WD RECORD LOCK = WITH (NOLOCK)" is not used by default. Indeed, this option must be used with great care: the value of the records read may not correspond to the real value (if this value was recently modified by another computer for example).
cntProgress..ExtendedInfo = ...
"PORT=2800;" + ...
"WD RECORD LOCK = WITH (NOLOCK);" + ...
"WD CLIENT LIBRARY= C:\...\pgoe1022.dll"
Native Accesses This keyword is supported by the native Progress access.
Versions 17 and later
WD SESSION MODE
New in version 17
WD SESSION MODE
WD SESSION MODE
This value is an integer, result of a combination (BinaryOr) of the following values:
  • OCI_SYSDBA=2
  • OCI_SYSOPER=4
  • OCI_PRELIM_AUTH=8
For example, to connect as SYSDBA, you must use "WD SESSION MODE=2"
Native Accesses This keyword is supported by the Native Oracle Access.
WD Unicode SupportUsed to specify whether the management of the Unicode format is enabled (or not) on the connection.
If "WD Unicode Support = 0", the management of the Unicode format is disabled on the connection. All the values will be converted (if necessary) by the server into the default character set. In this case, the performance is improved but the Unicode items are not supported.
If "WD Unicode Support = 1" (default value), the management of the Unicode format is enabled on the connection. All the exchanges with the server will be performed in Unicode. The possible conversions are managed by the native access.
Native Accesses This keyword is supported by the native SQL Server (SQLnCli), MySQL and PostgreSQL accesses.
Versions 18 and later
Native Accesses The optional information is now supported for Native AS/400 Access (see the documentation about Native AS/400 Access for more details):
  • ASP
  • AUTOJOURNAL
  • CACHERECORDS
  • CACHETIMEOUT
  • CACHETIMEOUTKEY
  • CCSID
  • LOCALCP
  • CODEPAGEFILE
  • CONNECTION TIMEOUT
  • COMMAND TIMEOUT
  • DATETYPE
  • TIMETYPE
  • DRVOPTIMISTIC
  • EIM_LOOKUP_INFO
  • EXTRAIDX
  • FIELDNAMES_MUST_MATCH
  • FORCELIBL
  • HFMAXKEY
  • IGNORE_EMPTY_EXTINFO
  • IMPORT_DFT
  • IMPORT_SELOMIT
  • LITERALCASE
  • LEADINGSPACES
  • ONLYSHORTFIELDNAMES
  • PGNAME
  • SQLNAMING
  • SSL
  • SSL_INTF
  • SSL_CAFILE
  • SSL_CAPATH
  • STRICTIDENTICAL
  • SQLFULLPRECISION
  • SQLHPOS
  • TCP_VERSION
  • TCPIP_FATAL
  • TIMEOUTNOTIF
  • USER_CERT_FILE
  • USER_CERT_PKEY_FILE
  • USER_CERT_PASSPHRASE
New in version 18
Native Accesses The optional information is now supported for Native AS/400 Access (see the documentation about Native AS/400 Access for more details):
  • ASP
  • AUTOJOURNAL
  • CACHERECORDS
  • CACHETIMEOUT
  • CACHETIMEOUTKEY
  • CCSID
  • LOCALCP
  • CODEPAGEFILE
  • CONNECTION TIMEOUT
  • COMMAND TIMEOUT
  • DATETYPE
  • TIMETYPE
  • DRVOPTIMISTIC
  • EIM_LOOKUP_INFO
  • EXTRAIDX
  • FIELDNAMES_MUST_MATCH
  • FORCELIBL
  • HFMAXKEY
  • IGNORE_EMPTY_EXTINFO
  • IMPORT_DFT
  • IMPORT_SELOMIT
  • LITERALCASE
  • LEADINGSPACES
  • ONLYSHORTFIELDNAMES
  • PGNAME
  • SQLNAMING
  • SSL
  • SSL_INTF
  • SSL_CAFILE
  • SSL_CAPATH
  • STRICTIDENTICAL
  • SQLFULLPRECISION
  • SQLHPOS
  • TCP_VERSION
  • TCPIP_FATAL
  • TIMEOUTNOTIF
  • USER_CERT_FILE
  • USER_CERT_PKEY_FILE
  • USER_CERT_PASSPHRASE
Native Accesses The optional information is now supported for Native AS/400 Access (see the documentation about Native AS/400 Access for more details):
  • ASP
  • AUTOJOURNAL
  • CACHERECORDS
  • CACHETIMEOUT
  • CACHETIMEOUTKEY
  • CCSID
  • LOCALCP
  • CODEPAGEFILE
  • CONNECTION TIMEOUT
  • COMMAND TIMEOUT
  • DATETYPE
  • TIMETYPE
  • DRVOPTIMISTIC
  • EIM_LOOKUP_INFO
  • EXTRAIDX
  • FIELDNAMES_MUST_MATCH
  • FORCELIBL
  • HFMAXKEY
  • IGNORE_EMPTY_EXTINFO
  • IMPORT_DFT
  • IMPORT_SELOMIT
  • LITERALCASE
  • LEADINGSPACES
  • ONLYSHORTFIELDNAMES
  • PGNAME
  • SQLNAMING
  • SSL
  • SSL_INTF
  • SSL_CAFILE
  • SSL_CAPATH
  • STRICTIDENTICAL
  • SQLFULLPRECISION
  • SQLHPOS
  • TCP_VERSION
  • TCPIP_FATAL
  • TIMEOUTNOTIF
  • USER_CERT_FILE
  • USER_CERT_PKEY_FILE
  • USER_CERT_PASSPHRASE
Minimum required version
  • Version 16
This page is also available for…
Comments
Click [Add] to post a comment