Create a text index (Java)

Lexicographical matching is currently in public preview. Development is ongoing, and the features and functionality are subject to change. Astra DB Serverless, and the use of such, is subject to the DataStax Preview Terms.

Creates a new text index for a text or ascii column in a table.

You must create a text index if you want to perform lexicographical matching on the column.

To index a text column for sorting and filtering other than lexicographical matching, see Create an index (Java) instead.

To manage indexes, your application token must have the same level of permissions that you need to manage tables.

Ready to write code? See the examples for this method to get started. If you are new to the Data API, check out the quickstart.

Result

Creates a text index for the specified column.

Does not return anything.

Parameters

Use the createTextIndex method, which belongs to the com.datastax.astra.client.tables.Table class.

Method signature

void createTextIndex(
  String indexName,
  String columnName
)

void createTextIndex(
  String indexName,
  TableTextIndexDefinition indexDefinition
)

void createIndex(
  String indexName,
  TableTextIndexDefinition indexDefinition,
  CreateTextIndexOptions indexOptions
)

Name Type Summary

Name	Type	Summary
`name`	`string`	The name of the index. Index names for tables must follow these rules: Must be unique within the keyspace Can contain letters, numbers, and underscores Must have a length of 1 to 100 characters
`definition`	`TableTextIndexDefinition`	The index definition. See Methods of the `TableTextIndexDefinition` constructor for more details.
`options`	`CreateTextIndexOptions`	The options for this operation. See Methods of the `CreateTextIndexOptions` constructor for more details.

name

string

The name of the index.

Index names for tables must follow these rules:

Must be unique within the keyspace
Can contain letters, numbers, and underscores
Must have a length of 1 to 100 characters

definition

TableTextIndexDefinition

The index definition. See Methods of the TableTextIndexDefinition constructor for more details.

options

CreateTextIndexOptions

The options for this operation. See Methods of the CreateTextIndexOptions constructor for more details.

Methods of the `TableTextIndexDefinition` constructor
Method	Type	Summary
`column`	`string`	The name of the table column on which to create the text index. The column must be a `text` or `ascii` column.
`analyzer`	`string` or `object` or `Analyzer`	Optional. A string describing a built-in analyzer, or a JSON object or `Analyzer` describing an analyzer configuration. Strings must be one of the supported built-in analyzers. JSON objects must follow the specifications in Find data with CQL analyzers. See the examples for usage. Default: `"standard"`, which corresponds to the standard Apache Lucene™ analyzer.

Methods of the `CreateTextIndexOptions` constructor
Method	Type	Summary
`ifNotExists`	`boolean`	Optional. Whether the command should silently succeed even if an index with the given name already exists in the keyspace and no new index was created. This option only checks index names. It does not check index definitions. For an example, see Create a text index only if the index does not exist. Default: false

Examples

The following examples demonstrate how to create a text index.

Create a text index and use the default analyzer

If you don’t specify an analyzer, the index will use the standard Apache Lucene™ analyzer.

import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.tables.Table;
import com.datastax.astra.client.tables.definition.rows.Row;

public class Example {

  public static void main(String[] args) {
    // Get an existing table
    Table<Row> table =
        new DataAPIClient("APPLICATION_TOKEN")
            .getDatabase("API_ENDPOINT")
            .getTable("TABLE_NAME");

    // Index a column
    table.createTextIndex("INDEX_NAME", "TEXT_COLUMN_NAME");
  }
}

Create a text index and specify the analyzer as a string

You can use a string to specify the analyzer. Strings must be one of the supported built-in analyzers.

Alternatively, you can describe the analyzer configuration as a JSON object as demonstrated in Create a text index and specify the analyzer as an object.

import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.core.lexical.AnalyzerTypes;
import com.datastax.astra.client.tables.Table;
import com.datastax.astra.client.tables.definition.indexes.TableTextIndexDefinition;
import com.datastax.astra.client.tables.definition.rows.Row;

public class Example {

  public static void main(String[] args) {
    // Get an existing table
    Table<Row> table =
        new DataAPIClient("APPLICATION_TOKEN")
            .getDatabase("API_ENDPOINT")
            .getTable("TABLE_NAME");

    // Index a column
    TableTextIndexDefinition definition =
        new TableTextIndexDefinition()
            .column("TEXT_COLUMN_NAME")
            .analyzer(AnalyzerTypes.ENGLISH);
    table.createTextIndex("INDEX_NAME", definition);
  }
}

Create a text index and specify the analyzer as an object

You can describe the analyzer configuration as a JSON object. JSON objects must follow the specifications in Find data with CQL analyzers.

The following example uses a configuration suitable for English text. Alternatively, you can use the string shorthand demonstrated in Create a text index and specify the analyzer as a string.

import static com.datastax.astra.client.core.lexical.AnalyzerTypes.STANDARD;

import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.core.lexical.Analyzer;
import com.datastax.astra.client.tables.Table;
import com.datastax.astra.client.tables.definition.indexes.TableTextIndexDefinition;
import com.datastax.astra.client.tables.definition.rows.Row;

public class Example {

  public static void main(String[] args) {
    // Get an existing table
    Table<Row> table =
        new DataAPIClient("APPLICATION_TOKEN")
            .getDatabase("API_ENDPOINT")
            .getTable("TABLE_NAME");

    // Index a column
    Analyzer analyzer =
        new Analyzer()
            .tokenizer(STANDARD.getValue())
            .addFilter("lowercase")
            .addFilter("stop")
            .addFilter("porterstem")
            .addFilter("asciifolding");
    TableTextIndexDefinition definition =
        new TableTextIndexDefinition().column("TEXT_COLUMN_NAME").analyzer(analyzer);
    table.createTextIndex("INDEX_NAME", definition);
  }
}

Create a text index only if the index does not exist

Use this option to silently do nothing if a text index with the specified name already exists.

This option only checks index names. It does not check index definitions.

import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.tables.Table;
import com.datastax.astra.client.tables.commands.options.CreateTextIndexOptions;
import com.datastax.astra.client.tables.definition.indexes.TableTextIndexDefinition;
import com.datastax.astra.client.tables.definition.rows.Row;

public class Example {

  public static void main(String[] args) {
    // Get an existing table
    Table<Row> table =
        new DataAPIClient("APPLICATION_TOKEN")
            .getDatabase("API_ENDPOINT")
            .getTable("TABLE_NAME");

    // Index a column
    CreateTextIndexOptions options = new CreateTextIndexOptions().ifNotExists(true);
    TableTextIndexDefinition definition =
        new TableTextIndexDefinition().column("TEXT_COLUMN_NAME");
    table.createTextIndex("INDEX_NAME", definition, options);
  }
}

Client reference

For more information, see the client reference.

Create a text index (Java)

Result

Parameters

Examples

Create a text index and use the default analyzer

Create a text index and specify the analyzer as a string

Create a text index and specify the analyzer as an object

Create a text index only if the index does not exist

Client reference

Was this helpful?

Give Feedback