gpMgmt/doc/gpstart_help

COMMAND NAME: gpstart

Starts a Apache Cloudberry system.


*****************************************************
SYNOPSIS
*****************************************************

gpstart [-d <coordinator_data_directory>] [-B <parallel_processes>]
        [-R] [-m | -c] [-y] [-a] [-t <timeout_seconds>]
        [-l logfile_directory] [--skip-heap-checksum-validation]
        [-v | -q]

gpstart -? | -h | --help

gpstart --version


*****************************************************
DESCRIPTION
*****************************************************

The gpstart utility is used to start the Apache Cloudberry server 
processes. When you start a Apache Cloudberry system, you are 
actually starting several postgres database server listener processes 
at once (the coordinator and all of the segment instances). The gpstart utility 
handles the startup of the individual instances. Each instance is started 
in parallel.

Before you can start a Apache Cloudberry system, you must have initialized 
the system using gpinitsystem first.


*****************************************************
OPTIONS
*****************************************************

-a

  Do not prompt the user for confirmation.


-B <parallel_processes>

  The number of segments to start in parallel. If not specified, 
  the utility will start up to 64 parallel processes depending on 
  how many segment instances it needs to start.


-d <coordinator_data_directory>

  Optional. The coordinator host data directory. If not specified, 
  the value set for $COORDINATOR_DATA_DIRECTORY will be used.


-l <logfile_directory>

  The directory to write the log file. Defaults to ~/gpAdminLogs.


-m | -c | --master_only | --coordinator_only

  Optional. Starts the coordinator instance only, which may be necessary 
  for maintenance tasks. This mode only allows connections to the coordinator 
  in utility mode. For example:

  PGOPTIONS='-c gp_role=utility' psql

  Note that starting the system in coordinator-only mode is only advisable
  under supervision of Cloudberry support.  Improper use of this option
  may lead to a split-brain condition and possible data loss.


-q

  Run in quiet mode. Command output is not displayed on the screen, 
  but is still written to the log file.


-R

  Starts Apache Cloudberry in restricted mode (only database superusers 
  are allowed to connect).

--skip-heap-checksum-validation

  During startup, the utility does not validate the consistency of the heap checksum setting
  among the Apache Cloudberry coordinator and segment instances. The default is to ensure
  that the heap checksum setting is the same on all instances, either enabled or disabled.
  Warning: Starting Apache Cloudberry without this validation could lead to data loss. 
  Use this option to start Apache Cloudberry only when it is necessary to ignore the 
  heap checksum verification errors to recover data or to troubleshoot the errors.

-t | --timeout <number_of_seconds>

  Specifies a timeout in seconds to wait for a segment instance to 
  start up. If a segment instance was shutdown abnormally (due to 
  power failure or killing its postgres database listener process, 
  for example), it may take longer to start up due to the database 
  recovery and validation process. If not specified, the default timeout 
  is 60 seconds.


-v

  Displays detailed status, progress and error messages output by the utility.


-y

  Optional. Do not start the standby coordinator host. The default is to start 
  the standby coordinator host and synchronization process.


-? | -h | --help

  Displays the online help.


--version

  Displays the version of this utility.


*****************************************************
EXAMPLES
*****************************************************

Start a Apache Cloudberry system:

gpstart


Start a Apache Cloudberry system in restricted mode 
(only allow superuser connections):

gpstart -R


Start the Cloudberry coordinator instance only and connect in utility mode:

gpstart -m

PGOPTIONS='-c gp_role=utility' psql


Display the online help for the gpstart utility:

gpstart -?


*****************************************************
SEE ALSO
*****************************************************

gpinitsystem, gpstop