Function index

index<T = Record<string, unknown>>(
    key: string,
    table: string,
    columns: string | string[] | IndexColumnDefinition[],
    options?: Omit<CreateIndexOptions, "batchSize">,
): Promise<QueryResult<T>>
Creates an index on the shard resolved by the provided key.
Type Parameters
- T = Record<string, unknown>
Parameters
- key: string
  Primary key used for shard routing
- table: string
  Target table name
- columns: string | string[] | IndexColumnDefinition[]
  One or more columns to index
- options: Omit<CreateIndexOptions, "batchSize"> = {}
  Index creation options
Returns Promise<QueryResult<T>>
Query result for the DDL statement

Since
1.1.4
- Defined in src/router.ts:2307