Defining Cassandra Search Index

Tab	Property	Description	Additional Information
	Name	Specifies the name of the search index
	If Not Exists	Specifies that if the table already exists, no exception is thrown, and no action happens
	Generate	Specifies whether a DDL statement is generated during forward engineering
General	Column	Specifies the name of the column in a table
copyField	Specifies whether to create a new field by copying them from the specified columns
docValues	Specifies whether to create a forward index on each specified column
excluded	Specifies whether to exclude the listed columns and fields in the columns from the index
indexed	Specifies whether to include the specified fields in the index	This option is set to TRUE by default.
Options	Profiles	Specifies to apply space saving options to reduce index size	spaceSavingAll: Indicates that all space saving profiles are applied. spaceSavingNoJoin: Indicates that the hidden partition key required for joins across tables on search queries are excluded from the index. spaceSavingSlowTriePrecision: Indicates that the trie fields precisionStep is set to "0". This allows greater space saving and reduces querying speed.
Config	Specifies the configuration options to override values in the search index	autoCommitTime: Specifies the time interval between the updates to the search index. By default, changes are automatically committed every 10000 milliseconds. defaultQueryField: Specifies the name of the default query field. directoryFactory: Specifies whether the encryption is enabled for the directory factory to use for search indexes. filterCacheLowWaterMark: Specifies the lowest watermark for filter cache memory usage filterCacheHighWaterMark: Specifies the highest watermark for filter cache memory usage directoryFactoryClass: Specifies the fully-qualified name of the directory factory. Use this option instead of the directoryFactory option for directory factories other than the standard or encrypted directory factory. mergeMaxThreadCount: Specifies the number of merges that Apache Lucene can perform for the search index. mergeMaxMergeCount: Specifies the number of pending merges that can be accumulated before the merging starts. ramBufferSize: Specifies the RAM buffer size for the index. realtime: Specifies whether the live indexing to increase the indexing throughput is enabled
Options	Specifies the options request to configure the search index	recovery: Specifies whether to recover the corrupted search index by deleting and recreating them. reindex: Specifies whether to re-index the data and keep the current index while building the new index. lenient: Specifies whether to ignore errors if an unsupported column type is encountered during the schema autogeneration.
Drop Options	Specifies the index drop options	deleteResources: Specifies whether to delete the resources associated with the search index. deleteDataDir: Specifies whether to delete index data and artifacts in the data directory. This will not delete data from the database.
Schema/Config Settings	Alter Config	Specifies commands used for modifying the pending schema of a search index. You can add new fields, change field names, change field types, or drop fields from the schema.
Alter Schema	Specifies a command to change the search index configuration

Name

Specifies the name of the search index

If Not Exists

Specifies that if the table already exists, no exception is thrown, and no action happens

Generate

Specifies whether a DDL statement is generated during forward engineering

General

Column

Specifies the name of the column in a table

copyField

Specifies whether to create a new field by copying them from the specified columns

docValues

Specifies whether to create a forward index on each specified column

excluded

Specifies whether to exclude the listed columns and fields in the columns from the index

indexed

Specifies whether to include the specified fields in the index

This option is set to TRUE by default.

Options

Profiles

Specifies to apply space saving options to reduce index size

spaceSavingAll: Indicates that all space saving profiles are applied.

spaceSavingNoJoin: Indicates that the hidden partition key required for joins across tables on search queries are excluded from the index.

spaceSavingSlowTriePrecision: Indicates that the trie fields precisionStep is set to "0". This allows greater space saving and reduces querying speed.

Config

Specifies the configuration options to override values in the search index

autoCommitTime: Specifies the time interval between the updates to the search index. By default, changes are automatically committed every 10000 milliseconds.

defaultQueryField: Specifies the name of the default query field.

directoryFactory: Specifies whether the encryption is enabled for the directory factory to use for search indexes.

filterCacheLowWaterMark: Specifies the lowest watermark for filter cache memory usage

filterCacheHighWaterMark: Specifies the highest watermark for filter cache memory usage

directoryFactoryClass: Specifies the fully-qualified name of the directory factory. Use this option instead of the directoryFactory option for directory factories other than the standard or encrypted directory factory.

mergeMaxThreadCount: Specifies the number of merges that Apache Lucene can perform for the search index.

mergeMaxMergeCount: Specifies the number of pending merges that can be accumulated before the merging starts.

ramBufferSize: Specifies the RAM buffer size for the index.

realtime: Specifies whether the live indexing to increase the indexing throughput is enabled

Options

Specifies the options request to configure the search index

recovery: Specifies whether to recover the corrupted search index by deleting and recreating them.

reindex: Specifies whether to re-index the data and keep the current index while building the new index.

lenient: Specifies whether to ignore errors if an unsupported column type is encountered during the schema autogeneration.

Drop Options

Specifies the index drop options

deleteResources: Specifies whether to delete the resources associated with the search index.

deleteDataDir: Specifies whether to delete index data and artifacts in the data directory. This will not delete data from the database.

Schema/Config Settings

Alter Config

Specifies commands used for modifying the pending schema of a search index. You can add new fields, change field names, change field types, or drop fields from the schema.

Alter Schema

Specifies a command to change the search index configuration