Class: Client#
Hierarchy#
EventEmitter
↳ Client
Constructors#
constructor#
+ new Client(config: Config<any>): Client
Parameters:#
| Name | Type |
|---|---|
config | Config<any> |
Returns: Client
Overrides: void
Defined in: node_modules/knex/types/index.d.ts:2180
Properties#
canCancelQuery#
• canCancelQuery: boolean
Defined in: node_modules/knex/types/index.d.ts:2230
config#
• config: Config<any>
Defined in: node_modules/knex/types/index.d.ts:2182
connectionConfigExpirationChecker#
• connectionConfigExpirationChecker: null | () => boolean
Defined in: node_modules/knex/types/index.d.ts:2193
connectionConfigProvider#
• connectionConfigProvider: any
Defined in: node_modules/knex/types/index.d.ts:2192
connectionSettings#
• connectionSettings: object
Defined in: node_modules/knex/types/index.d.ts:2185
dialect#
• dialect: string
Defined in: node_modules/knex/types/index.d.ts:2183
driver#
• driver: any
Defined in: node_modules/knex/types/index.d.ts:2217
driverName#
• driverName: string
Defined in: node_modules/knex/types/index.d.ts:2184
logger#
• logger: Logger
Defined in: node_modules/knex/types/index.d.ts:2190
pool#
• pool: undefined | Pool<any>
Defined in: node_modules/knex/types/index.d.ts:2225
valueForUndefined#
• valueForUndefined: any
Defined in: node_modules/knex/types/index.d.ts:2194
version#
• Optional version: string
Defined in: node_modules/knex/types/index.d.ts:2191
captureRejectionSymbol#
â–ª Readonly Static captureRejectionSymbol: typeof captureRejectionSymbol
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:43
captureRejections#
â–ª Static captureRejections: boolean
Sets or gets the default captureRejection value for all emitters.
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:49
defaultMaxListeners#
â–ª Static defaultMaxListeners: number
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:50
errorMonitor#
â–ª Readonly Static errorMonitor: typeof errorMonitor
This symbol shall be used to install a listener for only monitoring 'error'
events. Listeners installed using this symbol are called before the regular
'error' listeners are called.
Installing a listener using this symbol does not change the behavior once an
'error' event is emitted, therefore the process will still crash if no
regular 'error' listener is installed.
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:42
Methods#
acquireConnection#
â–¸ acquireConnection(): any
Returns: any
Defined in: node_modules/knex/types/index.d.ts:2226
acquireRawConnection#
â–¸ acquireRawConnection(): Promise<any>
Returns: Promise<any>
Defined in: node_modules/knex/types/index.d.ts:2187
addListener#
â–¸ addListener(event: string | symbol, listener: (...args: any[]) => void): Client
Parameters:#
| Name | Type |
|---|---|
event | string | symbol |
listener | (...args: any[]) => void |
Returns: Client
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:62
assertCanCancelQuery#
â–¸ assertCanCancelQuery(): void
Returns: void
Defined in: node_modules/knex/types/index.d.ts:2231
cancelQuery#
â–¸ cancelQuery(): void
Returns: void
Defined in: node_modules/knex/types/index.d.ts:2232
columnBuilder#
â–¸ columnBuilder(tableBuilder: any, type: any, args: any): ColumnBuilder
Parameters:#
| Name | Type |
|---|---|
tableBuilder | any |
type | any |
args | any |
Returns: ColumnBuilder
Defined in: node_modules/knex/types/index.d.ts:2202
columnCompiler#
â–¸ columnCompiler(tableBuilder: any, columnBuilder: any): any
Parameters:#
| Name | Type |
|---|---|
tableBuilder | any |
columnBuilder | any |
Returns: any
Defined in: node_modules/knex/types/index.d.ts:2203
customWrapIdentifier#
â–¸ customWrapIdentifier(value: any, origImpl: any, queryContext: any): any
Parameters:#
| Name | Type |
|---|---|
value | any |
origImpl | any |
queryContext | any |
Returns: any
Defined in: node_modules/knex/types/index.d.ts:2214
database#
â–¸ database(): any
Returns: any
Defined in: node_modules/knex/types/index.d.ts:2229
destroy#
â–¸ destroy(callback: any): any
Parameters:#
| Name | Type |
|---|---|
callback | any |
Returns: any
Defined in: node_modules/knex/types/index.d.ts:2228
destroyRawConnection#
â–¸ destroyRawConnection(connection: any): Promise<void>
Parameters:#
| Name | Type |
|---|---|
connection | any |
Returns: Promise<void>
Defined in: node_modules/knex/types/index.d.ts:2188
emit#
â–¸ emit(event: string | symbol, ...args: any[]): boolean
Parameters:#
| Name | Type |
|---|---|
event | string | symbol |
...args | any[] |
Returns: boolean
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:72
eventNames#
â–¸ eventNames(): (string | symbol)[]
Returns: (string | symbol)[]
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:77
formatter#
â–¸ formatter(builder: any): any
Parameters:#
| Name | Type |
|---|---|
builder | any |
Returns: any
Defined in: node_modules/knex/types/index.d.ts:2195
getMaxListeners#
â–¸ getMaxListeners(): number
Returns: number
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:69
getPoolSettings#
â–¸ getPoolSettings(poolConfig: any): any
Parameters:#
| Name | Type |
|---|---|
poolConfig | any |
Returns: any
Defined in: node_modules/knex/types/index.d.ts:2223
initializeDriver#
â–¸ initializeDriver(): void
Returns: void
Defined in: node_modules/knex/types/index.d.ts:2216
initializePool#
â–¸ initializePool(config?: {}): void
Parameters:#
| Name | Type |
|---|---|
config? | object |
Returns: void
Defined in: node_modules/knex/types/index.d.ts:2224
listenerCount#
â–¸ listenerCount(event: string | symbol): number
Parameters:#
| Name | Type |
|---|---|
event | string | symbol |
Returns: number
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:73
listeners#
â–¸ listeners(event: string | symbol): Function[]
Parameters:#
| Name | Type |
|---|---|
event | string | symbol |
Returns: Function[]
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:70
off#
â–¸ off(event: string | symbol, listener: (...args: any[]) => void): Client
Parameters:#
| Name | Type |
|---|---|
event | string | symbol |
listener | (...args: any[]) => void |
Returns: Client
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:66
on#
â–¸ on(event: string | symbol, listener: (...args: any[]) => void): Client
Parameters:#
| Name | Type |
|---|---|
event | string | symbol |
listener | (...args: any[]) => void |
Returns: Client
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:63
once#
â–¸ once(event: string | symbol, listener: (...args: any[]) => void): Client
Parameters:#
| Name | Type |
|---|---|
event | string | symbol |
listener | (...args: any[]) => void |
Returns: Client
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:64
poolDefaults#
â–¸ poolDefaults(): object
Returns: object
| Name | Type |
|---|---|
max | number |
min | number |
propagateCreateError | boolean |
Defined in: node_modules/knex/types/index.d.ts:2218
positionBindings#
â–¸ positionBindings(sql: any): any
Parameters:#
| Name | Type |
|---|---|
sql | any |
Returns: any
Defined in: node_modules/knex/types/index.d.ts:2211
postProcessResponse#
â–¸ postProcessResponse(resp: any, queryContext: any): any
Parameters:#
| Name | Type |
|---|---|
resp | any |
queryContext | any |
Returns: any
Defined in: node_modules/knex/types/index.d.ts:2212
prepBindings#
â–¸ prepBindings(bindings: any): any
Parameters:#
| Name | Type |
|---|---|
bindings | any |
Returns: any
Defined in: node_modules/knex/types/index.d.ts:2210
prependListener#
â–¸ prependListener(event: string | symbol, listener: (...args: any[]) => void): Client
Parameters:#
| Name | Type |
|---|---|
event | string | symbol |
listener | (...args: any[]) => void |
Returns: Client
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:75
prependOnceListener#
â–¸ prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): Client
Parameters:#
| Name | Type |
|---|---|
event | string | symbol |
listener | (...args: any[]) => void |
Returns: Client
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:76
query#
â–¸ query(connection: any, obj: any): any
Parameters:#
| Name | Type |
|---|---|
connection | any |
obj | any |
Returns: any
Defined in: node_modules/knex/types/index.d.ts:2208
queryBuilder#
â–¸ queryBuilder(): QueryBuilder<any, any>
Returns: QueryBuilder<any, any>
Defined in: node_modules/knex/types/index.d.ts:2196
queryCompiler#
â–¸ queryCompiler(builder: any): any
Parameters:#
| Name | Type |
|---|---|
builder | any |
Returns: any
Defined in: node_modules/knex/types/index.d.ts:2197
raw#
â–¸ raw(...args: any[]): any
Parameters:#
| Name | Type |
|---|---|
...args | any[] |
Returns: any
Defined in: node_modules/knex/types/index.d.ts:2206
rawListeners#
â–¸ rawListeners(event: string | symbol): Function[]
Parameters:#
| Name | Type |
|---|---|
event | string | symbol |
Returns: Function[]
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:71
ref#
â–¸ ref(...args: any[]): Ref<any, any>
Parameters:#
| Name | Type |
|---|---|
...args | any[] |
Returns: Ref<any, any>
Defined in: node_modules/knex/types/index.d.ts:2207
releaseConnection#
â–¸ releaseConnection(connection: any): any
Parameters:#
| Name | Type |
|---|---|
connection | any |
Returns: any
Defined in: node_modules/knex/types/index.d.ts:2227
removeAllListeners#
â–¸ removeAllListeners(event?: string | symbol): Client
Parameters:#
| Name | Type |
|---|---|
event? | string | symbol |
Returns: Client
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:67
removeListener#
â–¸ removeListener(event: string | symbol, listener: (...args: any[]) => void): Client
Parameters:#
| Name | Type |
|---|---|
event | string | symbol |
listener | (...args: any[]) => void |
Returns: Client
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:65
runner#
â–¸ runner(builder: any): any
Parameters:#
| Name | Type |
|---|---|
builder | any |
Returns: any
Defined in: node_modules/knex/types/index.d.ts:2204
schemaBuilder#
â–¸ schemaBuilder(): SchemaBuilder
Returns: SchemaBuilder
Defined in: node_modules/knex/types/index.d.ts:2198
schemaCompiler#
â–¸ schemaCompiler(builder: SchemaBuilder): any
Parameters:#
| Name | Type |
|---|---|
builder | SchemaBuilder |
Returns: any
Defined in: node_modules/knex/types/index.d.ts:2199
setMaxListeners#
â–¸ setMaxListeners(n: number): Client
Parameters:#
| Name | Type |
|---|---|
n | number |
Returns: Client
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:68
stream#
â–¸ stream(connection: any, obj: any, stream: any, options: any): any
Parameters:#
| Name | Type |
|---|---|
connection | any |
obj | any |
stream | any |
options | any |
Returns: any
Defined in: node_modules/knex/types/index.d.ts:2209
tableBuilder#
â–¸ tableBuilder(type: any, tableName: any, fn: any): TableBuilder
Parameters:#
| Name | Type |
|---|---|
type | any |
tableName | any |
fn | any |
Returns: TableBuilder
Defined in: node_modules/knex/types/index.d.ts:2200
tableCompiler#
â–¸ tableCompiler(tableBuilder: any): any
Parameters:#
| Name | Type |
|---|---|
tableBuilder | any |
Returns: any
Defined in: node_modules/knex/types/index.d.ts:2201
transaction#
â–¸ transaction(container: any, config: any, outerTx: any): Transaction<any, any>
Parameters:#
| Name | Type |
|---|---|
container | any |
config | any |
outerTx | any |
Returns: Transaction<any, any>
Defined in: node_modules/knex/types/index.d.ts:2205
validateConnection#
â–¸ validateConnection(connection: any): Promise<boolean>
Parameters:#
| Name | Type |
|---|---|
connection | any |
Returns: Promise<boolean>
Defined in: node_modules/knex/types/index.d.ts:2189
wrapIdentifier#
â–¸ wrapIdentifier(value: any, queryContext: any): any
Parameters:#
| Name | Type |
|---|---|
value | any |
queryContext | any |
Returns: any
Defined in: node_modules/knex/types/index.d.ts:2213
wrapIdentifierImpl#
â–¸ wrapIdentifierImpl(value: any): string
Parameters:#
| Name | Type |
|---|---|
value | any |
Returns: string
Defined in: node_modules/knex/types/index.d.ts:2215
listenerCount#
â–¸ StaticlistenerCount(emitter: EventEmitter, event: string | symbol): number
deprecated since v4.0.0
Parameters:#
| Name | Type |
|---|---|
emitter | EventEmitter |
event | string | symbol |
Returns: number
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:31
on#
â–¸ Staticon(emitter: EventEmitter, event: string): AsyncIterableIterator<any>
Parameters:#
| Name | Type |
|---|---|
emitter | EventEmitter |
event | string |
Returns: AsyncIterableIterator<any>
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:28
once#
â–¸ Staticonce(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
Parameters:#
| Name | Type |
|---|---|
emitter | NodeEventTarget |
event | string | symbol |
Returns: Promise<any[]>
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:26
â–¸ Staticonce(emitter: DOMEventTarget, event: string): Promise<any[]>
Parameters:#
| Name | Type |
|---|---|
emitter | DOMEventTarget |
event | string |
Returns: Promise<any[]>
Inherited from: void
Defined in: node_modules/@types/node/events.d.ts:27