dse client-tool alwayson-sql
Perform operations related to AlwaysOn SQL.
Synopsis
dse client-tool <connection_options> alwayson-sql
(status | stop | start | restart | reconfig)
Syntax legend
| Syntax conventions | Description |
|---|---|
Italic, bold, or |
Syntax diagrams and code samples use one or more of these styles to mark placeholders for variable values. Replace placeholders with a valid option or your own user-defined value. In CQL statements, angle brackets are required to enclose data types in a set, list, map, or tuple.
Separate the data types with a comma.
For example: In Search CQL statements, angle brackets are used to identify the entity and literal value to overwrite the XML element in the schema and |
|
Square brackets surround optional command arguments. Do not type the square brackets. |
|
Parentheses identify a group to choose from. Do not type the parentheses. |
|
A pipe separates alternative elements. Type any one of the elements. Do not type the pipe. |
|
Indicates that you can repeat the syntax element as often as required. |
|
Single quotation marks must surround literal strings in CQL statements.
Use single quotation marks to preserve upper case.
+
For Search CQL only: Single quotation marks surround an entire XML schema declaration, such as |
|
Map collection.
Curly braces enclose maps ( |
|
Ends a CQL statement. |
|
Separate command line options from command arguments with two hyphens. This syntax is useful when arguments might be mistaken for command line options. |
-
status :: Get the AlwaysOn SQL service status of the datacenter. With the
--dc datacenter nameoption, get the status of the specified datacenter.The returned status is one of:
-
RUNNING: the server is running and ready to accept client requests. -
STOPPED_AUTO_RESTART: the server is being started but is not yet ready to accept client requests. -
STOPPED_MANUAL_RESTART: the server was stopped with either astoporrestartcommand. If the server was issued arestartcommand, the status will be changed toSTOPPED_AUTO_RESTARTas the server starts again. -
STARTING: the server is actively starting up but is not yet ready to accept client requests.- stop
-
Manually stop the AlwaysOn SQL service. With the
--dc datacenter nameoption, manually stop the service on the specified datacenter. - start
-
Manually start the AlwaysOn SQL service. With the
--dc datacenter nameoption, manually start the service on the specified datacenter. The service will start automatically if its been enabled. - restart
-
Manually restart a running AlwaysOn SQL service. With the
--dc datacenter nameoption, manually restart the service on the specified datacenter. - reconfig
-
Manually reconfigure the AlwaysOn SQL service. With the
--dc datacenter nameoption, manually reconfigure the service on specified datacenter. Running this command will tell the service to re-read the configuration options.The
alwayson_sql_optionssection indse.yamlhas options for setting the ports, timeout values, log location, and other Spark or Hive configuration settings. Additional configuration options are located inspark-alwayson-sql.conf.
-
Examples
Stop a running service:
dse client-tool alwayson-sql stop
Start the service on a particular datacenter:
dse client-tool alwayson-sql --dc dc-west start
Force the service to stop:
dse client-tool alwayson-sql stop
Reread the configuration options for a running service:
dse client-tool alwayson-sql reconfig