create-jdbc-connection-pool(1)

Skip to ContentSun and Oracle Channel Sun How to Buy Log In

Sun Java System Application Server Platform Edition 9 Reference Manual

Contained Within

Find More Documentation

Featured Support Resources

NAME

create-jdbc-connection-pool– registers the JDBC connection pool

SYNOPSIS

create-jdbc-connection-pool

false

true

localhost

4848|4849

–s

admin_user

filename

target

classname

res_type

poolsize

time

limit

time

isolation_level

true

false

auto-commit

tablename

false

text

(name=value)

name=value

connectionpoolid

DESCRIPTION

The create-jdbc-connection-pool command registers a new JDBC connection pool with the specified JDBC connection pool name.

This command is supported in remote mode only.

OPTIONS

–t ––terse

Indicates that any output data must be very concise, typically avoiding human-friendly sentences and favoring well-formatted data for consumption by a script. Default is false.

–e ––echo

Setting to true will echo the command line statement on the standard output. Default is false.

–I ––interactive

If set to true (default), only the required password options are prompted.

–H ––host

The machine name where the domain administration server is running. The default value is localhost.

–p ––port

The HTTP/S port for administration. This is the port to which you should point your browser in order to manage the domain. For example, http://localhost:4848.

The default port number for Platform Edition is 4848. The default port number for Enterprise Edition is 4849.

–s ––secure

If set to true, uses SSL/TLS to communicate with the domain administration server.

–u ––user

The authorized domain administration server administrative username.

If you have authenticated to a domain using the asadmin login command, then you need not specify the --user option on subsequent operations to this particular domain.

––passwordfile

The ––passwordfile option specifies the name of a file containing the password entries in a specific format. The entry for the password must have the AS_ADMIN_ prefix followed by the password name in uppercase letters.

For example, to specify the domain administration server password, use an entry with the following format: AS_ADMIN_PASSWORD=password, where password is the actual administrator password. Other passwords that can be specified include AS_ADMIN_MAPPEDPASSWORD, AS_ADMIN_USERPASSWORD, and AS_ADMIN_ALIASPASSWORD.

All remote commands must specify the admin password to authenticate to the domain administration server, either through ––passwordfile or asadmin login, or interactively on the command prompt. The asadmin login command can be used only to specify the admin password. For other passwords, that must be specified for remote commands, use the ––passwordfile or enter them at the command prompt.

If you have authenticated to a domain using the asadmin login command, then you need not specify the admin password through the ––passwordfile option on subsequent operations to this particular domain. However, this is applicable only to AS_ADMIN_PASSWORD option. You will still need to provide the other passwords, for example, AS_ADMIN_USERPASSWORD, as and when required by individual commands, such as update-file-user.

For security reasons, passwords specified as an environment variable will not be read by asadmin.

––help

Displays the help text for the command.

––target

This option is deprecated.

––datasourceclassname

The name of the vendor—supplied JDBC datasource resource manager.

––restype

The interface that the datasource class implements. Must be one of javax.sql.DataSource, javax.sql.ConnectionPoolDataSource or javax.sql.XADataSource. It leads to an error when this option has a legal value and the indicated interface is not implemented by the datasource class. This option has no default value.

––steadypoolsize

The minimum and initial number of connections maintained in the pool. The default value is 8.

––maxpoolsize

The maximum number of connections that can be created. The default value is 32.

––maxwait

The amount of time a caller will wait before a connection timeout is sent. The default is 60 seconds. A value of 0 forces the caller to wait indefinitely.

––poolresize

The number of connections to be removed when idletimeout timer expires. Connections that have idled for longer than the timeout are candidates for removal. When the pool size reaches steadypoolsize, the connection removal stops. The default value is 2.

––idletimeout

The maximum time, in seconds, that a connection can remain idle in the pool. After this time, the implementation can close this connection. This timeout value must be kept shorter than the server side timeout value to prevent the accumulation of unusable connections in the application. The default value is 300.

––isolationlevel

The transaction-isolation-level on the pooled database connections. This option does not have a default value. If not specified, the pool operates with the default isolation level that the JDBC driver provides.

You can set a desired isolation level using one of the standard transaction isolation levels: read-uncommitted, read-committed, repeatable-read, serializable. Applications that change the isolation level on a pooled connection programmatically risk polluting the pool. This could lead to program errors.

––isisolationguaranteed

This is applicable only when a particular isolation level is specified for transaction-isolation-level. The default value is true.

This option assures that every time a connection is obtained from the pool, isolation level is set to the desired value. This could have some performance impact on some JDBC drivers. Administrators can set this to false when the application does not change ––isolationlevel before returning the connection.

––isconnectvalidatereq

If set to true, connections are validated or checked to see if they are usable before giving out to the application. The default value is false.

––validationmethod

The name of the validation table used to perform a query to validate a connection. Valid settings are: auto-commit, meta-data, or table. The default value is auto-commit.

––validationtable

The name of the validation table used to perform a query to validate a connection.

––failconnection

If set to true, all connections in the pool must be closed when a single validation check fails. The default value is false. One attempt is made to re-establish failed connections.

––allownoncomponentcallers

A pool with this property set to true, can be used by non-J2EE components, that is, components other than EJBs or Servlets. The returned connection is enlisted automatically with the transaction context obtained from the transaction manager.

––nontransactionalconnections

A pool with this property set to true returns non-transactional connections. This connection does not get automatically enlisted with the transaction manager.

––description

Text providing details about the specified JDBC connection pool.

––property

Optional attribute name/value pairs for configuring the connection pool.

OPERANDS

connectionpoolid: The name of the JDBC connection pool to be created.

EXAMPLES

Example 1 Using create-jdbc-connection-pool command

asadmin> create-jdbc-connection-pool --user admin 
--passwordfile passwords.txt --host localhost --port 7070 
--datasourceclassname org.apache.derby.jdbc.ClientDataSource --restype javax.sql.XADataSource 
--property portNumber=1527:password=APP:user=APP:serverName=
localhost:databaseName=sun-appserv-samples:connectionAttributes=\\;
create\\\\=true sample_derby_pool
Command create-jdbc-connection-pool executed successfully

Where, the sample_derby_pool is created. The escape character backslash (\\) is used in the --property option to distinguish the semicolon (;). Two backslashes (\\\\) are used to distinguish the equal (=) sign.

EXIT STATUS

0: command executed successfully
1: error in executing the command

Contained Within

Find More Documentation

Featured Support Resources