dsetool index_checks (experimental)
Reads the full index and optionally performs sanity checks. No repairs or fixes occur. Run only when index is inactive. No writes are allowed while index check is running.
|
Running this index check is time consuming and implies a hard commit. |
Restriction: Command is supported only on nodes with DSE Search workloads.
Synopsis
dsetool index_checks <keyspace_name>.<table_name>
[coreOptions=<yamlFilepath>]|[coreOptionsInline=<options>]
--index_checks=true|false
--index_checks_stop=true|falseSyntax legend
| Syntax conventions | Description |
|---|---|
Italic, bold, or |
Syntax diagrams and code samples use one or more of these styles to mark placeholders for variable values. Replace placeholders with a valid option or your own user-defined value. In CQL statements, angle brackets are required to enclose data types in a set, list, map, or tuple.
Separate the data types with a comma.
For example: In Search CQL statements, angle brackets are used to identify the entity and literal value to overwrite the XML element in the schema and |
|
Square brackets surround optional command arguments. Do not type the square brackets. |
|
Parentheses identify a group to choose from. Do not type the parentheses. |
|
A pipe separates alternative elements. Type any one of the elements. Do not type the pipe. |
|
Indicates that you can repeat the syntax element as often as required. |
|
Single quotation marks must surround literal strings in CQL statements.
Use single quotation marks to preserve upper case.
+
For Search CQL only: Single quotation marks surround an entire XML schema declaration, such as |
|
Map collection.
Curly braces enclose maps ( |
|
Ends a CQL statement. |
|
Separate command line options from command arguments with two hyphens. This syntax is useful when arguments might be mistaken for command line options. |
- keyspace_name.table_name
-
Required. The keyspace and table names of the search index. Keyspace and table names are case-sensitive. Enclose names that contain uppercase in double quotation marks.
- coreOptions=<yamlFilepath>
-
When auto-generation is on (
generateResources=true), provide the file path to a customized YAML-formatted file of options. See Changing auto-generated search index settings. - coreOptionsInline=key1:value1#key2:value2#…
-
Using the key-value pair syntax
key1:value1#key2:value2#, specify values for these settings:-
auto_soft_commit_max_time:ms -
default_query_field:field -
distributed:(true|false) -
enable_string_copy_fields:(true|false) -
exclude_columns: col1, col2, col3, … -
generate_DocValues_for_fields:( * | field1, field2, …) -
generateResources:(true|false)
-
- --index_checks=true|false
-
Specify to run the index check.
-
true - Runs the index check to verify index integrity. Reads the full index and has performance impact.
-
false - Default. Does not run the index check.
-
- --index_checks_stop=true|false
-
Specify to stop the index check.
-
true - Requests the index check to stop.
-
false - Does not stop the index check.
-
Examples
|
Ensure that indexing is inactive before doing an index check. |
To do an index check:
dsetool index_checks demo.health_dataThe LUKE handler information is displayed:
LUKE handler info:
------------------
numDocs:0
maxDoc:0
deletedDocs:0
indexHeapUsageBytes:0
version:2
segmentCount:0
current:true
hasDeletions:false
directory:org.apache.lucene.store.MMapDirectory:MMapDirectory@/Users/maryjoe/dse/data/solr.data/demo.health_data/index lockFactory=org.apache.lucene.store.NativeFSLockFactory@5c94e0dd
segmentsFile:segments_1
segmentsFileSizeInBytes:71
userData:{}