Class Query

Hierarchy

Query

Constructors

constructor

new Query(options?: Options): Query

- Defined in src/index.ts:295
Parameters
- options: Options = {}
Returns Query

Properties

_connection

_connection: mariadb.Connection

Methods

affectedRows

affectedRows(): number

- Defined in src/index.ts:639
Returns number

batch

batch<V>(sql: string | QueryOptions, values?: Partial<V>): Promise<UpsertResult | UpsertResult[]>

- Defined in src/index.ts:603
Type Parameters
- V = Record<string, any>
Parameters
- sql: string | QueryOptions
- Optional values: Partial<V>
Returns Promise<UpsertResult | UpsertResult[]>

clusterBatch

clusterBatch<V>(sql: string | QueryOptions, values?: Partial<V>): Promise<UpsertResult | UpsertResult[]>

- Defined in src/index.ts:436
Type Parameters
- V = Record<string, any>
Parameters
- sql: string | QueryOptions
- Optional values: Partial<V>
Returns Promise<UpsertResult | UpsertResult[]>

clusterInsert

clusterInsert<T, V>(table: T, params: Partial<V> | Partial<V>[], options?: InsertOptions): Promise<UpsertResult | UpsertResult[]>

- Defined in src/index.ts:454
Type Parameters
- T extends string
- V = Record<string, any>
Parameters
- table: T
- params: Partial<V> | Partial<V>[]
- Optional options: InsertOptions
Returns Promise<UpsertResult | UpsertResult[]>

clusterQuery

clusterQuery<T, V>(sql: string | QueryOptions, values?: Partial<V>): Promise<T>

- Defined in src/index.ts:410
Type Parameters
- T extends unknown = QueryResult
- V = Record<string, any>
Parameters
- sql: string | QueryOptions
- Optional values: Partial<V>
Returns Promise<T>

clusterQueryStream

clusterQueryStream<V>(sql: string | QueryOptions, values?: Partial<V>): Promise<Readable>

- Defined in src/index.ts:428
Type Parameters
- V = Record<string, any>
Parameters
- sql: string | QueryOptions
- Optional values: Partial<V>
Returns Promise<Readable>

clusterUpdate

clusterUpdate<T, V>(table: T, where: string, params: Partial<V>, options?: { ignore?: boolean }): Promise<UpsertResult>

- Defined in src/index.ts:476
Type Parameters
- T extends string
- V = Record<string, any>
Parameters
- table: T
- where: string
- params: Partial<V>
- Optional options: { ignore?: boolean }
  - Optional ignore?: boolean
Returns Promise<UpsertResult>

createConnection

createConnection(config: ConnectionConfig): Promise<Connection>

- Defined in src/index.ts:299
Parameters
- config: ConnectionConfig
Returns Promise<Connection>

createPageQueryInterface

createPageQueryInterface<T>(opt: PageInterfaceOptions<T>): Promise<void>

- Defined in src/index.ts:275
Type Parameters
- T
Parameters
- opt: PageInterfaceOptions<T>
Returns Promise<void>

createPool

createPool(config: PoolConfig): mariadbPool

- Defined in src/index.ts:305
Parameters
- config: PoolConfig
Returns mariadbPool

createPoolCluster

createPoolCluster(config?: PoolClusterConfig): PoolCluster

- Defined in src/index.ts:312
Parameters
- Optional config: PoolClusterConfig
Returns PoolCluster

createStreamQueryInterface

createStreamQueryInterface<T>(opt: StreamInterfaceOptions): BuildmsqlReadable<T>

- Defined in src/index.ts:221
Type Parameters
- T
Parameters
- opt: StreamInterfaceOptions
Returns BuildmsqlReadable<T>

end

end(): Promise<void>

- Defined in src/index.ts:791
Returns Promise<void>

getCluster

getCluster(): PoolCluster

- Defined in src/index.ts:331
Returns PoolCluster

getConfig

getConfig(): ConnectionConfig | PoolConfig | PoolClusterConfig

- Defined in src/index.ts:319
Returns ConnectionConfig | PoolConfig | PoolClusterConfig

getConnection

getConnection(): Promise<Connection>

- Defined in src/index.ts:339
Returns Promise<Connection>

getConnectionCluster

getConnectionCluster(pattern?: string, selector?: string): Promise<Connection>

- Defined in src/index.ts:347
Parameters
- Optional pattern: string
- Optional selector: string
Returns Promise<Connection>

getMeta

getMeta(): MetadataResultSet[] | UpsertResult | UpsertResult[]

- Defined in src/index.ts:628
Returns MetadataResultSet[] | UpsertResult | UpsertResult[]

getPool

getPool(): mariadbPool

- Defined in src/index.ts:323
Returns mariadbPool

insert

insert<T, V>(table: T, params: Partial<V> | Partial<V>[], options?: InsertOptions): Promise<UpsertResult | UpsertResult[]>

- Defined in src/index.ts:666
Type Parameters
- T extends string
- V = Record<string, any>
Parameters
- table: T
- params: Partial<V> | Partial<V>[]
- Optional options: InsertOptions
Returns Promise<UpsertResult | UpsertResult[]>

lastInsertId

lastInsertId<T>(): T

- Defined in src/index.ts:633
Type Parameters
- T = number
Returns T

poolBatch

poolBatch<V>(sql: string | QueryOptions, values?: Partial<V>): Promise<UpsertResult | UpsertResult[]>

- Defined in src/index.ts:374
Type Parameters
- V = Record<string, any>
Parameters
- sql: string | QueryOptions
- Optional values: Partial<V>
Returns Promise<UpsertResult | UpsertResult[]>

poolInsert

poolInsert<T, V>(table: T, params: Partial<V> | Partial<V>[], options?: InsertOptions): Promise<UpsertResult | UpsertResult[]>

- Defined in src/index.ts:382
Type Parameters
- T extends string
- V = Record<string, any>
Parameters
- table: T
- params: Partial<V> | Partial<V>[]
- Optional options: InsertOptions
Returns Promise<UpsertResult | UpsertResult[]>

poolQuery

poolQuery<T, V>(sql: string | QueryOptions, values?: Partial<V>): Promise<T>

- Defined in src/index.ts:358
Type Parameters
- T extends unknown = QueryResult
- V = Record<string, any>
Parameters
- sql: string | QueryOptions
- Optional values: Partial<V>
Returns Promise<T>

poolQueryStream

poolQueryStream<V>(sql: string | QueryOptions, values?: Partial<V>): Promise<Readable>

- Defined in src/index.ts:366
Type Parameters
- V = Record<string, any>
Parameters
- sql: string | QueryOptions
- Optional values: Partial<V>
Returns Promise<Readable>

poolUpdate

poolUpdate<T, V>(table: T, where: string, params: Partial<V>, options?: { exclude?: string[]; ignore?: boolean }): Promise<UpsertResult>

- Defined in src/index.ts:394
Type Parameters
- T extends string
- V = Record<string, any>
Parameters
- table: T
- where: string
- params: Partial<V>
- Optional options: { exclude?: string[]; ignore?: boolean }
  - Optional exclude?: string[]
  - Optional ignore?: boolean
Returns Promise<UpsertResult>

query

query<T, V>(sql: string | QueryOptions, values?: Partial<V>): Promise<T>

- Defined in src/index.ts:541
Type Parameters
- T extends unknown = QueryResult
- V = Record<string, any>
Parameters
- sql: string | QueryOptions
- Optional values: Partial<V>
Returns Promise<T>

queryStream

queryStream<V>(sql: string | QueryOptions, values?: Partial<V>): Promise<Readable>

- Defined in src/index.ts:568
Type Parameters
- V = Record<string, any>
Parameters
- sql: string | QueryOptions
- Optional values: Partial<V>
Returns Promise<Readable>

quote

quote(input: any): string

- Defined in src/index.ts:651
Parameters
- input: any
Returns string

statistics

statistics(): { count: number; queries: QueriesInfo[]; time: number }

- Defined in src/index.ts:802
Returns { count: number; queries: QueriesInfo[]; time: number }
- count: number
- queries: QueriesInfo[]
- time: number

update

update<T, V>(table: T, where: string, params: Partial<V>, options?: UpdateOptions): Promise<UpsertResult>

- Defined in src/index.ts:768
Type Parameters
- T extends string
- V = Record<string, any>
Parameters
- table: T
- where: string
- params: Partial<V>
- Optional options: UpdateOptions
Returns Promise<UpsertResult>

warningStatus

warningStatus(): number

- Defined in src/index.ts:645
Returns number

Generated using TypeDoc