DESCRIBE SEARCH INDEX
Shows the definition of specified search index in XML format.
Restriction: Command available only on DSE Search nodes.
Running search index management commands on large datasets can take longer than
the CQLSH default timeout of 10 minutes. Increase the CQLSH
client timeout as required.
Synopsis
DESCRIBE ( PENDING | ACTIVE )
SEARCH INDEX ( SCHEMA | CONFIG )
ON [keyspace_name.]table_name
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. |
EBNF
EBNF
syntax:
describeSearchIndex ::= 'DESCRIBE' ( 'PENDING' | 'ACTIVE' ) 'SEARCH' 'INDEX’
'ON' tableName
tableName ::= (keyspace '.')? Table
Railroad diagram:
- ACTIVE
-
Index configuration resources that are currently applied.
- PENDING
-
Index configuration resources that pending but not yet applied.
- SCHEMA
-
Show the fields to index in Solr and types associated with them. These fields map to database columns.
- CONFIG
-
Show the configuration information for the index.
- keyspace_name
- Name of the keyspace.
- table_name
- Name of the table.
Examples
Show the active index configuration for wiki.solr:
DESCRIBE ACTIVE SEARCH INDEX CONFIG ON wiki.solr;
The returned results are in XML.
Show the pending index schema for wiki.solr:
DESCRIBE PENDING SEARCH INDEX SCHEMA ON wiki.solr;