Skip to content

Latest commit

 

History

History
71 lines (57 loc) · 3.08 KB

Pool.md

File metadata and controls

71 lines (57 loc) · 3.08 KB

Pool

Managers

Utilities

A utility class for managing multiple database Connections.

const myDBs = new QDB.Pool("/usr/Production/Cellar/");
Key Type Description
pathURL Pathlike Path to the database file or directory for this Pool to operate.
poolOptions? PoolOptions Options for this Pool to manage, including separate Connection options.

Values

Path string to the Pool directory. [Read Only]

Type {Pathlike}

A collection of databases this Pool holds. [Read Only]

Type {Collection}

Options for this Pool. [Read Only]

Type {PoolOptions}

Methods

Retrieves a database Connection from this Pool instance.

Key Type Description
representativeString String A reference to resolve.

Returns {Connection}

Disconnects from all the Connections in this Pool.

Returns {Pool}

Typedefs

Options for a database Pool. All integer related options are in milliseconds.

Key Type Description
exclusives Object<Identifier, RawOptions> Non-default options to use for certain Connections to a database.
binding Boolean Whether or not to automatically bind Schemas with the table names in the Pool.
WAL Boolean Default setting to enable Write Ahead Logging mode for Connections in this Pool.
cache Boolean Whether to enable in-memory caching of entries in results that the next retrieval would be much faster.
utilCache Boolean Whether or not to cache entries while performing utility tasks, such as the Exists method.
cacheMaxSize Number Amount to be considered the maximum size. If this threshold is hit, the cache will temporarily stop adding new entries.
sweepInterval Number Integer to indicate at what interval to sweep the entries of the Connection's internal cache.
sweepLifetime Number The minimum age of an entry in the cache to consider being sweepable after an interval.

Type {Object}