@breautek/storm 5.0.1 → 6.0.1

package/docs/classes/Point.md

@@ -1,102 +0,0 @@
-[@breautek/storm](../README.md) / Point
-
-# Class: Point
-
-## Hierarchy
-
-- [`DatabaseCastObject`](DatabaseCastObject.md)
-
-  ↳ **`Point`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](Point.md#constructor)
-
-### Methods
-
-- [\_toSQLString](Point.md#_tosqlstring)
-- [escape](Point.md#escape)
-- [toSqlString](Point.md#tosqlstring)
-
-## Constructors
-
-### constructor
-
-• **new Point**(`x?`, `y?`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `x?` | `number` |
-| `y?` | `number` |
-
-#### Overrides
-
-[DatabaseCastObject](DatabaseCastObject.md).[constructor](DatabaseCastObject.md#constructor)
-
-#### Defined in
-
-[src/Point.ts:23](https://github.com/breautek/storm/blob/3dcafe4/src/Point.ts#L23)
-
-## Methods
-
-### \_toSQLString
-
-▸ `Protected` **_toSQLString**(): `string`
-
-#### Returns
-
-`string`
-
-#### Overrides
-
-[DatabaseCastObject](DatabaseCastObject.md).[_toSQLString](DatabaseCastObject.md#_tosqlstring)
-
-#### Defined in
-
-[src/Point.ts:30](https://github.com/breautek/storm/blob/3dcafe4/src/Point.ts#L30)
-
-___
-
-### escape
-
-▸ **escape**(`value`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `value` | `any` |
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[DatabaseCastObject](DatabaseCastObject.md).[escape](DatabaseCastObject.md#escape)
-
-#### Defined in
-
-[src/DatabaseCastObject.ts:24](https://github.com/breautek/storm/blob/3dcafe4/src/DatabaseCastObject.ts#L24)
-
-___
-
-### toSqlString
-
-▸ **toSqlString**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[DatabaseCastObject](DatabaseCastObject.md).[toSqlString](DatabaseCastObject.md#tosqlstring)
-
-#### Defined in
-
-[src/DatabaseCastObject.ts:20](https://github.com/breautek/storm/blob/3dcafe4/src/DatabaseCastObject.ts#L20)

package/docs/classes/Polygon.md

@@ -1,101 +0,0 @@
-[@breautek/storm](../README.md) / Polygon
-
-# Class: Polygon
-
-## Hierarchy
-
-- [`DatabaseCastObject`](DatabaseCastObject.md)
-
-  ↳ **`Polygon`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](Polygon.md#constructor)
-
-### Methods
-
-- [\_toSQLString](Polygon.md#_tosqlstring)
-- [escape](Polygon.md#escape)
-- [toSqlString](Polygon.md#tosqlstring)
-
-## Constructors
-
-### constructor
-
-• **new Polygon**(`coordinates?`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `coordinates?` | [`TCoordinate`](../README.md#tcoordinate)[][] |
-
-#### Overrides
-
-[DatabaseCastObject](DatabaseCastObject.md).[constructor](DatabaseCastObject.md#constructor)
-
-#### Defined in
-
-[src/Polygon.ts:23](https://github.com/breautek/storm/blob/3dcafe4/src/Polygon.ts#L23)
-
-## Methods
-
-### \_toSQLString
-
-▸ `Protected` **_toSQLString**(): `string`
-
-#### Returns
-
-`string`
-
-#### Overrides
-
-[DatabaseCastObject](DatabaseCastObject.md).[_toSQLString](DatabaseCastObject.md#_tosqlstring)
-
-#### Defined in
-
-[src/Polygon.ts:29](https://github.com/breautek/storm/blob/3dcafe4/src/Polygon.ts#L29)
-
-___
-
-### escape
-
-▸ **escape**(`value`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `value` | `any` |
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[DatabaseCastObject](DatabaseCastObject.md).[escape](DatabaseCastObject.md#escape)
-
-#### Defined in
-
-[src/DatabaseCastObject.ts:24](https://github.com/breautek/storm/blob/3dcafe4/src/DatabaseCastObject.ts#L24)
-
-___
-
-### toSqlString
-
-▸ **toSqlString**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[DatabaseCastObject](DatabaseCastObject.md).[toSqlString](DatabaseCastObject.md#tosqlstring)
-
-#### Defined in
-
-[src/DatabaseCastObject.ts:20](https://github.com/breautek/storm/blob/3dcafe4/src/DatabaseCastObject.ts#L20)

package/docs/classes/Query.md

@@ -1,227 +0,0 @@
-[@breautek/storm](../README.md) / Query
-
-# Class: Query<TQueryParameters, TQueryResultSet, TQueryPostProcessedResultSet\>
-
-## Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TQueryParameters` | `any` |
-| `TQueryResultSet` | `any` |
-| `TQueryPostProcessedResultSet` | `TQueryResultSet` |
-
-## Hierarchy
-
-- **`Query`**
-
-  ↳ [`TemporaryTableQuery`](TemporaryTableQuery.md)
-
-  ↳ [`DropTemporaryTableQuery`](DropTemporaryTableQuery.md)
-
-  ↳ [`RawQuery`](RawQuery.md)
-
-  ↳ [`SetSessionVariableQuery`](SetSessionVariableQuery.md)
-
-## Implements
-
-- [`IQueryable`](../interfaces/IQueryable.md)<`TQueryPostProcessedResultSet`\>
-
-## Table of contents
-
-### Constructors
-
-- [constructor](Query.md#constructor)
-
-### Methods
-
-- [\_getQuery](Query.md#_getquery)
-- [execute](Query.md#execute)
-- [getParameters](Query.md#getparameters)
-- [getParametersForQuery](Query.md#getparametersforquery)
-- [getQuery](Query.md#getquery)
-- [onPostProcess](Query.md#onpostprocess)
-- [onPreQuery](Query.md#onprequery)
-
-## Constructors
-
-### constructor
-
-• **new Query**<`TQueryParameters`, `TQueryResultSet`, `TQueryPostProcessedResultSet`\>(`parameters?`)
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TQueryParameters` | `any` |
-| `TQueryResultSet` | `any` |
-| `TQueryPostProcessedResultSet` | `TQueryResultSet` |
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `parameters?` | `TQueryParameters` |
-
-#### Defined in
-
-[src/Query.ts:23](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L23)
-
-## Methods
-
-### \_getQuery
-
-▸ `Protected` `Abstract` **_getQuery**(`connection`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[src/Query.ts:43](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L43)
-
-___
-
-### execute
-
-▸ **execute**(`connection`): `Promise`<`TQueryPostProcessedResultSet`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
-
-#### Returns
-
-`Promise`<`TQueryPostProcessedResultSet`\>
-
-#### Implementation of
-
-[IQueryable](../interfaces/IQueryable.md).[execute](../interfaces/IQueryable.md#execute)
-
-#### Defined in
-
-[src/Query.ts:71](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L71)
-
-___
-
-### getParameters
-
-▸ **getParameters**(): `TQueryParameters`
-
-#### Returns
-
-`TQueryParameters`
-
-parameters that was passed into the constructor.
-
-#### Defined in
-
-[src/Query.ts:30](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L30)
-
-___
-
-### getParametersForQuery
-
-▸ **getParametersForQuery**(): `Record`<`string`, `any`\>
-
-Query implementations may override this API to augment the parameters.
-
-#### Returns
-
-`Record`<`string`, `any`\>
-
-parameters that will be used when this query is ran.
-
-#### Implementation of
-
-[IQueryable](../interfaces/IQueryable.md).[getParametersForQuery](../interfaces/IQueryable.md#getparametersforquery)
-
-#### Defined in
-
-[src/Query.ts:39](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L39)
-
-___
-
-### getQuery
-
-▸ **getQuery**(`connection`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
-
-#### Returns
-
-`string`
-
-#### Implementation of
-
-[IQueryable](../interfaces/IQueryable.md).[getQuery](../interfaces/IQueryable.md#getquery)
-
-#### Defined in
-
-[src/Query.ts:45](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L45)
-
-___
-
-### onPostProcess
-
-▸ **onPostProcess**(`connection`, `resultSet`): `Promise`<`TQueryPostProcessedResultSet`\>
-
-Override to augment/manipulate the returned result set.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) | The connection object used for this query execution. Useful if further queries are required. |
-| `resultSet` | `TQueryResultSet` | - |
-
-#### Returns
-
-`Promise`<`TQueryPostProcessedResultSet`\>
-
-#### Implementation of
-
-[IQueryable](../interfaces/IQueryable.md).[onPostProcess](../interfaces/IQueryable.md#onpostprocess)
-
-#### Defined in
-
-[src/Query.ts:66](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L66)
-
-___
-
-### 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.md) |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Implementation of
-
-[IQueryable](../interfaces/IQueryable.md).[onPreQuery](../interfaces/IQueryable.md#onprequery)
-
-#### Defined in
-
-[src/Query.ts:56](https://github.com/breautek/storm/blob/3dcafe4/src/Query.ts#L56)