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

Class TableTextIndexDefinition

java.lang.Object

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

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

public class TableTextIndexDefinition
extends TableIndexDefinition<TableTextIndexDefinitionOptions>

Represents a definition for table vector indices, allowing configuration of vector-specific options such as similarity metrics and source models. This class provides a fluent interface for building vector index definitions.

Example usage:

 
 TableTextIndexDefinition vectorIndexDefinition = new TableTextIndexDefinition()
     .column("feature_vector")
     .options(new TableTextIndexDefinitionOptions());
 
 

Field Summary

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

apiSupport, column, constructor, options

Constructor Summary

Constructors

Modifier	Constructor	Description
	TableTextIndexDefinition()	Constructs a new TableVectorIndexDefinition instance.
protected	TableTextIndexDefinition(TableTextIndexDefinitionOptions options)	Constructs a new TableVectorIndexDefinition instance with the specified options.

Method Summary

Modifier and Type	Method	Description
TableTextIndexDefinition	analyzer(Analyzer analyzer)	Setter for the analyzer
TableTextIndexDefinition	analyzer(AnalyzerTypes analyzerTypes)	Setter for the analyzer with a type
TableTextIndexDefinition	column(String column)	Setter for the column name
TableTextIndexDefinition	column(String column, TableIndexMapTypes type)	Setter for the column name
TableTextIndexDefinition	options(TableTextIndexDefinitionOptions options)	Setter for the options

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

TableTextIndexDefinition

public TableTextIndexDefinition()

Constructs a new TableVectorIndexDefinition instance.

TableTextIndexDefinition

protected TableTextIndexDefinition(TableTextIndexDefinitionOptions options)

Constructs a new TableVectorIndexDefinition instance with the specified options.

Parameters:

options - the options to use for the vector index.

Method Details

column

public TableTextIndexDefinition column(String column)

Setter for the column name

Overrides:

column in class TableIndexDefinition<TableTextIndexDefinitionOptions>

Parameters:

column - the name of the column to index.

Returns:

self reference

column

public TableTextIndexDefinition column(String column,
 TableIndexMapTypes type)

Setter for the column name

Overrides:

column in class TableIndexDefinition<TableTextIndexDefinitionOptions>

Parameters:

column - the name of the column to index.

type - the type of the index.

Returns:

self reference

options

public TableTextIndexDefinition options(TableTextIndexDefinitionOptions options)

Setter for the options

Overrides:

options in class TableIndexDefinition<TableTextIndexDefinitionOptions>

Parameters:

options - the options of the index.

Returns:

self reference

analyzer

public TableTextIndexDefinition analyzer(Analyzer analyzer)

Setter for the analyzer

Parameters:

analyzer - Value for analyzer

Returns:

Self reference

analyzer

public TableTextIndexDefinition analyzer(AnalyzerTypes analyzerTypes)

Setter for the analyzer with a type

Parameters:

analyzerTypes - Type of the analyzer

Returns:

Self reference