@medusajs/utils/dist/common/create-psql-index-helper.d.ts

Medusa utilities functions shared by Medusa core and Modules

import { Index } from "@mikro-orm/core";
/**
 * Create a PSQL index statement
 * @param name The name of the index, if not provided it will be generated in the format IDX_tableName_columnName
 * @param tableName The name of the table
 * @param columns The columns to index
 * @param type The type of index (e.g GIN, GIST, BTREE, etc)
 * @param where The where clause
 * @param unique If the index should be a unique index
 *
 * @example
 * createPsqlIndexStatementHelper({
 *   name: "idx_user_email",
 *   tableName: "user",
 *   columns: "email",
 *   type: "btree",
 *   where: "email IS NOT NULL"
 * });
 *
 * // expression:  CREATE INDEX IF NOT EXISTS idx_user_email ON user USING btree (email) WHERE email IS NOT NULL;
 *
 * createPsqlIndexStatementHelper({
 *   name: "idx_user_email",
 *   tableName: "user",
 *   columns: "email"
 * });
 *
 * // expression: CREATE INDEX IF NOT EXISTS idx_user_email ON user (email);
 *
 */
export declare function createPsqlIndexStatementHelper({ name, tableName: qualifiedName, columns, type, where, unique, }: {
    name?: string;
    tableName: string;
    columns: string | string[];
    type?: string;
    where?: string;
    unique?: boolean;
}): {
    toString: () => string;
    valueOf: () => string;
    name: string;
    expression: string;
    MikroORMIndex: (options?: Parameters<typeof Index>[0]) => (target: import("@mikro-orm/core").AnyEntity, propertyName?: string) => any;
};
//# sourceMappingURL=create-psql-index-helper.d.ts.map