Package com.datastax.astra.client.tables.definition.indexes

Class TableRegularIndexDefinition

java.lang.Object

com.datastax.astra.client.tables.definition.indexes.TableIndexDefinition<TableIndexDefinitionOptions>

com.datastax.astra.client.tables.definition.indexes.TableRegularIndexDefinition

public class TableRegularIndexDefinition
extends TableIndexDefinition<TableIndexDefinitionOptions>

Represents a definition for table indices, allowing customization of various indexing options. This class provides a fluent interface to configure column names and index properties such as ASCII encoding, normalization, and case sensitivity.

Example usage:

 
 TableIndexDefinition indexDefinition = new TableIndexDefinition()
     .column("username")
     .ascii(true)
     .normalize(false)
     .caseSensitive(true);
 
 

Field Summary

Fields inherited from class com.datastax.astra.client.tables.definition.indexes.TableIndexDefinition

apiSupport, column, constructor, options

Constructor Summary

Constructors

Modifier	Constructor	Description
	TableRegularIndexDefinition()	Default constructor.
protected	TableRegularIndexDefinition(TableIndexDefinitionOptions options)	Constructor that accepts a set of index options.

Method Summary

Modifier and Type	Method	Description
TableRegularIndexDefinition	ascii(boolean ascii)	Enables or disables ASCII encoding for the index.
TableRegularIndexDefinition	caseSensitive(boolean caseSensitive)	Sets whether the index should be case-sensitive.
TableRegularIndexDefinition	column(String column)	Sets the name of the column for the index.
TableRegularIndexDefinition	column(String column, TableIndexMapTypes type)	Sets the name of the column for the index.
TableRegularIndexDefinition	normalize(boolean normalize)	Enables or disables normalization for the index.
TableRegularIndexDefinition	options(TableIndexDefinitionOptions options)	Sets the options for configuring the table index.

Methods inherited from class com.datastax.astra.client.tables.definition.indexes.TableIndexDefinition

mapImpl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TableRegularIndexDefinition

public TableRegularIndexDefinition()

Default constructor.

TableRegularIndexDefinition

protected TableRegularIndexDefinition(TableIndexDefinitionOptions options)

Constructor that accepts a set of index options.

Parameters:

options - the index options to use.

Method Details

column

public TableRegularIndexDefinition column(String column)

Description copied from class: TableIndexDefinition

Sets the name of the column for the index.

Overrides:

column in class TableIndexDefinition<TableIndexDefinitionOptions>

Parameters:

column - the name of the column to be indexed.

Returns:

a new instance with the updated column.

column

public TableRegularIndexDefinition column(String column,
 TableIndexMapTypes type)

Description copied from class: TableIndexDefinition

Sets the name of the column for the index.

Overrides:

column in class TableIndexDefinition<TableIndexDefinitionOptions>

Parameters:

column - the name of the column to be indexed.

type - the type of the column to be indexed.

Returns:

the current instance of TableIndexDefinition for method chaining.

options

public TableRegularIndexDefinition options(TableIndexDefinitionOptions options)

Description copied from class: TableIndexDefinition

Sets the options for configuring the table index.

Overrides:

options in class TableIndexDefinition<TableIndexDefinitionOptions>

Parameters:

options - an instance of TableIndexDefinitionOptions containing index options.

Returns:

the current instance of TableIndexDefinition for method chaining.

ascii

public TableRegularIndexDefinition ascii(boolean ascii)

Enables or disables ASCII encoding for the index.

Parameters:

ascii - true to enable ASCII encoding, false otherwise.

Returns:

the current instance of TableIndexDefinition for method chaining.

normalize

public TableRegularIndexDefinition normalize(boolean normalize)

Enables or disables normalization for the index.

Parameters:

normalize - true to enable normalization, false otherwise.

Returns:

the current instance of TableIndexDefinition for method chaining.

caseSensitive

public TableRegularIndexDefinition caseSensitive(boolean caseSensitive)

Sets whether the index should be case-sensitive.

Parameters:

caseSensitive - true if the index should be case-sensitive, false otherwise.

Returns:

the current instance of TableIndexDefinition for method chaining.