mxstart

Starts a YMatrix database system.

1 Description

The mxstart utility is used to start a YMatrix database cluster. It requires the cluster to be deployed with the new architecture introduced by YMatrix. When you start a YMatrix cluster, you are actually launching multiple PostgreSQL database listener processes managed by the database replica service.

2 Options

Option Description
-c or --db-cluster-id Specifies the ID of the target database cluster. Uses the default ID if omitted.
-m or --master-only Starts only the master instance. Useful for maintenance tasks. After using this option, connections to the master are allowed only in utility mode. For example:
PGOPTIONS='-c gp_role=utility' psql
-a or --no-prompt Do not prompt for confirmation.
-y Do not start the standby instance. By default, the standby instance and synchronization process are started if this option is not used.
-q Run in quiet mode. Output is suppressed on screen but still written to log files.
-R Start the database in restricted mode (only superusers can connect).
-t Sets the timeout (in seconds) to wait for segment instances to come up. If a segment instance was abnormally terminated (e.g., due to power failure or forced termination of its PostgreSQL listener), startup may take longer due to recovery and validation procedures. Default is 60 seconds if not specified.
-h or --help Show help information.
--log-level Set the logging level (error / debug / verbose / info). Default is info.

3 Examples

Start the default YMatrix cluster without prompting:

mxstart -a

Start the YMatrix database system in restricted mode (only superusers allowed):

mxstart -R

Start only the YMatrix master instance and connect in utility mode:

mxstart -m PGOPTIONS='-c gp_role=utility' psql

Note!
YMatrix 5 introduces a completely new database architecture. The mxstart tool is required to start clusters and is not compatible with gpstart. Earlier versions used the gpstart utility.

See Also: mxstop, mxstate