@breautek/storm 3.3.1 → 4.1.0

package/docs/classes/MySQLDatabase.MySQLDatabase-1.md

@@ -1,316 +0,0 @@
-[@breautek/storm](../README.md) / [MySQLDatabase](../modules/MySQLDatabase.md) / MySQLDatabase
-
-# Class: MySQLDatabase
-
-[MySQLDatabase](../modules/MySQLDatabase.md).MySQLDatabase
-
-## Hierarchy
-
-- [`Database`](Database.Database-1.md)<`MySQL.PoolConfig`, `MySQL.PoolConnection`\>
-
-  ↳ **`MySQLDatabase`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](MySQLDatabase.MySQLDatabase-1.md#constructor)
-
-### Methods
-
-- [\_addNode](MySQLDatabase.MySQLDatabase-1.md#_addnode)
-- [\_destroy](MySQLDatabase.MySQLDatabase-1.md#_destroy)
-- [\_getConnection](MySQLDatabase.MySQLDatabase-1.md#_getconnection)
-- [\_removeNode](MySQLDatabase.MySQLDatabase-1.md#_removenode)
-- [addMaster](MySQLDatabase.MySQLDatabase-1.md#addmaster)
-- [addSlave](MySQLDatabase.MySQLDatabase-1.md#addslave)
-- [destroy](MySQLDatabase.MySQLDatabase-1.md#destroy)
-- [escape](MySQLDatabase.MySQLDatabase-1.md#escape)
-- [getConnection](MySQLDatabase.MySQLDatabase-1.md#getconnection)
-- [removeMaster](MySQLDatabase.MySQLDatabase-1.md#removemaster)
-- [removeSlave](MySQLDatabase.MySQLDatabase-1.md#removeslave)
-- [escape](MySQLDatabase.MySQLDatabase-1.md#escape)
-
-## Constructors
-
-### constructor
-
-• **new MySQLDatabase**()
-
-#### Overrides
-
-[Database](Database.Database-1.md).[constructor](Database.Database-1.md#constructor)
-
-#### Defined in
-
-[src/MySQLDatabase.ts:27](https://github.com/breautek/storm/blob/8c3a317/src/MySQLDatabase.ts#L27)
-
-## Methods
-
-### \_addNode
-
-▸ `Protected` **_addNode**(`nodeID`, `config`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `nodeID` | `string` |
-| `config` | `PoolConfig` |
-
-#### Returns
-
-`void`
-
-#### Overrides
-
-[Database](Database.Database-1.md).[_addNode](Database.Database-1.md#_addnode)
-
-#### Defined in
-
-[src/MySQLDatabase.ts:49](https://github.com/breautek/storm/blob/8c3a317/src/MySQLDatabase.ts#L49)
-
-___
-
-### \_destroy
-
-▸ `Protected` **_destroy**(): `Promise`<`void`\>
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Overrides
-
-[Database](Database.Database-1.md).[_destroy](Database.Database-1.md#_destroy)
-
-#### Defined in
-
-[src/MySQLDatabase.ts:59](https://github.com/breautek/storm/blob/8c3a317/src/MySQLDatabase.ts#L59)
-
-___
-
-### \_getConnection
-
-▸ `Protected` **_getConnection**(`query`, `requireWriteAccess`): `Promise`<[`MySQLConnection`](MySQLConnection.MySQLConnection-1.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `query` | `string` |
-| `requireWriteAccess` | `boolean` |
-
-#### Returns
-
-`Promise`<[`MySQLConnection`](MySQLConnection.MySQLConnection-1.md)\>
-
-#### Overrides
-
-[Database](Database.Database-1.md).[_getConnection](Database.Database-1.md#_getconnection)
-
-#### Defined in
-
-[src/MySQLDatabase.ts:72](https://github.com/breautek/storm/blob/8c3a317/src/MySQLDatabase.ts#L72)
-
-___
-
-### \_removeNode
-
-▸ `Protected` **_removeNode**(`nodeID`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `nodeID` | `string` |
-
-#### Returns
-
-`void`
-
-#### Overrides
-
-[Database](Database.Database-1.md).[_removeNode](Database.Database-1.md#_removenode)
-
-#### Defined in
-
-[src/MySQLDatabase.ts:54](https://github.com/breautek/storm/blob/8c3a317/src/MySQLDatabase.ts#L54)
-
-___
-
-### addMaster
-
-▸ **addMaster**(`config`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `config` | `PoolConfig` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[Database](Database.Database-1.md).[addMaster](Database.Database-1.md#addmaster)
-
-#### Defined in
-
-[src/Database.ts:32](https://github.com/breautek/storm/blob/8c3a317/src/Database.ts#L32)
-
-___
-
-### addSlave
-
-▸ **addSlave**(`slaveID`, `config`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `slaveID` | `string` |
-| `config` | `PoolConfig` |
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[Database](Database.Database-1.md).[addSlave](Database.Database-1.md#addslave)
-
-#### Defined in
-
-[src/Database.ts:46](https://github.com/breautek/storm/blob/8c3a317/src/Database.ts#L46)
-
-___
-
-### destroy
-
-▸ **destroy**(): `Promise`<`void`\>
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Inherited from
-
-[Database](Database.Database-1.md).[destroy](Database.Database-1.md#destroy)
-
-#### Defined in
-
-[src/Database.ts:78](https://github.com/breautek/storm/blob/8c3a317/src/Database.ts#L78)
-
-___
-
-### escape
-
-▸ **escape**(`value`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `value` | `any` |
-
-#### Returns
-
-`string`
-
-#### Overrides
-
-[Database](Database.Database-1.md).[escape](Database.Database-1.md#escape)
-
-#### Defined in
-
-[src/MySQLDatabase.ts:40](https://github.com/breautek/storm/blob/8c3a317/src/MySQLDatabase.ts#L40)
-
-___
-
-### getConnection
-
-▸ **getConnection**(`requireWriteAccess?`, `nodeID?`): `Promise`<[`DatabaseConnection`](DatabaseConnection.DatabaseConnection-1.md)<`PoolConnection`\>\>
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `requireWriteAccess` | `boolean` | `false` |
-| `nodeID?` | `string` | `undefined` |
-
-#### Returns
-
-`Promise`<[`DatabaseConnection`](DatabaseConnection.DatabaseConnection-1.md)<`PoolConnection`\>\>
-
-#### Inherited from
-
-[Database](Database.Database-1.md).[getConnection](Database.Database-1.md#getconnection)
-
-#### Defined in
-
-[src/Database.ts:65](https://github.com/breautek/storm/blob/8c3a317/src/Database.ts#L65)
-
-___
-
-### removeMaster
-
-▸ **removeMaster**(): `void`
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[Database](Database.Database-1.md).[removeMaster](Database.Database-1.md#removemaster)
-
-#### Defined in
-
-[src/Database.ts:41](https://github.com/breautek/storm/blob/8c3a317/src/Database.ts#L41)
-
-___
-
-### removeSlave
-
-▸ **removeSlave**(`slaveID`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `slaveID` | `string` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[Database](Database.Database-1.md).[removeSlave](Database.Database-1.md#removeslave)
-
-#### Defined in
-
-[src/Database.ts:55](https://github.com/breautek/storm/blob/8c3a317/src/Database.ts#L55)
-
-___
-
-### escape
-
-▸ `Static` **escape**(`value`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `value` | `any` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/MySQLDatabase.ts:45](https://github.com/breautek/storm/blob/8c3a317/src/MySQLDatabase.ts#L45)

package/docs/classes/RawQuery.RawQuery-1.md

@@ -1,212 +0,0 @@
-[@breautek/storm](../README.md) / [RawQuery](../modules/RawQuery.md) / RawQuery
-
-# Class: RawQuery<TQueryParameters, TQueryResultSet\>
-
-[RawQuery](../modules/RawQuery.md).RawQuery
-
-## Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TQueryParameters` | `any` |
-| `TQueryResultSet` | `any` |
-
-## Hierarchy
-
-- [`Query`](Query.Query-1.md)<`TQueryParameters`, `TQueryResultSet`, `TQueryResultSet`\>
-
-  ↳ **`RawQuery`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](RawQuery.RawQuery-1.md#constructor)
-
-### Methods
-
-- [\_getQuery](RawQuery.RawQuery-1.md#_getquery)
-- [execute](RawQuery.RawQuery-1.md#execute)
-- [getParameters](RawQuery.RawQuery-1.md#getparameters)
-- [getParametersForQuery](RawQuery.RawQuery-1.md#getparametersforquery)
-- [getQuery](RawQuery.RawQuery-1.md#getquery)
-- [onPostProcess](RawQuery.RawQuery-1.md#onpostprocess)
-- [onPreQuery](RawQuery.RawQuery-1.md#onprequery)
-
-## Constructors
-
-### constructor
-
-• **new RawQuery**<`TQueryParameters`, `TQueryResultSet`\>(`query`, `parameters?`)
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TQueryParameters` | `any` |
-| `TQueryResultSet` | `any` |
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `query` | `string` |
-| `parameters?` | `TQueryParameters` |
-
-#### Overrides
-
-[Query](Query.Query-1.md).[constructor](Query.Query-1.md#constructor)
-
-#### Defined in
-
-[src/RawQuery.ts:22](https://github.com/breautek/storm/blob/8c3a317/src/RawQuery.ts#L22)
-
-## Methods
-
-### \_getQuery
-
-▸ `Protected` **_getQuery**(): `string`
-
-#### Returns
-
-`string`
-
-#### Overrides
-
-[Query](Query.Query-1.md).[_getQuery](Query.Query-1.md#_getquery)
-
-#### Defined in
-
-[src/RawQuery.ts:27](https://github.com/breautek/storm/blob/8c3a317/src/RawQuery.ts#L27)
-
-___
-
-### execute
-
-▸ **execute**(`connection`): `Promise`<`TQueryResultSet`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.IDatabaseConnection-1.md) |
-
-#### Returns
-
-`Promise`<`TQueryResultSet`\>
-
-#### Inherited from
-
-[Query](Query.Query-1.md).[execute](Query.Query-1.md#execute)
-
-#### Defined in
-
-[src/Query.ts:63](https://github.com/breautek/storm/blob/8c3a317/src/Query.ts#L63)
-
-___
-
-### getParameters
-
-▸ **getParameters**(): `TQueryParameters`
-
-#### Returns
-
-`TQueryParameters`
-
-#### Inherited from
-
-[Query](Query.Query-1.md).[getParameters](Query.Query-1.md#getparameters)
-
-#### Defined in
-
-[src/Query.ts:27](https://github.com/breautek/storm/blob/8c3a317/src/Query.ts#L27)
-
-___
-
-### getParametersForQuery
-
-▸ **getParametersForQuery**(): `IDictionary`<`any`\>
-
-#### Returns
-
-`IDictionary`<`any`\>
-
-#### Inherited from
-
-[Query](Query.Query-1.md).[getParametersForQuery](Query.Query-1.md#getparametersforquery)
-
-#### Defined in
-
-[src/Query.ts:31](https://github.com/breautek/storm/blob/8c3a317/src/Query.ts#L31)
-
-___
-
-### getQuery
-
-▸ **getQuery**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[Query](Query.Query-1.md).[getQuery](Query.Query-1.md#getquery)
-
-#### Defined in
-
-[src/Query.ts:37](https://github.com/breautek/storm/blob/8c3a317/src/Query.ts#L37)
-
-___
-
-### onPostProcess
-
-▸ **onPostProcess**(`connection`, `resultSet`): `Promise`<`TQueryResultSet`\>
-
-Override to augment/manipulate the returned result set.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.IDatabaseConnection-1.md) | The connection object used for this query execution. Useful if further queries are required. |
-| `resultSet` | `TQueryResultSet` | - |
-
-#### Returns
-
-`Promise`<`TQueryResultSet`\>
-
-#### Inherited from
-
-[Query](Query.Query-1.md).[onPostProcess](Query.Query-1.md#onpostprocess)
-
-#### Defined in
-
-[src/Query.ts:58](https://github.com/breautek/storm/blob/8c3a317/src/Query.ts#L58)
-
-___
-
-### onPreQuery
-
-▸ **onPreQuery**(`connection`): `Promise`<`void`\>
-
-Overridable to execute statements before the main query.
-Can be used to set session variables or create temporary tables, etc.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.IDatabaseConnection-1.md) |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Inherited from
-
-[Query](Query.Query-1.md).[onPreQuery](Query.Query-1.md#onprequery)
-
-#### Defined in
-
-[src/Query.ts:48](https://github.com/breautek/storm/blob/8c3a317/src/Query.ts#L48)