Initial commit

node_modules/drizzle-orm/pg-core/indexes.d.ts

@@ -0,0 +1,79 @@
+import { SQL } from "../sql/sql.js";
+import { entityKind } from "../entity.js";
+import type { ExtraConfigColumn, PgColumn } from "./columns/index.js";
+import { IndexedColumn } from "./columns/index.js";
+import type { PgTable } from "./table.js";
+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' | 'bpchar_ops' | 'char_ops' | 'cidr_ops' | 'cstring_ops' | 'date_ops' | 'float_ops' | 'int2_ops' | 'int4_ops' | 'int8_ops' | 'interval_ops' | 'jsonb_ops' | 'macaddr_ops' | 'name_ops' | 'numeric_ops' | 'oid_ops' | 'oidint4_ops' | 'oidint8_ops' | 'oidname_ops' | 'oidvector_ops' | 'point_ops' | 'polygon_ops' | 'range_ops' | 'record_eq' | 'record_ge' | 'record_gt' | 'record_le' | 'record_lt' | 'record_ne' | 'text_ops' | 'time_ops' | 'timestamp_ops' | 'timestamptz_ops' | 'timetz_ops' | 'uuid_ops' | 'varbit_ops' | 'varchar_ops' | 'xml_ops' | 'vector_l2_ops' | 'vector_ip_ops' | 'vector_cosine_ops' | 'vector_l1_ops' | 'bit_hamming_ops' | 'bit_jaccard_ops' | 'halfvec_l2_ops' | 'sparsevec_l2_op' | (string & {});
+export declare class IndexBuilderOn {
+    private unique;
+    private name?;
+    static readonly [entityKind]: string;
+    constructor(unique: boolean, name?: string | undefined);
+    on(...columns: [Partial<ExtraConfigColumn> | SQL, ...Partial<ExtraConfigColumn | SQL>[]]): IndexBuilder;
+    onOnly(...columns: [Partial<ExtraConfigColumn | SQL>, ...Partial<ExtraConfigColumn | SQL>[]]): IndexBuilder;
+    /**
+     * Specify what index method to use. Choices are `btree`, `hash`, `gist`, `spgist`, `gin`, `brin`, or user-installed access methods like `bloom`. The default method is `btree.
+     *
+     * If you have the `pg_vector` extension installed in your database, you can use the `hnsw` and `ivfflat` options, which are predefined types.
+     *
+     * **You can always specify any string you want in the method, in case Drizzle doesn't have it natively in its types**
+     *
+     * @param method The name of the index method to be used
+     * @param columns
+     * @returns
+     */
+    using(method: PgIndexMethod, ...columns: [Partial<ExtraConfigColumn | SQL>, ...Partial<ExtraConfigColumn | SQL>[]]): IndexBuilder;
+}
+export interface AnyIndexBuilder {
+    build(table: PgTable): Index;
+}
+export interface IndexBuilder extends AnyIndexBuilder {
+}
+export declare class IndexBuilder implements AnyIndexBuilder {
+    static readonly [entityKind]: string;
+    constructor(columns: Partial<IndexedColumn | SQL>[], unique: boolean, only: boolean, name?: string, method?: string);
+    concurrently(): this;
+    with(obj: Record<string, any>): this;
+    where(condition: SQL): this;
+}
+export declare class Index {
+    static readonly [entityKind]: string;
+    readonly config: IndexConfig & {
+        table: PgTable;
+    };
+    constructor(config: IndexConfig, table: PgTable);
+}
+export type GetColumnsTableName<TColumns> = TColumns extends PgColumn ? TColumns['_']['name'] : TColumns extends PgColumn[] ? TColumns[number]['_']['name'] : never;
+export declare function index(name?: string): IndexBuilderOn;
+export declare function uniqueIndex(name?: string): IndexBuilderOn;
+export {};