`dse advrep help`

Returns a synopsis and brief description for each DSE Advanced Replication command.

Synopsis

dse advrep help [command [sub_command]]

Details

Syntax conventions Description

Syntax conventions	Description
UPPERCASE	Literal keyword.
Lowercase	Not literal.
`Italics`	Variable value. Replace with a valid option or user-defined value.
`[ ]`	Optional. Square brackets ( `[ ]` ) surround optional command arguments. Do not type the square brackets.
`( )`	Group. Parentheses ( `( )` ) identify a group to choose from. Do not type the parentheses.
`\|`	Or. A vertical bar ( `\|` ) separates alternative elements. Type any one of the elements. Do not type the vertical bar.
`...`	Repeatable. An ellipsis ( `...` ) indicates that you can repeat the syntax element as often as required.
`'Literal string'`	Single quotation ( `'` ) marks must surround literal strings in CQL statements. Use single quotation marks to preserve upper case.
`{ key:value }`	Map collection. Braces ( `{ }` ) enclose map collections or key value pairs. A colon separates the key and the value.
`<datatype1,datatype2>`	Set, list, map, or tuple. Angle brackets ( `< >` ) enclose data types in a set, list, map, or tuple. Separate the data types with a comma.
`cql_statement;`	End CQL statement. A semicolon ( `;` ) terminates all CQL statements.
`[ -- ]`	Separate the command line options from the command arguments with two hyphens ( `--` ). This syntax is useful when arguments might be mistaken for command line options.
`' <schema> … </schema> '`	Search CQL only: Single quotation marks ( `'` ) surround an entire XML schema declaration.
`@xml_entity='xml_entity_type'`	Search CQL only: Identify the entity and literal value to overwrite the XML element in the schema and solrconfig files.

UPPERCASE

Literal keyword.

Lowercase

Not literal.

Italics

Variable value. Replace with a valid option or user-defined value.

[ ]

Optional. Square brackets ( [ ] ) surround optional command arguments. Do not type the square brackets.

( )

Group. Parentheses ( ( ) ) identify a group to choose from. Do not type the parentheses.

|

Or. A vertical bar ( | ) separates alternative elements. Type any one of the elements. Do not type the vertical bar.

...

Repeatable. An ellipsis ( ... ) indicates that you can repeat the syntax element as often as required.

'Literal string'

Single quotation ( ' ) marks must surround literal strings in CQL statements. Use single quotation marks to preserve upper case.

{ key:value }

Map collection. Braces ( { } ) enclose map collections or key value pairs. A colon separates the key and the value.

<datatype1,datatype2>

Set, list, map, or tuple. Angle brackets ( < > ) enclose data types in a set, list, map, or tuple. Separate the data types with a comma.

cql_statement;

End CQL statement. A semicolon ( ; ) terminates all CQL statements.

[ -- ]

Separate the command line options from the command arguments with two hyphens ( -- ). This syntax is useful when arguments might be mistaken for command line options.

' <schema> … </schema> '

Search CQL only: Single quotation marks ( ' ) surround an entire XML schema declaration.

@xml_entity='xml_entity_type'

Search CQL only: Identify the entity and literal value to overwrite the XML element in the schema and solrconfig files.

Examples

To view a list of `dse advrep` commands:

command
Result

dse advrep help

Usage: dse advrep [OPTIONS] COMMAND [SUB_CMDS] [CMD_OPTIONS]...


 Advanced Replication configuration tool

Options:

--separator 	field separator
--use-server-config 	Read parameters from server yaml configuration files. It assumes this node is properly configured.
--no-pretty-print 	if not specified data is printed using tabular output, otherwise data is printed as a comma separated list
--jmx-pwd 	JMX Metrics PWD
--host 	Cassandra host (Native Transport broadcast address), default localhost
--port 	Cassandra Native Transport connection port
--kerberos-enabled 	Whether to enable Kerberos authentication or not when connecting to Cassandra
--keystore-password 	Keystore password for connection to Cassandra when SSL client auth is enabled
--keystore-path 	Keystore for connection to Cassandra when SSL client auth is enabled
--keystore-type 	Keystore type for connection to Cassandra when SSL client auth is enabled
--truststore-password 	Truststore password for connection to Cassandra when SSL is enabled
--truststore-path 	Truststore for connection to Cassandra when SSL is enabled
--truststore-type 	Truststore type for connection to Cassandra when SSL is enabled
--sasl-protocol-name 	SASL protocol name, that is the DSE service principal name
--ssl-enabled 	Whether to enable SSL or not when connecting to Cassandra (Driver|JMX), same as --ssl
--ssl 	Whether to enable SSL or not when connecting to Cassandra (Driver|JMX), same as --ssl-enabled true
--ssl-protocol 	SSL protocol for connection to Cassandra when SSL is enabled
-t 	Delegation token which can be used to login, alternatively environment variable DSE_TOKEN can be used
-p 	DSE password, alternatively DSE_PASSWORD environment variable can be used
-u 	DSE username, alternatively DSE_USERNAME environment variable can be used
--cipher-suites 	Comma separated list of SSL cipher suites for connection to Cassandra when SSL is enabled
--jmx-port 	JMX port, default 7199
--jmx-user 	JMX Metrics User
--verbose

Commands:

 help	Display help information, advrep help [command] [sub-command] ...
 conf	List/Create/Update global configuration
 channel	List/Create/Update, Pause, Resume Replication Channels for tables to a DSE cluster destination
 destination	List/Create/Update/Delete a DSE cluster destination configuration
 replog	Analyzes the replication log
 metrics	performance/error metrics via JMX

To view help for a specific command:

command
Result

dse advrep help channel

channel

 List/Create/Update, Pause, Resume Replication Channels for tables to a DSE cluster destination


Options:


Commands:

 create	 Create a channel from a keyspace table to a specified destination cluster
 update	 Update a channel
 delete	 Delete a channel
 pause	 Pause replication for a channel
 resume	 Resume replication for a paused channel
 status	 List all channels and their configurations created for replication
 truncate	 Truncate a channel, all messages currently in the replication log for that channel are not replicated

To view help for a specific command and `sub_command`:

command
Result

dse advrep help channel create

create
 Create a channel from a keyspace table to a specified destination cluster

Options:

--data-center-id 	Data center this replication channel is meant for, if none specified the replication will happen in all specified dc1
--source-keyspace 	(required) keyspace of table to replicate
--source-table 	(required) table to replicate
--priority 	The table destination priority
--source-id
--source-id-column
--destination-keyspace 	The destination keyspace
--destination-table 	The destination table
--destination 	(required) The destination to which the replication should be sent to
--lifo-order 	Specify if the channel should be replicated in LIFO order. FIFO order is used otherwise.
--fifo-order 	Specify if the channel should be replicated in FIFO order. This is the default behaviour.
--transmission-enabled 	[true|false] Specify if data collector for the table should be replicated to the destination
--collection-enabled 	[true|false] Specify if the table should be enabled for replication collection on creation
--help 	Display help information, advrep help [command] [sub-command] ...

`dse advrep help`

Synopsis

Examples

To view a list of `dse advrep` commands:

To view help for a specific command:

To view help for a specific command and `sub_command`:

Was this helpful?

Give Feedback

dse advrep help

Synopsis

Examples

To view a list of dse advrep commands:

To view help for a specific command:

To view help for a specific command and sub_command:

Was this helpful?

`dse advrep help`

To view a list of `dse advrep` commands:

To view help for a specific command and `sub_command`: