Create a text index (TypeScript)
|
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 (TypeScript) 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.
Returns a promise that resolves once the operation completes.
Parameters
Use the createTextIndex method, which belongs to the Table class.
Method signature
async createTextIndex(
name: string,
column: keyof Schema | Partial<Record<keyof Schema, string>>,
options?: {
options?: {
analyzer?: string | Record<string, unknown>,
},
ifNotExists?: boolean,
timeout?: number | TimeoutDescriptor,
},
): void| Name | Type | Summary |
|---|---|---|
|
|
The name of the index. Index names for tables must follow these rules:
|
|
|
The name of the table column on which to create the text index. The column must be a |
|
|
Optional.
The options for this operation. See Properties of |
| Name | Type | Summary |
|---|---|---|
|
|
Optional. A string describing a built-in analyzer, or a JSON object 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: |
|
|
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 |
|
|
A timeout, in milliseconds, to impose on the underlying API request. |
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 { DataAPIClient } from "@datastax/astra-db-ts";
// Get an existing table
const client = new DataAPIClient();
const database = client.db("API_ENDPOINT", {
token: "APPLICATION_TOKEN",
});
const table = database.table("TABLE_NAME");
// Index a column
(async function () {
await 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 { DataAPIClient } from "@datastax/astra-db-ts";
// Get an existing table
const client = new DataAPIClient();
const database = client.db("API_ENDPOINT", {
token: "APPLICATION_TOKEN",
});
const table = database.table("TABLE_NAME");
// Index a column
(async function () {
await table.createTextIndex("INDEX_NAME", "TEXT_COLUMN_NAME", {
options: {
analyzer: "english",
},
});
})();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 { DataAPIClient } from "@datastax/astra-db-ts";
// Get an existing table
const client = new DataAPIClient();
const database = client.db("API_ENDPOINT", {
token: "APPLICATION_TOKEN",
});
const table = database.table("TABLE_NAME");
// Index a column
(async function () {
await table.createTextIndex("INDEX_NAME", "TEXT_COLUMN_NAME", {
options: {
analyzer: {
tokenizer: {
name: "standard",
args: {},
},
filters: [
{
name: "lowercase",
},
{
name: "stop",
},
{
name: "porterstem",
},
{
name: "asciifolding",
},
],
charFilters: [],
},
},
});
})();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 { DataAPIClient } from "@datastax/astra-db-ts";
// Get an existing table
const client = new DataAPIClient();
const database = client.db("API_ENDPOINT", {
token: "APPLICATION_TOKEN",
});
const table = database.table("TABLE_NAME");
// Index a column
(async function () {
await table.createTextIndex("INDEX_NAME", "TEXT_COLUMN_NAME", {
ifNotExists: true,
});
})();Client reference
For more information, see the client reference.
