Skip to main content
Module

x/mysql2/promise.d.ts

MySQL client for Deno with focus on performance. Supports prepared statements, non-utf8 encodings, binary log protocol, compression much more
Go to Latest
File
// deno-lint-ignore-file no-explicit-anyimport type { RowDataPacket, OkPacket, ResultSetHeader, FieldPacket, QueryOptions, ConnectionOptions, PoolOptions} from './index.d.ts';
import type { EventEmitter } from "./deps.ts";export * from './index.ts';
export interface Connection extends EventEmitter { config: ConnectionOptions; threadId: number;
connect(): Promise<void>; ping(): Promise<void>;
beginTransaction(): Promise<void>; commit(): Promise<void>; rollback(): Promise<void>;
changeUser(options: ConnectionOptions): Promise<void>;
query<T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader>( sql: string ): Promise<[T, FieldPacket[]]>; query<T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader>( sql: string, values: any | any[] | { [param: string]: any } ): Promise<[T, FieldPacket[]]>; query<T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader>( options: QueryOptions ): Promise<[T, FieldPacket[]]>; query<T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader>( options: QueryOptions, values: any | any[] | { [param: string]: any } ): Promise<[T, FieldPacket[]]>;
execute< T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader >( sql: string ): Promise<[T, FieldPacket[]]>; execute< T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader >( sql: string, values: any | any[] | { [param: string]: any } ): Promise<[T, FieldPacket[]]>; execute< T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader >( options: QueryOptions ): Promise<[T, FieldPacket[]]>; execute< T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader >( options: QueryOptions, values: any | any[] | { [param: string]: any } ): Promise<[T, FieldPacket[]]>;
unprepare(sql: string): void;
end(options?: any): Promise<void>;
destroy(): void;
pause(): void;
resume(): void;
escape(value: any): string;
escapeId(value: string): string; escapeId(values: string[]): string;
format(sql: string, values?: any | any[] | { [param: string]: any }): string;}
export interface PoolConnection extends Connection { connection: Connection; release(): void;}
export interface Pool extends EventEmitter { query<T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader>( sql: string ): Promise<[T, FieldPacket[]]>; query<T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader>( sql: string, values: any | any[] | { [param: string]: any } ): Promise<[T, FieldPacket[]]>; query<T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader>( options: QueryOptions ): Promise<[T, FieldPacket[]]>; query<T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader>( options: QueryOptions, values: any | any[] | { [param: string]: any } ): Promise<[T, FieldPacket[]]>;
execute< T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader >( sql: string ): Promise<[T, FieldPacket[]]>; execute< T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader >( sql: string, values: any | any[] | { [param: string]: any } ): Promise<[T, FieldPacket[]]>; execute< T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader >( options: QueryOptions ): Promise<[T, FieldPacket[]]>; execute< T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader >( options: QueryOptions, values: any | any[] | { [param: string]: any } ): Promise<[T, FieldPacket[]]>;
getConnection(): Promise<PoolConnection>; on(event: 'connection', listener: (connection: PoolConnection) => any): this; on(event: 'acquire', listener: (connection: PoolConnection) => any): this; on(event: 'release', listener: (connection: PoolConnection) => any): this; on(event: 'enqueue', listener: () => any): this; end(): Promise<void>;}
export function createConnection(connectionUri: string): Promise<Connection>;export function createConnection( config: ConnectionOptions): Promise<Connection>;export function createPool(config: PoolOptions): Pool;