Function createIndexes

Create SQLite indexes.

See https://www.evolu.dev/docs/indexes

Example

const indexes = createIndexes((create) => [
    create("indexTodoCreatedAt").on("todo").column("createdAt"),
    create("indexTodoCategoryCreatedAt")
      .on("todoCategory")
      .column("createdAt"),
  ]);
  • createIndexes(callback): readonly {
        name: string;
        sql: string;
    }[]

  • Parameters

    • callback: ((create: ((indexName: string) => CreateIndexBuilder<never>)) => readonly CreateIndexBuilder<any>[])
        • (create): readonly CreateIndexBuilder<any>[]

        • Parameters

          • create: ((indexName: string) => CreateIndexBuilder<never>)
              • (indexName): CreateIndexBuilder<never>

              • Create a new index.

                Examples

                await db.schema
                  .createIndex('person_full_name_unique_index')
                  .on('person')
                  .columns(['first_name', 'last_name'])
                  .execute()

                Parameters

                • indexName: string

                Returns CreateIndexBuilder<never>

          Returns readonly CreateIndexBuilder<any>[]

    Returns readonly {
        name: string;
        sql: string;
    }[]

Settings

Member Visibility

On This Page

Examples