Class AlterTableAddIndexBuilder

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 or expression for specifying an arbitrary expression.

Examples

import { sql } from 'kysely'

await db.schema
  .alterTable('person')
  .addIndex('person_first_name_and_age_index')
  .column('first_name')
  .column(sql`(left(lower(last_name), 1))`)
  .column('age desc')
  .execute()
Copy

The generated SQL (MySQL):

alter table `person`
add index `person_first_name_and_age_index` (
  `first_name`,
  (left(lower(last_name), 1)),
  `age` desc
)
Copy

Adds a column to the index.

Also see columns for adding multiple columns at once or expression for specifying an arbitrary expression.

Examples

import { sql } from 'kysely'

await db.schema
  .alterTable('person')
  .addIndex('person_first_name_and_age_index')
  .column('first_name')
  .column(sql`(left(lower(last_name), 1))`)
  .column('age desc')
  .execute()
Copy

The generated SQL (MySQL):

alter table `person`
add index `person_first_name_and_age_index` (
  `first_name`,
  (left(lower(last_name), 1)),
  `age` desc
)
Copy

Specifies a list of columns for the index.

Also see column for adding a single column or expression for specifying an arbitrary expression.

Examples

import { sql } from 'kysely'

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

The generated SQL (MySQL):

alter table `person`
add index `person_first_name_and_age_index` (
  `first_name`,
  (left(lower(last_name), 1)),
  `age` desc
)
Copy

Specifies an arbitrary expression for the index.

Examples

import { sql } from 'kysely'

await db.schema
  .alterTable('person')
  .addIndex('person_first_name_index')
  .expression(sql<boolean>`(first_name < 'Sami')`)
  .execute()
Copy

The generated SQL (MySQL):

alter table `person` add index `person_first_name_index` ((first_name < 'Sami'))
Copy

Makes the index unique.

Examples

await db.schema
  .alterTable('person')
  .addIndex('person_first_name_index')
  .unique()
  .column('email')
  .execute()
Copy

The generated SQL (MySQL):

alter table `person` add unique index `person_first_name_index` (`email`)
Copy

Specifies the index type.

Examples

await db.schema
  .alterTable('person')
  .addIndex('person_first_name_index')
  .column('first_name')
  .using('hash')
  .execute()
Copy

The generated SQL (MySQL):

alter table `person` add index `person_first_name_index` (`first_name`) using hash
Copy

Specifies the index type.

Examples

await db.schema
  .alterTable('person')
  .addIndex('person_first_name_index')
  .column('first_name')
  .using('hash')
  .execute()
Copy

The generated SQL (MySQL):

alter table `person` add index `person_first_name_index` (`first_name`) using hash
Copy