Class: AbstractSqlConnection#
knex.AbstractSqlConnection
Hierarchy#
↳ AbstractSqlConnection
Constructors#
constructor#
+ new AbstractSqlConnection(config: Configuration<IDatabaseDriver<Connection>>, options?: ConnectionOptions, type?: read | write): AbstractSqlConnection
Parameters:#
| Name | Type |
|---|---|
config | Configuration<IDatabaseDriver<Connection>> |
options? | ConnectionOptions |
type? | read | write |
Returns: AbstractSqlConnection
Inherited from: Connection
Defined in: packages/knex/src/AbstractSqlConnection.ts:18
Properties#
client#
• Protected client: Knex<any, unknown[]>
Overrides: Connection.client
Defined in: packages/knex/src/AbstractSqlConnection.ts:18
config#
• Protected Readonly config: Configuration<IDatabaseDriver<Connection>>
Inherited from: Connection.config
metadata#
• Protected metadata: MetadataStorage
Inherited from: Connection.metadata
Defined in: packages/core/src/connections/Connection.ts:12
options#
• Protected Optional Readonly options: undefined | ConnectionOptions
Inherited from: Connection.options
platform#
• Protected platform: AbstractSqlPlatform
Overrides: Connection.platform
Defined in: packages/knex/src/AbstractSqlConnection.ts:17
type#
• Protected Readonly type: read | write= 'write'
Inherited from: Connection.type
Methods#
begin#
â–¸ begin(ctx?: Transaction<any, any>, eventBroadcaster?: TransactionEventBroadcaster): Promise<Transaction<any, any>>
Parameters:#
| Name | Type |
|---|---|
ctx? | Transaction<any, any> |
eventBroadcaster? | TransactionEventBroadcaster |
Returns: Promise<Transaction<any, any>>
Overrides: Connection
Defined in: packages/knex/src/AbstractSqlConnection.ts:56
close#
â–¸ close(force?: boolean): Promise<void>
Parameters:#
| Name | Type |
|---|---|
force? | boolean |
Returns: Promise<void>
Overrides: Connection
Defined in: packages/knex/src/AbstractSqlConnection.ts:29
commit#
â–¸ commit(ctx: Transaction<any, any>, eventBroadcaster?: TransactionEventBroadcaster): Promise<void>
Parameters:#
| Name | Type |
|---|---|
ctx | Transaction<any, any> |
eventBroadcaster? | TransactionEventBroadcaster |
Returns: Promise<void>
Overrides: Connection
Defined in: packages/knex/src/AbstractSqlConnection.ts:72
connect#
â–¸ Abstractconnect(): Promise<void>
Establishes connection to database
Returns: Promise<void>
Inherited from: Connection
Defined in: packages/core/src/connections/Connection.ts:28
createKnexClient#
â–¸ ProtectedcreateKnexClient(type: string): Knex<any, unknown[]>
Parameters:#
| Name | Type |
|---|---|
type | string |
Returns: Knex<any, unknown[]>
Defined in: packages/knex/src/AbstractSqlConnection.ts:136
execute#
â–¸ execute<T>(queryOrKnex: string | QueryBuilder<any, any> | Raw<any>, params?: any[], method?: all | get | run, ctx?: any): Promise<T>
Type parameters:#
| Name | Type | Default |
|---|---|---|
T | QueryResult | EntityData<AnyEntity<any>> | EntityData<AnyEntity<any>>[] | EntityData<AnyEntity<any\>\>[] |
Parameters:#
| Name | Type | Default value |
|---|---|---|
queryOrKnex | string | QueryBuilder<any, any> | Raw<any> | - |
params | any[] | ... |
method | all | get | run | 'all' |
ctx? | any | - |
Returns: Promise<T>
Overrides: Connection
Defined in: packages/knex/src/AbstractSqlConnection.ts:101
executeQuery#
â–¸ ProtectedexecuteQuery<T>(query: string, cb: () => Promise<T>): Promise<T>
Type parameters:#
| Name |
|---|
T |
Parameters:#
| Name | Type |
|---|---|
query | string |
cb | () => Promise<T> |
Returns: Promise<T>
Inherited from: Connection
Defined in: packages/core/src/connections/Connection.ts:90
getClientUrl#
â–¸ getClientUrl(): string
Returns: string
Inherited from: Connection
Defined in: packages/core/src/connections/Connection.ts:75
getConnectionOptions#
â–¸ getConnectionOptions(): ConnectionConfig
Returns: ConnectionConfig
Inherited from: Connection
Defined in: packages/core/src/connections/Connection.ts:63
getDefaultClientUrl#
â–¸ AbstractgetDefaultClientUrl(): string
Returns default client url for given driver (e.g. mongodb://127.0.0.1:27017 for mongodb)
Returns: string
Inherited from: Connection
Defined in: packages/core/src/connections/Connection.ts:43
getKnex#
â–¸ getKnex(): Knex<any, unknown[]>
Returns: Knex<any, unknown[]>
Defined in: packages/knex/src/AbstractSqlConnection.ts:25
getKnexOptions#
â–¸ ProtectedgetKnexOptions(type: string): Config<any>
Parameters:#
| Name | Type |
|---|---|
type | string |
Returns: Config<any>
Defined in: packages/knex/src/AbstractSqlConnection.ts:145
getSql#
â–¸ PrivategetSql(query: string, formatted: string): string
Parameters:#
| Name | Type |
|---|---|
query | string |
formatted | string |
Returns: string
Defined in: packages/knex/src/AbstractSqlConnection.ts:153
isConnected#
â–¸ isConnected(): Promise<boolean>
Returns: Promise<boolean>
Overrides: Connection
Defined in: packages/knex/src/AbstractSqlConnection.ts:33
loadFile#
â–¸ loadFile(path: string): Promise<void>
Execute raw SQL queries from file
Parameters:#
| Name | Type |
|---|---|
path | string |
Returns: Promise<void>
Defined in: packages/knex/src/AbstractSqlConnection.ts:127
logQuery#
â–¸ ProtectedlogQuery(query: string, took?: number): void
Parameters:#
| Name | Type |
|---|---|
query | string |
took? | number |
Returns: void
Overrides: Connection
Defined in: packages/knex/src/AbstractSqlConnection.ts:132
patchKnexClient#
â–¸ PrivatepatchKnexClient(): void
do not call positionBindings when there are no bindings - it was messing up with
already interpolated strings containing ?, and escaping that was not enough to
support edge cases like \\? strings (as positionBindings was removing the \\)
Returns: void
Defined in: packages/knex/src/AbstractSqlConnection.ts:172
rollback#
â–¸ rollback(ctx: Transaction<any, any>, eventBroadcaster?: TransactionEventBroadcaster): Promise<void>
Parameters:#
| Name | Type |
|---|---|
ctx | Transaction<any, any> |
eventBroadcaster? | TransactionEventBroadcaster |
Returns: Promise<void>
Overrides: Connection
Defined in: packages/knex/src/AbstractSqlConnection.ts:87
setMetadata#
â–¸ setMetadata(metadata: MetadataStorage): void
Parameters:#
| Name | Type |
|---|---|
metadata | MetadataStorage |
Returns: void
Inherited from: Connection
Defined in: packages/core/src/connections/Connection.ts:82
setPlatform#
â–¸ setPlatform(platform: Platform): void
Parameters:#
| Name | Type |
|---|---|
platform | Platform |
Returns: void
Inherited from: Connection
Defined in: packages/core/src/connections/Connection.ts:86
transactional#
â–¸ transactional<T>(cb: (trx: Transaction<any, any>) => Promise<T>, ctx?: Transaction<any, any>, eventBroadcaster?: TransactionEventBroadcaster): Promise<T>
Type parameters:#
| Name |
|---|
T |
Parameters:#
| Name | Type |
|---|---|
cb | (trx: Transaction<any, any>) => Promise<T> |
ctx? | Transaction<any, any> |
eventBroadcaster? | TransactionEventBroadcaster |
Returns: Promise<T>
Overrides: Connection
Defined in: packages/knex/src/AbstractSqlConnection.ts:42
transformRawResult#
â–¸ Protected AbstracttransformRawResult<T>(res: any, method: all | get | run): T
Type parameters:#
| Name |
|---|
T |
Parameters:#
| Name | Type |
|---|---|
res | any |
method | all | get | run |
Returns: T
Defined in: packages/knex/src/AbstractSqlConnection.ts:197