db_start

Starts the database. The database must already exist and must not be running.

Mandatory parameters

Parameter name Data type Description
db_name string Name of an existing database to be started.

Optional parameters

Parameter name Data type Description
maintenance boolean If set to True, the database is started in maintenance mode. This should only be done on recommendation from support.
timeout integer Number of seconds to wait for the database to be running. The default value is 0, which disables the timeout. If the timeout is reached, the operation is aborted.
cluster string Which database clusters should be started. Can be a cluster name, '+all' or 'MAIN' (database name can be passed instead of 'MAIN')

Substitute parameters

There are no substitute parameters.

Allowed users

The following users are allowed to run this job:

  • root

Allowed groups

The following groups are allowed to run this job:

  • root
  • exaadm
  • exadbadm

Examples

The following examples show how to run this job in a Python program using XML-RPC or on the command line using confd_client.

conn.job_exec('db_start', {'params': {'db_name': 'DB1'}})
conn.job_exec('db_start', {'params': {'db_name': 'DB1', 'timeout': 30}})
confd_client db_start db_name: DB1
confd_client db_start db_name: DB1 timeout: 30