dse advrep channel create

Create a replication channel configuration.

A replication channel is a defined channel of change data between source clusters and destination clusters.

Command is supported only on nodes configured for DSE Advanced Replication.

Synopsis

dse advrep channel create
    --source-keyspace keyspace_name
    --source-table source_table_name
    --source-id source_id_name
    --source-id-column source_id_column_name
    --destination destination
    --destination-keyspace destination_keyspace_name
    --destination-table destination_table_name
[ --fifo-order | --lifo-order ] [ --collection-enabled (true|false) ]
[ --priority channel_priority ] [ --transmission-enabled (true|false) ]

Syntax legend

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.

--source-keyspace keyspace_name (required): The source cluster keyspace to replicate.
--source-table source_table_name (required): The source table to replicate.
--source-id id: A unique identifier for all data that comes from a particular source node.
--source-id-column source_id: The column that identifies the source id in the destination table.
--destination destination (required): The destination where the replication is sent; the user names the destination.
--destination-keyspace keyspace_name: The destination keyspace to which the replication is sent.
--destination-table table_name: The destination table to which the replication is sent.
--fifo-order: First in, first out channel (FIFO) replication order. Default.
--lifo-order: Last in, last out (LIFO) channel replication order.
--collection-enabled (true|false): Whether to enable the source table for replication collection on creation.
--transmission-enabled (true|false): Whether to replicate data collector for the table to the destination.
--priority channel_priority: The order in which the source table log files are transmitted.

Examples

To create a replication source channel:

$ dse advrep channel create --source-keyspace foo --source-table bar --source-id source1 --source-id-column source_id --destination mydest --destination-keyspace foo --destination-table bar --collection-enabled true --priority 1

with a result as seen using dse advrep channel status:

$ Created channel dc=Cassandra keyspace=foo table=bar to mydest

The source datacenter is the datacenter in which the command is run. The keyspace and table names on the destination can be different than on the source, but in this example they are the same. You can also set the source-id and source-id-column differently from the global setting.

dse advrep channel create

Synopsis

Examples

Was this helpful?

Give Feedback