63 lines
2.2 KiB
Plaintext
63 lines
2.2 KiB
Plaintext
import { entityKind } from "../entity.js";
|
|
import type { SQL } from "../sql/sql.js";
|
|
import type { AnySingleStoreColumn, SingleStoreColumn } from "./columns/index.js";
|
|
import type { SingleStoreTable } from "./table.js";
|
|
interface IndexConfig {
|
|
name: string;
|
|
columns: IndexColumn[];
|
|
/**
|
|
* If true, the index will be created as `create unique index` instead of `create index`.
|
|
*/
|
|
unique?: boolean;
|
|
/**
|
|
* If set, the index will be created as `create index ... using { 'btree' | 'hash' }`.
|
|
*/
|
|
using?: 'btree' | 'hash';
|
|
/**
|
|
* If set, the index will be created as `create index ... algorithm { 'default' | 'inplace' | 'copy' }`.
|
|
*/
|
|
algorithm?: 'default' | 'inplace' | 'copy';
|
|
/**
|
|
* If set, adds locks to the index creation.
|
|
*/
|
|
lock?: 'default' | 'none' | 'shared' | 'exclusive';
|
|
}
|
|
export type IndexColumn = SingleStoreColumn | SQL;
|
|
export declare class IndexBuilderOn {
|
|
private name;
|
|
private unique;
|
|
static readonly [entityKind]: string;
|
|
constructor(name: string, unique: boolean);
|
|
on(...columns: [IndexColumn, ...IndexColumn[]]): IndexBuilder;
|
|
}
|
|
export interface AnyIndexBuilder {
|
|
build(table: SingleStoreTable): Index;
|
|
}
|
|
export interface IndexBuilder extends AnyIndexBuilder {
|
|
}
|
|
export declare class IndexBuilder implements AnyIndexBuilder {
|
|
static readonly [entityKind]: string;
|
|
constructor(name: string, columns: IndexColumn[], unique: boolean);
|
|
using(using: IndexConfig['using']): this;
|
|
algorithm(algorithm: IndexConfig['algorithm']): this;
|
|
lock(lock: IndexConfig['lock']): this;
|
|
}
|
|
export declare class Index {
|
|
static readonly [entityKind]: string;
|
|
readonly config: IndexConfig & {
|
|
table: SingleStoreTable;
|
|
};
|
|
constructor(config: IndexConfig, table: SingleStoreTable);
|
|
}
|
|
export type GetColumnsTableName<TColumns> = TColumns extends AnySingleStoreColumn<{
|
|
tableName: infer TTableName extends string;
|
|
}> | AnySingleStoreColumn<{
|
|
tableName: infer TTableName extends string;
|
|
}>[] ? TTableName : never;
|
|
export declare function index(name: string): IndexBuilderOn;
|
|
export declare function uniqueIndex(name: string): IndexBuilderOn;
|
|
export {};
|
|
/** @internal */
|
|
/** @internal */
|
|
/** @internal */
|