dsetool core_indexing_status

Retrieves the dynamic indexing status of a search index on a DSE Search node and displays the percent complete and an estimated completion time in milliseconds.

Restriction: Command is supported only on nodes with DSE Search workloads.

Synopsis

dsetool core_indexing_status [<keyspace_name>.]<table_name> [--all] [--progress]

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.

Retrieves the dynamic indexing status (INDEXING, FINISHED, or FAILED) of the specified index or indexes.

Also identifies the reason the reindexing occurred. The possible reason for a reindexing event is categorized as one of the following:

BOOTSTRAP
NEW_SSTABLES
USER_REQUEST

Parameters:

[keyspace_name.]table_name: The search index table name is required. The keyspace name is optional. The case of keyspace and table names is preserved. You must use the correct case for the keyspace and table names.
--all: Retrieve the dynamic indexing status of the specified search index on all nodes.
--progress: Display the percent complete, an estimated completion time in milliseconds, and the reason for the reindexing. This option is ignored and is assumed true. The command always displays the status information.

Examples

These examples use the demo keyspace and health_data table.

To view the indexing status for the local node:

dsetool core_indexing_status demo.health_data

The results are displayed:

[demo.health_data]: INDEXING, 38% complete, ETA 452303 milliseconds (7 minutes 32 seconds),
                    reason: USER_REQUEST

To view the indexing status for a search index on a specified node:

dsetool -h 200.192.10.11 core_indexing_status demo.health_data

To view indexing status of all search indexes in the data center:

dsetool core_indexing_status demo.health_data --all

The results are displayed for 3 nodes in the data center:

Address 	 Core Indexing Status
200.192.10.11 	 FINISHED
200.192.10.12 	 FINISHED
200.192.10.23 	 FINISHED