FirebirdSQL logo

The ODBC/JDBC driver attempts to connect a client to the Firebird server according to a set of attributes that default to those provided by the DSN definition.Those stored attributes can be — and usually are — overridden by parameters passed by the application or read from a file (FILEDSN) when it prepares to connect.

Connection Parameters

The connection parameters for the driver comprise a list of strings in the form KEYWORD=value, separated by semicolons (‘;’).The following table enumerates the keywords with their verbose meanings and, where it is not obvious, their possible values.

Table 1. Keywords for Connection Attributes
Keyword Description More Information

UID

Database account, i.e. username

 

USER

PWD

Password

 

PASSWORD

ROLE

Role

 

DSN

Data source name

 

DRIVER

Driver name

e.g., the string Firebird/InterBase(r) driver.Defaults to the driver defined in the DSN.

DBNAME

Database

Full path to the database as seen by the server, including IP address | server name[/port] for a remote connection.Defaults to the database defined in the DSN.

DATABASE

CLIENT

Local path to the required fbclient library

May be needed if the connection is to be via an embedded server library located in an application folder.

CHARSET

Client-side default character set

Should be the same as the default character set of the database, if possible;or one that is known to be codepage-compatible.

CHARACTERSET

READONLY

Read-only

Set transactions in this connection to be read-only.The default is read/write.

NOWAIT

No wait

Set transactions in this connection to have NO WAIT lock resolution.The default is WAIT.

LOCKTIMEOUT

Set the lock timeout on WAIT transaction

Pass the number of seconds to elapse after encountering a lock conflict until a transaction is to return an error.Not valid if the transaction is set for NO WAIT resolution.

DIALECT

Set SQL dialect

Only 1 or 3 is valid.Normally this would have been set in the DSN.It must match the dialect of the database.

QUOTED

Set on quoted identifiers

If set in the DSN, the setting should be correct, i.e. already ON or OFF.

SENSITIVE

Set on case-sensitive identifiers

If set in the DSN, the setting should be correct, i.e. already ON or OFF.

AUTOQUOTED

Set on auto-quoting identifiers

If set in the DSN, the setting should be correct, i.e. already ON or OFF.

USESCHEMA

Set on “use schema”

If set in the DSN, the setting should be correct.

SAFETHREAD

Safe threading

 

FILEDSN

File DSN

Path to a file where the attribute strings from a previous connection are stored.If this string is present, the contents of the file will take priority over the main DSN.

SAVEDSN

Save DSN

Path to a file where the attribute strings from this connection, if successful, are to be stored.The password will be saved in encrypted format.