DESCRIBE SCHEMA

Provides high-level details about the connected cluster or definitions of all objects in the cluster.

Outputs cluster information including cluster name, partitioner, and snitch and for non-system keyspaces, the endpoint-range ownership information is also shown. Shows definition for all objects in the entire cluster.

Synopsis

DESCRIBE [FULL] SCHEMA|CLUSTER
Legend
Syntax conventions Description
UPPERCASE Literal keyword.
Lowercase Not literal.
Italics Variable value. Replace with a 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.
Note: On Linux systems object names, such as keyspace names, table names, and so forth are case sensitive. By default, CQL converts names to lowercase unless enclosed in double quotes.
[FULL] SCHEMA
Outputs information for all objects in the cluster in CQL executable format.
CLUSTER
Outputs general information, such as cluster and partitioner name.

Examples

Show high-level details for a single node test cluster:
DESC CLUSTER

Cluster: Test Cluster
Partitioner: Murmur3Partitioner