drizzle-orm
Version:
Drizzle ORM package for SQL databases
32 lines (31 loc) • 1.35 kB
TypeScript
import { type Config, type Connection } from '@tidbcloud/serverless';
import { entityKind } from "../entity.js";
import type { Logger } from "../logger.js";
import { MySqlDatabase } from "../mysql-core/db.js";
import { type DrizzleConfig } from "../utils.js";
import type { TiDBServerlessPreparedQueryHKT, TiDBServerlessQueryResultHKT } from "./session.js";
export interface TiDBServerlessSDriverOptions {
logger?: Logger;
}
export declare class TiDBServerlessDatabase<TSchema extends Record<string, unknown> = Record<string, never>> extends MySqlDatabase<TiDBServerlessQueryResultHKT, TiDBServerlessPreparedQueryHKT, TSchema> {
static readonly [entityKind]: string;
}
export declare function drizzle<TSchema extends Record<string, unknown> = Record<string, never>, TClient extends Connection = Connection>(...params: [
TClient | string
] | [
TClient | string,
DrizzleConfig<TSchema>
] | [
({
connection: string | Config;
} | {
client: TClient;
}) & DrizzleConfig<TSchema>
]): TiDBServerlessDatabase<TSchema> & {
$client: TClient;
};
export declare namespace drizzle {
function mock<TSchema extends Record<string, unknown> = Record<string, never>>(config?: DrizzleConfig<TSchema>): TiDBServerlessDatabase<TSchema> & {
$client: '$client is not available on drizzle.mock()';
};
}