Many properties can be specified when connecting to an AS/400 database using JDBC. All properties are optional and can be specified either as part of the URL or in a java.util.Properties object. If a property is set in both the URL and a Properties object, the value in the URL will be used.
The following table lists the different connection properties that are recognized by this driver. Some of these properties affect performance and others are server job attributes.
Property | Description | Required | Choices | Default |
---|---|---|---|---|
General properties | ||||
"user" | Specifies the user name for connecting to the AS/400 server. If none is specified, then the user will be prompted, unless the "prompt" property is set to "false", in which case an attempt to connect will fail. |
no
|
AS/400 user | (user will be prompted) |
"password" | Specifies the password for connecting to the AS/400 server. If none is specified, then the user will be prompted, unless the "prompt" property is set to "false", in which case an attempt to connect will fail. |
no
|
AS/400 password | (user will be prompted) |
"prompt" | Specifies whether the user should be prompted if a user name or password is needed to connect to the AS/400 server. If a connection can not be made without prompting the user, and this property is set to "false", then an attempt to connect will fail. |
no
|
"true", "false" | "true" |
Server properties | ||||
"libraries" | Specifies the AS/400 libraries to add to the server job's library list.
The libraries are delimited by commas or spaces, and "*LIBL" may be used
as a place holder for the server job's current library list. The library
list is used for resolving unqualified stored procedure calls and finding
schemas in DatabaseMetaData catalog methods. If "*LIBL" is not specified,
then the specified libraries will replace the server job's current library
list.
In addition, if no default schema is specified in the URL, then the first library listed in this property will also be the default schema, which is used to resolve unqualified names in SQL statements. |
no
|
AS/400 libraries | "*LIBL" |
"transaction isolation" | Specifies the default transaction isolation. |
no
|
|
"read uncommitted" |
"cursor hold" | Specifies whether to hold the cursor across transactions. If this property is set to "true", cursors are not closed when a transaction is committed or rolled back. All resources acquired during the unit of work are held, but locks on specific rows and objects implicitly acquired during the unit of work are released. |
no
|
|
"true" |
Format properties | ||||
"date format" | Specifies the date format used in date literals within SQL statements. |
no
|
|
(server job) |
"date separator" | Specifies the date separator used in date literals within SQL statements. This property has no effect unless the "date format" property is set to "julian", "mdy", "dmy" or "ymd". |
no
|
|
(server job) |
"decimal separator" | Specifies the decimal separator used in numeric literals within SQL statements. |
no
|
|
(server job) |
"naming" | Specifies the naming convention used when referring to tables. |
no
|
schema.table )schema/table ) |
"sql" |
"time format" | Specifies the time format used in time literals within SQL statements. |
no
|
|
(server job) |
"time separator" | Specifies the time separator used in time literals within SQL statements. This property has no effect unless the "time format" property is set to "hms". |
no
|
|
(server job) |
Performance properties | ||||
"block criteria" | Specifies the criteria for retrieving data from the AS/400 server in blocks
of records. Specifying a non-zero value for this property will reduce the
frequency of communication to the server, and therefore increase performance.
Ensure that record blocking is off if the cursor is going to be used for subsequent UPDATEs, or else the row that is updated will not necessarily be the current row. |
no
|
|
"2" |
"block size" | Specifies the block size (in kilobytes) to retrieve from the AS/400 server and cache on the client. This property has no effect unless the "block criteria" property is non-zero. Larger block sizes reduce the frequency of communication to the server, and therefore may increase performance. |
no
|
"0", "8", "16", "32", "64", "128", "256", "512" | "32" |
"lob threshold" | Specifies the maximum LOB (large object) size (in bytes) that can be retrieved as part of a result set. LOBs that are larger than this threshold will be retrieved in pieces using extra communication to the server. Larger LOB thresholds will reduce the frequency of communication to the server, but will download more LOB data, even if it is not used. Smaller LOB thresholds may increase frequency of communication to the server, but will only download LOB data as it is needed. |
no
|
"0" - "16777216" | "0" |
"prefetch" | Specifies whether to prefetch data upon executing a SELECT statement. This will increase performance when accessing the initial rows in the ResultSet. |
no
|
"true", "false" | "true" |
"data compression" | Specifies whether result set data is compressed. If this property is set to "true", then result set data is compressed. If this property is set to "false", then result set data is not compressed. Data compression may improve performance when retreiving large result sets. |
no
|
"true", "false" | ![]() ![]() |
"big decimal" | Specifies whether an intermediate java.math.BigDecimal object is used for packed and zoned decimal conversions. If this property is set to "true", an intermediate java.math.BigDecimal object is used for packed and zoned decimal conversions as described by the JDBC specification. If this property is set to "false", no intermediate objects are used for packed and zoned decimal conversions. Instead, such values are converted directly to and from Java double values. Such conversions will be faster but may not follow all conversion and data truncation rules documented by the JDBC specification. |
no
|
"true", "false" | "true" |
"lazy close" | Specifies whether to delay closing cursors until subsequent requests. This will increase overall performance by reducing the total number of requests. |
no
|
"true", "false" | "false" |
"extended dynamic" | Specifies whether to use extended dynamic support. Extended dynamic support provides a mechanism for caching dynamic SQL statements on the server. The first time a particular SQL statement is run, it is stored in a SQL package on the server. On subsequent runs of the same SQL statement, the server can skip a significant part of the processing by using information stored in the SQL package. If this is set to "true", then a package name must be set using the "package" property. |
no
|
"true", "false" | "false" |
"package" | Specifies the base name of the SQL package. Extended dynamic support works best when this is derived from the application name. Note that only the first seven characters are significant. This property has no effect unless the "extended dynamic" property is set to "true". In addition, this property must be set if the "extended dynamic" property is set to "true". |
no
|
SQL package | "" |
"package library" | Specifies the library for the SQL package. This property has no effect unless the "extended dynamic" property is set to "true". |
no
|
Library for SQL package | "QGPL" |
"package criteria" | Specifies the type of SQL statements to be stored in the SQL package. This can be useful to improve the performance of complex join conditions. This property has no effect unless the "extended dynamic" property is set to "true". |
no
|
|
"default" |
"package cache" | Specifies whether to cache SQL packages in memory. Caching SQL packages locally reduces the amount of communication to the server in some cases. This property has no effect unless the "extended dynamic" property is set to "true". |
no
|
"true", "false" | "false" |
"package clear" | Specifies whether to clear SQL packages when they become full. Clearing a SQL package results in removing all SQL statements that have been stored in the SQL package. This property has no effect unless the "extended dynamic" property is set to "true". |
no
|
"true", "false" | "false" |
"package add" | Specifies whether to add statements to an existing SQL package. This property has no effect unless the "extended dynamic" property is set to "true". |
no
|
"true", "false" | "true" |
"package error" | Specifies the action to take when SQL package errors occur. When a SQL package error occurs, the driver will optionally throw a SQLException or post a warning to the Connection, based on the value of this property. This property has no effect unless the "extended dynamic" property is set to "true". |
no
|
"exception", "warning", "none" | "warning" |
Sort properties | ||||
"sort" | Specifies how the server sorts records before sending them to the client. |
no
|
|
"job" |
"sort language" | Specifies a 3-character language id to use for selection of a sort sequence. This property has no effect unless the "sort" property is set to "language". |
no
|
Language id | ENU |
"sort table" | Specifies the library and file name of a sort sequence table stored on the AS/400 server. This property has no effect unless the "sort" property is set to "table". |
no
|
Qualified sort table name | "" |
"sort weight" | Specifies how the server treats case while sorting records. This property has no effect unless the "sort" property is set to "language". |
no
|
|
"shared" |
Other properties | ||||
![]() |
Specifies the output string type of bidi data. See BidiStringType for more information. |
no
|
|
""![]() |
"access" | Specifies the level of database access for the connection. |
no
|
|
"all" |
"data truncation" | Specifies whether data truncation exceptions are thrown. If this property is set to "true", then data truncation exceptions are thrown if data needs to be truncated when writing to the database. If this property is set to "false", then no such data truncation exceptions are thrown. Either way, data truncation warnings are posted if data needs to be truncated when reading from the database. |
no
|
"true", "false" | ![]() ![]() |
"driver" | Specifies the JDBC driver implementation. The AS/400 Toolbox for Java JDBC driver chooses which JDBC driver implementation to use based on the environment. If the environment is an AS/400 Java Virtual Machine on the same AS/400 as the database to which the program is connecting, the native AS/400 Developer Kit for Java JDBC driver is used. In any other environment, the AS/400 Toolbox for Java JDBC driver is used. This property has no effect if the "secondary URL" property is set. This property cannot be set to "native" if the environment is not an AS/400 Java Virtual Machine. |
no
|
|
"default" |
"errors" | Specifies the amount of detail to be returned in the message for errors that occur on the AS/400 server. |
no
|
|
"basic" |
"proxy server" | Specifies the host name and port of the middle-tier machine where the
proxy server is running. The format for this is hostname[:port],
where the port is optional. If this is not set, then the hostname and port
are retrieved from the com.ibm.as400.access.AS400.proxyServer property.
The default port is 3470 (if the connection uses SSL, the default
port is 3471). The ProxyServer must be running on the middle-tier
machine.
The name of the middle-tier machine is ignored in a two-tier environment. |
no
|
Proxy server host name and port | (value of the proxyServer property, or none if not set) |
"remarks" | Specifies the source of the text for REMARKS columns in ResultSets returned by DatabaseMetaData methods. |
no
|
|
"system" |
"secondary URL" | Specifies the URL to be used for a connection on the middle-tier's DriverManager in a multiple tier environment, if it is different than already specified. This property allows you to use this driver to connect to databases other than the AS/400. Use a backslash as an escape character before backslashes and semicolons in the URL. |
no
|
JDBC URL | (current JDBC URL) |
"thread used" | Specifies whether threads should be used in communication with the host servers. |
no
|
"true", "false" | "true" |
"secure" | Specifies whether a Secure Sockets Layer (SSL) connection is used to communicate with the server. SSL connections are only available when connecting to servers at V4R4 or later. |
no
|
|
"false" |
![]() |
Specifies the key ring class name used for SSL connections with the server. This property has no effect unless "secure" is set to true and a key ring password is set using the "key ring password" property. |
no
|
"key ring name" | ""![]() |
![]() |
Specifies the password for the key ring class used for SSL communications with the server. This property has no effect unless "secure" is set to true and a key ring name is set using the "key ring name" property. |
no
|
"key ring password" | ""![]() |
"translate binary" | Specifies whether binary data is translated. If this property is set to "true", then BINARY and VARBINARY fields are treated as CHAR and VARCHAR fields. |
no
|
"true", "false" | "false" |
"trace" | Specifies whether trace messages should be logged. Trace messages are useful for debugging programs that call JDBC. However, there is a performance penalty associated with logging trace messages, so this property should only be set to "true" for debugging. Trace messages are logged to System.out. |
no
|
"true", "false" | "false" |