Class CreateIndexBuilder<C>

Simply calls the provided function passing this as the only argument. $call returns what the provided function returns.

Adds a column to the index.

Also see columns for adding multiple columns at once.

Examples

import { sql } from 'kysely'

await db.schema
  .createIndex('person_first_name_and_age_index')
  .on('person')
  .column('first_name')
  .column<'last_name'>(sql`left(lower("last_name"), 1)`)
  .column('age desc')
  .where('last_name', 'is not', null)
  .execute()
Copy

The generated SQL (PostgreSQL):

create index "person_first_name_and_age_index"
on "person" ("first_name", left(lower("last_name"), 1), "age" desc)
where "last_name" is not null
Copy

Adds a column to the index.

Also see columns for adding multiple columns at once.

Examples

import { sql } from 'kysely'

await db.schema
  .createIndex('person_first_name_and_age_index')
  .on('person')
  .column('first_name')
  .column<'last_name'>(sql`left(lower("last_name"), 1)`)
  .column('age desc')
  .where('last_name', 'is not', null)
  .execute()
Copy

The generated SQL (PostgreSQL):

create index "person_first_name_and_age_index"
on "person" ("first_name", left(lower("last_name"), 1), "age" desc)
where "last_name" is not null
Copy

Adds a list of columns to the index.

Also see column for adding a single column.

Examples

import { sql } from 'kysely'

await db.schema
  .createIndex('person_first_name_and_age_index')
  .on('person')
  .columns(['first_name', sql`left(lower("last_name"), 1)`, 'age desc'])
  .execute()
Copy

The generated SQL (PostgreSQL):

create index "person_first_name_and_age_index"
on "person" ("first_name", left(lower("last_name"), 1), "age" desc)
Copy

Adds an arbitrary expression as a column to the index.

Examples

import { sql } from 'kysely'

await db.schema
  .createIndex('person_first_name_index')
  .on('person')
  .expression(sql`first_name COLLATE "fi_FI"`)
  .column('gender')
  .execute()
Copy

The generated SQL (PostgreSQL):

create index "person_first_name_index"
on "person" (first_name COLLATE "fi_FI", "gender")
Copy

Adds the "if not exists" modifier.

If the index already exists, no error is thrown if this method has been called.

Adds nulls not distinct specifier to index. This only works on some dialects like PostgreSQL.

Examples

db.schema.createIndex('person_first_name_index')
 .on('person')
 .column('first_name')
 .nullsNotDistinct()
 .execute()
Copy

The generated SQL (PostgreSQL):

create index "person_first_name_index"
on "test" ("first_name")
nulls not distinct;
Copy

Specifies the table for the index.

Makes the index unique.

Specifies the index type.

Examples

await db.schema
  .createIndex('person_first_name_index')
  .on('person')
  .column('first_name')
  .using('hash')
  .execute()
Copy

The generated SQL (MySQL):

create index `person_first_name_index` on `person` (`first_name`) using hash
Copy

Specifies the index type.

Examples

await db.schema
  .createIndex('person_first_name_index')
  .on('person')
  .column('first_name')
  .using('hash')
  .execute()
Copy

The generated SQL (MySQL):

create index `person_first_name_index` on `person` (`first_name`) using hash
Copy

Adds a where clause to the query. This Effectively turns the index partial.

This is only supported by some dialects like PostgreSQL and MS SQL Server.

Examples

import { sql } from 'kysely'

await db.schema
   .createIndex('orders_unbilled_index')
   .on('orders')
   .column('order_nr')
   .where(sql.ref('billed'), 'is not', true)
   .where('order_nr', 'like', '123%')
Copy

The generated SQL (PostgreSQL):

create index "orders_unbilled_index" on "orders" ("order_nr") where "billed" is not true and "order_nr" like '123%'
Copy

Column names specified in column or columns are known at compile-time and can be referred to in the current query and context.

Sometimes you may want to refer to columns that exist in the table but are not part of the current index. In that case you can refer to them using sql expressions.

Parameters are always sent as literals due to database restrictions.

Adds a where clause to the query. This Effectively turns the index partial.

This is only supported by some dialects like PostgreSQL and MS SQL Server.

Examples

import { sql } from 'kysely'

await db.schema
   .createIndex('orders_unbilled_index')
   .on('orders')
   .column('order_nr')
   .where(sql.ref('billed'), 'is not', true)
   .where('order_nr', 'like', '123%')
Copy

The generated SQL (PostgreSQL):

create index "orders_unbilled_index" on "orders" ("order_nr") where "billed" is not true and "order_nr" like '123%'
Copy

Column names specified in column or columns are known at compile-time and can be referred to in the current query and context.

Sometimes you may want to refer to columns that exist in the table but are not part of the current index. In that case you can refer to them using sql expressions.

Parameters are always sent as literals due to database restrictions.

Adds a where clause to the query. This Effectively turns the index partial.

This is only supported by some dialects like PostgreSQL and MS SQL Server.

Examples

import { sql } from 'kysely'

await db.schema
   .createIndex('orders_unbilled_index')
   .on('orders')
   .column('order_nr')
   .where(sql.ref('billed'), 'is not', true)
   .where('order_nr', 'like', '123%')
Copy

The generated SQL (PostgreSQL):

create index "orders_unbilled_index" on "orders" ("order_nr") where "billed" is not true and "order_nr" like '123%'
Copy

Column names specified in column or columns are known at compile-time and can be referred to in the current query and context.

Sometimes you may want to refer to columns that exist in the table but are not part of the current index. In that case you can refer to them using sql expressions.

Parameters are always sent as literals due to database restrictions.