Class: Connection#
core.Connection
Hierarchy#
Connection
Constructors#
constructor#
+ new Connection(config: Configuration<IDatabaseDriver<Connection>>, options?: ConnectionOptions, type?: read | write): Connection
Parameters:#
| Name | Type | Default value |
|---|---|---|
config | Configuration<IDatabaseDriver<Connection>> | - |
options? | ConnectionOptions | - |
type | read | write | 'write' |
Returns: Connection
Defined in: packages/core/src/connections/Connection.ts:14
Properties#
client#
• Protected Abstract client: any
Defined in: packages/core/src/connections/Connection.ts:14
config#
• Protected Readonly config: Configuration<IDatabaseDriver<Connection>>
metadata#
• Protected metadata: MetadataStorage
Defined in: packages/core/src/connections/Connection.ts:12
options#
• Protected Optional Readonly options: ConnectionOptions
platform#
• Protected platform: Platform
Defined in: packages/core/src/connections/Connection.ts:13
type#
• Protected Readonly type: read | write= 'write'
Methods#
begin#
â–¸ begin(ctx?: any, eventBroadcaster?: TransactionEventBroadcaster): Promise<unknown>
Parameters:#
| Name | Type |
|---|---|
ctx? | any |
eventBroadcaster? | TransactionEventBroadcaster |
Returns: Promise<unknown>
Defined in: packages/core/src/connections/Connection.ts:49
close#
â–¸ Abstractclose(force?: boolean): Promise<void>
Closes the database connection (aka disconnect)
Parameters:#
| Name | Type |
|---|---|
force? | boolean |
Returns: Promise<void>
Defined in: packages/core/src/connections/Connection.ts:38
commit#
â–¸ commit(ctx: any, eventBroadcaster?: TransactionEventBroadcaster): Promise<void>
Parameters:#
| Name | Type |
|---|---|
ctx | any |
eventBroadcaster? | TransactionEventBroadcaster |
Returns: Promise<void>
Defined in: packages/core/src/connections/Connection.ts:53
connect#
â–¸ Abstractconnect(): Promise<void>
Establishes connection to database
Returns: Promise<void>
Defined in: packages/core/src/connections/Connection.ts:28
execute#
â–¸ Abstractexecute(query: string, params?: any[], method?: all | get | run, ctx?: any): Promise<any>
Parameters:#
| Name | Type |
|---|---|
query | string |
params? | any[] |
method? | all | get | run |
ctx? | any |
Returns: Promise<any>
Defined in: packages/core/src/connections/Connection.ts:61
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>
Defined in: packages/core/src/connections/Connection.ts:90
getClientUrl#
â–¸ getClientUrl(): string
Returns: string
Defined in: packages/core/src/connections/Connection.ts:75
getConnectionOptions#
â–¸ getConnectionOptions(): ConnectionConfig
Returns: ConnectionConfig
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
Defined in: packages/core/src/connections/Connection.ts:43
isConnected#
â–¸ AbstractisConnected(): Promise<boolean>
Are we connected to the database
Returns: Promise<boolean>
Defined in: packages/core/src/connections/Connection.ts:33
logQuery#
â–¸ ProtectedlogQuery(query: string, took?: number): void
Parameters:#
| Name | Type |
|---|---|
query | string |
took? | number |
Returns: void
Defined in: packages/core/src/connections/Connection.ts:104
rollback#
â–¸ rollback(ctx: any, eventBroadcaster?: TransactionEventBroadcaster): Promise<void>
Parameters:#
| Name | Type |
|---|---|
ctx | any |
eventBroadcaster? | TransactionEventBroadcaster |
Returns: Promise<void>
Defined in: packages/core/src/connections/Connection.ts:57
setMetadata#
â–¸ setMetadata(metadata: MetadataStorage): void
Parameters:#
| Name | Type |
|---|---|
metadata | MetadataStorage |
Returns: void
Defined in: packages/core/src/connections/Connection.ts:82
setPlatform#
â–¸ setPlatform(platform: Platform): void
Parameters:#
| Name | Type |
|---|---|
platform | Platform |
Returns: void
Defined in: packages/core/src/connections/Connection.ts:86
transactional#
â–¸ transactional<T>(cb: (trx: any) => Promise<T>, ctx?: any, eventBroadcaster?: TransactionEventBroadcaster): Promise<T>
Type parameters:#
| Name |
|---|
T |
Parameters:#
| Name | Type |
|---|---|
cb | (trx: any) => Promise<T> |
ctx? | any |
eventBroadcaster? | TransactionEventBroadcaster |
Returns: Promise<T>
Defined in: packages/core/src/connections/Connection.ts:45