Members
adapter :Object
Adapter object
Type:
- Object
- Source
client :Object
Client instance
Type:
- Object
- Source
(async) dispose
Dispose this connection
name :string
Connection name
Type:
- string
- Source
options :DoboConnection.TOptions
Connection options
- Source
Methods
(async) connect(noRebuildopt)
Establish this connection through the adapter to the actual database system. Adapter developer must provide a method named connect() to connect the underlying database and (optionally) return its client instance.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
noRebuild | boolean | <optional> | If |
- Source
(async) initAdapter(name) → {Promise.<void>}
Initialize the adapter for this connection. If the adapter is already an instance of DoboAdapter, it will be used directly. Otherwise, it will be retrieved from the plugin's adapter registry and sanitized with the connection options.
Parameters:
| Name | Type | Description |
|---|---|---|
name | string | Adapter name |
- Source
Returns:
- Type:
- Promise.<void>
Type Definitions
TOptions
Properties| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
name | string | <optional> | 'default' | Connection name |
models | Array.<string> | List of model names to be used with this connection. Use this property to force models to be bound to this connection only. |
- Source