indexes.ts — drizzle-orm Source File

Source Code

import { SQL } from '~/sql/sql.ts';

import { entityKind, is } from '~/entity.ts';
import type { ExtraConfigColumn, PgColumn } from './columns/index.ts';
import { IndexedColumn } from './columns/index.ts';
import type { PgTable } from './table.ts';

interface IndexConfig {
	name?: string;

	columns: Partial<IndexedColumn | SQL>[];

	/**
	 * If true, the index will be created as `create unique index` instead of `create index`.
	 */
	unique: boolean;

	/**
	 * If true, the index will be created as `create index concurrently` instead of `create index`.
	 */
	concurrently?: boolean;

	/**
	 * If true, the index will be created as `create index ... on only <table>` instead of `create index ... on <table>`.
	 */
	only: boolean;

	/**
	 * Condition for partial index.
	 */
	where?: SQL;

	/**
	 * The optional WITH clause specifies storage parameters for the index
	 */
	with?: Record<string, any>;

	/**
	 * The optional WITH clause method for the index
	 */
	method?: 'btree' | string;
}

export type IndexColumn = PgColumn;

export type PgIndexMethod = 'btree' | 'hash' | 'gist' | 'spgist' | 'gin' | 'brin' | 'hnsw' | 'ivfflat' | (string & {});

export type PgIndexOpClass =
	| 'abstime_ops'
	| 'access_method'
	| 'anyarray_eq'
	| 'anyarray_ge'
	| 'anyarray_gt'
	| 'anyarray_le'
	| 'anyarray_lt'
	| 'anyarray_ne'
	| 'bigint_ops'
	| 'bit_ops'
	| 'bool_ops'
	| 'box_ops'
// ... (192 more lines)