Interface: IDbAdapter
Defined in: src/adapters/IDbAdapter.ts:19
Methods
connect()
connect():
Promise<void>
Defined in: src/adapters/IDbAdapter.ts:23
Returns
Promise<void>
disconnect()
disconnect():
Promise<void>
Defined in: src/adapters/IDbAdapter.ts:24
Returns
Promise<void>
ping()
ping():
Promise<boolean>
Defined in: src/adapters/IDbAdapter.ts:25
Returns
Promise<boolean>
executeQuery()
executeQuery<
T>(sql,params?,transaction?):Promise<T[]>
Defined in: src/adapters/IDbAdapter.ts:27
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters
| Parameter | Type |
|---|---|
sql | string |
params? | AdapterParam[] |
transaction? | DbTransaction |
Returns
Promise<T[]>
executeNonQuery()
executeNonQuery(
sql,params?,transaction?):Promise<{rowsAffected:number;insertId?:unknown; }>
Defined in: src/adapters/IDbAdapter.ts:33
Parameters
| Parameter | Type |
|---|---|
sql | string |
params? | AdapterParam[] |
transaction? | DbTransaction |
Returns
Promise<{ rowsAffected: number; insertId?: unknown; }>
executeScalar()
executeScalar<
T>(sql,params?,transaction?):Promise<T>
Defined in: src/adapters/IDbAdapter.ts:39
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters
| Parameter | Type |
|---|---|
sql | string |
params? | AdapterParam[] |
transaction? | DbTransaction |
Returns
Promise<T>
executeProcedure()
executeProcedure<
T>(name,params,timeoutMs?,transaction?):Promise<StoredProcedureResult<T[]>>
Defined in: src/adapters/IDbAdapter.ts:45
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters
| Parameter | Type |
|---|---|
name | string |
params | AdapterParam[] |
timeoutMs? | number |
transaction? | DbTransaction |
Returns
Promise<StoredProcedureResult<T[]>>
executeProcedureMultiple()
executeProcedureMultiple<
T>(name,params,timeoutMs?,transaction?):Promise<StoredProcedureResult<T>>
Defined in: src/adapters/IDbAdapter.ts:52
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends unknown[] | unknown[] |
Parameters
| Parameter | Type |
|---|---|
name | string |
params | AdapterParam[] |
timeoutMs? | number |
transaction? | DbTransaction |
Returns
Promise<StoredProcedureResult<T>>
beginTransaction()
beginTransaction(
isolationLevel?):Promise<DbTransaction>
Defined in: src/adapters/IDbAdapter.ts:59
Parameters
| Parameter | Type |
|---|---|
isolationLevel? | IsolationLevel |
Returns
Promise<DbTransaction>
escapeIdentifier()
escapeIdentifier(
name):string
Defined in: src/adapters/IDbAdapter.ts:61
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
string
formatParameterPlaceholder()
formatParameterPlaceholder(
paramName,index):string
Defined in: src/adapters/IDbAdapter.ts:62
Parameters
| Parameter | Type |
|---|---|
paramName | string |
index | number |
Returns
string
executeStream()?
optionalexecuteStream<T>(sql,params?,transaction?):AsyncIterable<T>
Defined in: src/adapters/IDbAdapter.ts:70
Optional: streams large result sets as an AsyncIterable without loading all rows into memory.
Adapters that don't implement this method will fall back to DbSet.stream()'s
built-in batched-pagination polyfill, which works on every adapter.
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters
| Parameter | Type |
|---|---|
sql | string |
params? | AdapterParam[] |
transaction? | DbTransaction |
Returns
AsyncIterable<T>
Properties
provider
readonlyprovider:DbProvider
Defined in: src/adapters/IDbAdapter.ts:20
connectionPool?
readonlyoptionalconnectionPool?:IConnectionPool
Defined in: src/adapters/IDbAdapter.ts:21