Database configuration

2 minute readReference

getDatabaseConfiguration

Retrieves the current database configuration.

Arguments

None.

Positional arguments

None.

Usage

ec-perl

$cmdr->getDatabaseConfiguration();

ectool

ectool getDatabaseConfiguration

setDatabaseConfiguration

Sets the database configuration on the server. If the server is in bootstrap mode, these changes take effect immediately and the server attempts to start. If the server is already running, these changes have no effect until the server is restarted.

If you are replacing the database you are currently using, you must restart the CloudBees CD/RO server after configuring the new database you want to use.

CloudBees CD/RO assigns default values to the following three arguments that are derived from information you enter for the arguments below. The values for these arguments can be viewed in the XML response for getDatabaseConfiguration. You should not need to change these values, but customDatabase arguments may be used to override CloudBees CD/RO default values. Contact CloudBees Customer Support for assistance with using these arguments:

customDatabaseDialect customDatabaseDriver customDatabaseUrl.

Arguments

Argument Name Type Description

customDatabaseDialect

String

Class name of the Hibernate dialect (advanced use only — the server will choose an appropriate dialect base on databaseType).

customDatabaseDriver

String

Class name of the JDBC driver (advanced use only — the server will choose an appropriate driver based on databaseType).

customDatabaseUrl

String

The JDBC URL to use (advanced use only — the server will compose an appropriate URL).

databaseName

String

The database instance name. Defaults to commander if left out.

databaseType

DatabaseType

The database type. Defaults to builtin.

hostName

String

The domain name or IP address of the server machine corresponding to this resource.

ignorePasskeyMismatch

Boolean

If true, ignore a passkey fingerprint mismatch between the current passkey file and the database configuration, discarding stored credentials.

ignoreServerMismatch

Boolean

If true, ignore a host name mismatch between the current server and the database configuration.

password

String

The password used to connect to the database.

port

Integer

Port number to use when connecting to the agent for this resource; defaults to server default.

preserveSessions

Boolean

If true, preserve sessions when ignoring server host name mismatches.

userName

String

The user name used to connect to the database.

Positional arguments

None.

Usage

ec-perl

$cmdr->setDatabaseConfiguration({<optionals>});

ectool

ectool setDatabaseConfiguration [optionals]