oceanbase 0.0.1

package/typings/mysql/lib/protocol/sequences/Prepare.d.ts

@@ -0,0 +1,65 @@
+import { Sequence } from './Sequence.js';
+import { Query, QueryError, StreamOptions } from '../sequences/Query.js';
+import {
+  OkPacket,
+  FieldPacket,
+  RowDataPacket,
+  ResultSetHeader,
+} from '../packets/index.js';
+import { Readable } from 'stream';
+
+export class PrepareStatementInfo {
+  close(): void;
+  execute<
+    T extends
+      | RowDataPacket[][]
+      | RowDataPacket[]
+      | OkPacket
+      | OkPacket[]
+      | ResultSetHeader,
+  >(
+    parameters: any | any[] | { [param: string]: any },
+    callback?: (err: QueryError | null, result: T, fields: FieldPacket[]) => any
+  ): Query;
+}
+
+declare class Prepare extends Sequence {
+  /**
+   * The SQL for a constructed query
+   */
+  sql: string;
+
+  /**
+   * Emits a query packet to start the query
+   */
+  start(): void;
+
+  /**
+   * Determines the packet class to use given the first byte of the packet.
+   *
+   * @param firstByte The first byte of the packet
+   * @param parser The packet parser
+   */
+  determinePacket(firstByte: number, parser: any): any;
+
+  /**
+   * Creates a Readable stream with the given options
+   *
+   * @param options The options for the stream.
+   */
+  stream(options?: StreamOptions): Readable;
+
+  on(event: string, listener: (args: []) => void): this;
+  on(event: 'error', listener: (err: QueryError) => any): this;
+  on(
+    event: 'fields',
+    listener: (fields: FieldPacket, index: number) => any
+  ): this;
+  on(
+    event: 'result',
+    listener: (result: RowDataPacket | OkPacket, index: number) => any
+  ): this;
+  on(event: 'end', listener: () => any): this;
+}
+
+export { Prepare };

package/typings/mysql/lib/protocol/sequences/Query.d.ts

@@ -0,0 +1,170 @@
+import { Sequence } from './Sequence.js';
+import { OkPacket, RowDataPacket, FieldPacket } from '../packets/index.js';
+import { Readable } from 'stream';
+import { TypeCast } from '../../parsers/typeCast.js';
+
+export interface QueryOptions {
+  /**
+   * The SQL for the query
+   */
+  sql: string;
+
+  /**
+   * The values for the query
+   */
+  values?: any | any[] | { [param: string]: any };
+
+  /**
+   * This overrides the namedPlaceholders option set at the connection level.
+   */
+  namedPlaceholders?: boolean;
+
+  /**
+   * Every operation takes an optional inactivity timeout option. This allows you to specify appropriate timeouts for
+   * operations. It is important to note that these timeouts are not part of the MySQL protocol, and rather timeout
+   * operations through the client. This means that when a timeout is reached, the connection it occurred on will be
+   * destroyed and no further operations can be performed.
+   */
+  timeout?: number;
+
+  /**
+   * Either a boolean or string. If true, tables will be nested objects. If string (e.g. '_'), tables will be
+   * nested as tableName_fieldName
+   */
+  nestTables?: any;
+
+  /**
+   * Determines if column values should be converted to native JavaScript types.
+   *
+   * @default true
+   *
+   * It is not recommended (and may go away / change in the future) to disable type casting, but you can currently do so on either the connection or query level.
+   *
+   * ---
+   *
+   * You can also specify a function to do the type casting yourself:
+   * ```ts
+   * (field: Field, next: () => unknown) => {
+   *   return next();
+   * }
+   * ```
+   *
+   * ---
+   *
+   * **WARNING:**
+   *
+   * YOU MUST INVOKE the parser using one of these three field functions in your custom typeCast callback. They can only be called once:
+   *
+   * ```js
+   * field.string();
+   * field.buffer();
+   * field.geometry();
+   * ```
+
+   * Which are aliases for:
+   *
+   * ```js
+   * parser.parseLengthCodedString();
+   * parser.parseLengthCodedBuffer();
+   * parser.parseGeometryValue();
+   * ```
+   *
+   * You can find which field function you need to use by looking at `RowDataPacket.prototype._typeCast`.
+   */
+  typeCast?: TypeCast;
+
+  /**
+   * This overrides the same option set at the connection level.
+   *
+   */
+  rowsAsArray?: boolean;
+
+  /**
+   * By specifying a function that returns a readable stream, an arbitrary stream can be sent when sending a local fs file.
+   */
+  infileStreamFactory?: (path: string) => Readable;
+}
+
+export interface StreamOptions {
+  /**
+   * Sets the max buffer size in objects of a stream
+   */
+  highWaterMark?: number;
+
+  /**
+   * The object mode of the stream is always set to `true`
+   */
+  objectMode?: true;
+}
+
+export interface QueryError extends NodeJS.ErrnoException {
+  /**
+   * Either a MySQL server error (e.g. 'ER_ACCESS_DENIED_ERROR'),
+   * a node.js error (e.g. 'ECONNREFUSED') or an internal error
+   * (e.g. 'PROTOCOL_CONNECTION_LOST').
+   */
+  code: string;
+
+  /**
+   * The sql state marker
+   */
+  sqlStateMarker?: string;
+
+  /**
+   * The sql state
+   */
+  sqlState?: string;
+
+  /**
+   * The field count
+   */
+  fieldCount?: number;
+
+  /**
+   * Boolean, indicating if this error is terminal to the connection object.
+   */
+  fatal: boolean;
+}
+
+declare class Query extends Sequence {
+  /**
+   * The SQL for a constructed query
+   */
+  sql: string;
+
+  /**
+   * Emits a query packet to start the query
+   */
+  start(): void;
+
+  /**
+   * Determines the packet class to use given the first byte of the packet.
+   *
+   * @param firstByte The first byte of the packet
+   * @param parser The packet parser
+   */
+  determinePacket(firstByte: number, parser: any): any;
+
+  /**
+   * Creates a Readable stream with the given options
+   *
+   * @param options The options for the stream.
+   */
+  stream(options?: StreamOptions): Readable;
+
+  on(event: string, listener: (...args: any[]) => void): this;
+  on(event: 'error', listener: (err: QueryError) => any): this;
+  on(
+    event: 'fields',
+    listener: (fields: FieldPacket, index: number) => any
+  ): this;
+  on(
+    event: 'result',
+    listener: (result: RowDataPacket | OkPacket, index: number) => any
+  ): this;
+  on(event: 'end', listener: () => any): this;
+}
+
+export type QueryableConstructor<T = object> = new (...args: any[]) => T;
+
+export { Query };

package/typings/mysql/lib/protocol/sequences/QueryableBase.d.ts

@@ -0,0 +1,40 @@
+import { FieldPacket, QueryResult } from '../packets/index.js';
+import {
+  Query,
+  QueryError,
+  QueryOptions,
+  QueryableConstructor,
+} from './Query.js';
+
+export declare function QueryableBase<T extends QueryableConstructor>(
+  Base?: T
+): {
+  new (...args: any[]): {
+    query<T extends QueryResult>(
+      sql: string,
+      callback?:
+        | ((err: QueryError | null, result: T, fields: FieldPacket[]) => any)
+        | undefined
+    ): Query;
+    query<T extends QueryResult>(
+      sql: string,
+      values: any,
+      callback?:
+        | ((err: QueryError | null, result: T, fields: FieldPacket[]) => any)
+        | undefined
+    ): Query;
+    query<T extends QueryResult>(
+      options: QueryOptions,
+      callback?:
+        | ((err: QueryError | null, result: T, fields?: FieldPacket[]) => any)
+        | undefined
+    ): Query;
+    query<T extends QueryResult>(
+      options: QueryOptions,
+      values: any,
+      callback?:
+        | ((err: QueryError | null, result: T, fields: FieldPacket[]) => any)
+        | undefined
+    ): Query;
+  };
+} & T;

package/typings/mysql/lib/protocol/sequences/Sequence.d.ts

@@ -0,0 +1,5 @@
+import { EventEmitter } from 'events';
+
+declare class Sequence extends EventEmitter {}
+
+export { Sequence };

package/typings/mysql/lib/protocol/sequences/promise/ExecutableBase.d.ts

@@ -0,0 +1,21 @@
+import { FieldPacket, QueryResult } from '../../packets/index.js';
+import { QueryOptions, QueryableConstructor } from '../Query.js';
+
+export declare function ExecutableBase<T extends QueryableConstructor>(
+  Base?: T
+): {
+  new (...args: any[]): {
+    execute<T extends QueryResult>(sql: string): Promise<[T, FieldPacket[]]>;
+    execute<T extends QueryResult>(
+      sql: string,
+      values: any
+    ): Promise<[T, FieldPacket[]]>;
+    execute<T extends QueryResult>(
+      options: QueryOptions
+    ): Promise<[T, FieldPacket[]]>;
+    execute<T extends QueryResult>(
+      options: QueryOptions,
+      values: any
+    ): Promise<[T, FieldPacket[]]>;
+  };
+} & T;

package/typings/mysql/lib/protocol/sequences/promise/QueryableBase.d.ts

@@ -0,0 +1,21 @@
+import { FieldPacket, QueryResult } from '../../packets/index.js';
+import { QueryOptions, QueryableConstructor } from '../Query.js';
+
+export declare function QueryableBase<T extends QueryableConstructor>(
+  Base?: T
+): {
+  new (...args: any[]): {
+    query<T extends QueryResult>(sql: string): Promise<[T, FieldPacket[]]>;
+    query<T extends QueryResult>(
+      sql: string,
+      values: any
+    ): Promise<[T, FieldPacket[]]>;
+    query<T extends QueryResult>(
+      options: QueryOptions
+    ): Promise<[T, FieldPacket[]]>;
+    query<T extends QueryResult>(
+      options: QueryOptions,
+      values: any
+    ): Promise<[T, FieldPacket[]]>;
+  };
+} & T;