@breautek/storm 3.3.1 → 4.1.0

package/docs/classes/SetSessionVariableQuery.md

@@ -0,0 +1,201 @@
+[@breautek/storm](../README.md) / SetSessionVariableQuery
+
+# Class: SetSessionVariableQuery
+
+## Hierarchy
+
+- [`Query`](Query.md)<[`ISetSessionVariableQueryInput`](../interfaces/ISetSessionVariableQueryInput.md), `void`\>
+
+  ↳ **`SetSessionVariableQuery`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](SetSessionVariableQuery.md#constructor)
+
+### Methods
+
+- [\_getQuery](SetSessionVariableQuery.md#_getquery)
+- [execute](SetSessionVariableQuery.md#execute)
+- [getParameters](SetSessionVariableQuery.md#getparameters)
+- [getParametersForQuery](SetSessionVariableQuery.md#getparametersforquery)
+- [getQuery](SetSessionVariableQuery.md#getquery)
+- [onPostProcess](SetSessionVariableQuery.md#onpostprocess)
+- [onPreQuery](SetSessionVariableQuery.md#onprequery)
+
+## Constructors
+
+### constructor
+
+• **new SetSessionVariableQuery**(`parameters?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `parameters?` | [`ISetSessionVariableQueryInput`](../interfaces/ISetSessionVariableQueryInput.md) |
+
+#### Inherited from
+
+[Query](Query.md).[constructor](Query.md#constructor)
+
+#### Defined in
+
+[src/Query.ts:22](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L22)
+
+## Methods
+
+### \_getQuery
+
+▸ `Protected` **_getQuery**(): `string`
+
+#### Returns
+
+`string`
+
+#### Overrides
+
+[Query](Query.md).[_getQuery](Query.md#_getquery)
+
+#### Defined in
+
+[src/SetSessionVariableQuery.ts:12](https://github.com/breautek/storm/blob/3ad3438/src/SetSessionVariableQuery.ts#L12)
+
+___
+
+### execute
+
+▸ **execute**(`connection`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Inherited from
+
+[Query](Query.md).[execute](Query.md#execute)
+
+#### Defined in
+
+[src/Query.ts:62](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L62)
+
+___
+
+### getParameters
+
+▸ **getParameters**(): [`ISetSessionVariableQueryInput`](../interfaces/ISetSessionVariableQueryInput.md)
+
+#### Returns
+
+[`ISetSessionVariableQueryInput`](../interfaces/ISetSessionVariableQueryInput.md)
+
+#### Inherited from
+
+[Query](Query.md).[getParameters](Query.md#getparameters)
+
+#### Defined in
+
+[src/Query.ts:26](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L26)
+
+___
+
+### getParametersForQuery
+
+▸ **getParametersForQuery**(): `Record`<`any`, `any`\>
+
+#### Returns
+
+`Record`<`any`, `any`\>
+
+#### Overrides
+
+[Query](Query.md).[getParametersForQuery](Query.md#getparametersforquery)
+
+#### Defined in
+
+[src/SetSessionVariableQuery.ts:23](https://github.com/breautek/storm/blob/3ad3438/src/SetSessionVariableQuery.ts#L23)
+
+___
+
+### getQuery
+
+▸ **getQuery**(`connection`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+[Query](Query.md).[getQuery](Query.md#getquery)
+
+#### Defined in
+
+[src/Query.ts:36](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L36)
+
+___
+
+### onPostProcess
+
+▸ **onPostProcess**(`connection`, `resultSet`): `Promise`<`void`\>
+
+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` | `void` | - |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Inherited from
+
+[Query](Query.md).[onPostProcess](Query.md#onpostprocess)
+
+#### Defined in
+
+[src/Query.ts:57](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L57)
+
+___
+
+### 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`\>
+
+#### Inherited from
+
+[Query](Query.md).[onPreQuery](Query.md#onprequery)
+
+#### Defined in
+
+[src/Query.ts:47](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L47)

package/docs/classes/StormError.md

@@ -0,0 +1,307 @@
+[@breautek/storm](../README.md) / StormError
+
+# Class: StormError<TErrorDetails\>
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `TErrorDetails` | `any` |
+
+## Hierarchy
+
+- `Error`
+
+  ↳ **`StormError`**
+
+  ↳↳ [`MissingParameterError`](MissingParameterError.md)
+
+  ↳↳ [`InvalidCredentialsError`](InvalidCredentialsError.md)
+
+  ↳↳ [`InternalError`](InternalError.md)
+
+  ↳↳ [`ExpiredTokenError`](ExpiredTokenError.md)
+
+  ↳↳ [`InvalidValueError`](InvalidValueError.md)
+
+  ↳↳ [`UnauthorizedAccessError`](UnauthorizedAccessError.md)
+
+  ↳↳ [`EntityNotFoundError`](EntityNotFoundError.md)
+
+  ↳↳ [`DiskSpaceError`](DiskSpaceError.md)
+
+  ↳↳ [`DuplicateEntryError`](DuplicateEntryError.md)
+
+  ↳↳ [`MissingConfigError`](MissingConfigError.md)
+
+  ↳↳ [`DatabaseQueryError`](DatabaseQueryError.md)
+
+## Table of contents
+
+### Constructors
+
+- [constructor](StormError.md#constructor)
+
+### Properties
+
+- [message](StormError.md#message)
+- [name](StormError.md#name)
+- [stack](StormError.md#stack)
+- [prepareStackTrace](StormError.md#preparestacktrace)
+- [stackTraceLimit](StormError.md#stacktracelimit)
+
+### Methods
+
+- [getCode](StormError.md#getcode)
+- [getErrorResponse](StormError.md#geterrorresponse)
+- [getExitCode](StormError.md#getexitcode)
+- [getHTTPCode](StormError.md#gethttpcode)
+- [getMessage](StormError.md#getmessage)
+- [getPrivateDetails](StormError.md#getprivatedetails)
+- [getPublicDetails](StormError.md#getpublicdetails)
+- [captureStackTrace](StormError.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new StormError**<`TErrorDetails`\>(`details?`)
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `TErrorDetails` | `any` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `details?` | `TErrorDetails` |
+
+#### Overrides
+
+Error.constructor
+
+#### Defined in
+
+[src/StormError.ts:38](https://github.com/breautek/storm/blob/3ad3438/src/StormError.ts#L38)
+
+## Properties
+
+### message
+
+• **message**: `string`
+
+#### Inherited from
+
+Error.message
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1029
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+Error.name
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1028
+
+___
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+Error.stack
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1030
+
+___
+
+### prepareStackTrace
+
+▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+#### Type declaration
+
+▸ (`err`, `stackTraces`): `any`
+
+Optional override for formatting stack traces
+
+**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `err` | `Error` |
+| `stackTraces` | `CallSite`[] |
+
+##### Returns
+
+`any`
+
+#### Inherited from
+
+Error.prepareStackTrace
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:11
+
+___
+
+### stackTraceLimit
+
+▪ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+Error.stackTraceLimit
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:13
+
+## Methods
+
+### getCode
+
+▸ `Abstract` **getCode**(): `number`
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+[src/StormError.ts:49](https://github.com/breautek/storm/blob/3ad3438/src/StormError.ts#L49)
+
+___
+
+### getErrorResponse
+
+▸ **getErrorResponse**(): [`IErrorResponse`](../interfaces/IErrorResponse.md)
+
+#### Returns
+
+[`IErrorResponse`](../interfaces/IErrorResponse.md)
+
+#### Defined in
+
+[src/StormError.ts:70](https://github.com/breautek/storm/blob/3ad3438/src/StormError.ts#L70)
+
+___
+
+### getExitCode
+
+▸ **getExitCode**(): [`ExitCode`](../enums/ExitCode.md)
+
+#### Returns
+
+[`ExitCode`](../enums/ExitCode.md)
+
+#### Defined in
+
+[src/StormError.ts:79](https://github.com/breautek/storm/blob/3ad3438/src/StormError.ts#L79)
+
+___
+
+### getHTTPCode
+
+▸ **getHTTPCode**(): [`StatusCode`](../enums/StatusCode.md)
+
+#### Returns
+
+[`StatusCode`](../enums/StatusCode.md)
+
+#### Defined in
+
+[src/StormError.ts:66](https://github.com/breautek/storm/blob/3ad3438/src/StormError.ts#L66)
+
+___
+
+### getMessage
+
+▸ `Abstract` **getMessage**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[src/StormError.ts:48](https://github.com/breautek/storm/blob/3ad3438/src/StormError.ts#L48)
+
+___
+
+### getPrivateDetails
+
+▸ **getPrivateDetails**(): `TErrorDetails`
+
+Private details are only logged to the server log.
+They are kept secret from the client.
+
+#### Returns
+
+`TErrorDetails`
+
+#### Defined in
+
+[src/StormError.ts:62](https://github.com/breautek/storm/blob/3ad3438/src/StormError.ts#L62)
+
+___
+
+### getPublicDetails
+
+▸ **getPublicDetails**(): [`IAdditionalErrorDetails`](../interfaces/IAdditionalErrorDetails.md)
+
+Sends details to the client.
+
+#### Returns
+
+[`IAdditionalErrorDetails`](../interfaces/IAdditionalErrorDetails.md)
+
+#### Defined in
+
+[src/StormError.ts:54](https://github.com/breautek/storm/blob/3ad3438/src/StormError.ts#L54)
+
+___
+
+### captureStackTrace
+
+▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `targetObject` | `object` |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+Error.captureStackTrace
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:4

package/docs/classes/TemporaryTableQuery.md

@@ -0,0 +1,207 @@
+[@breautek/storm](../README.md) / TemporaryTableQuery
+
+# Class: TemporaryTableQuery
+
+## Hierarchy
+
+- [`Query`](Query.md)<`any`\>
+
+  ↳ **`TemporaryTableQuery`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](TemporaryTableQuery.md#constructor)
+
+### Methods
+
+- [\_getQuery](TemporaryTableQuery.md#_getquery)
+- [execute](TemporaryTableQuery.md#execute)
+- [getParameters](TemporaryTableQuery.md#getparameters)
+- [getParametersForQuery](TemporaryTableQuery.md#getparametersforquery)
+- [getQuery](TemporaryTableQuery.md#getquery)
+- [onPostProcess](TemporaryTableQuery.md#onpostprocess)
+- [onPreQuery](TemporaryTableQuery.md#onprequery)
+
+## Constructors
+
+### constructor
+
+• **new TemporaryTableQuery**(`parameters?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `parameters?` | `any` |
+
+#### Inherited from
+
+[Query](Query.md).[constructor](Query.md#constructor)
+
+#### Defined in
+
+[src/Query.ts:22](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L22)
+
+## Methods
+
+### \_getQuery
+
+▸ `Protected` **_getQuery**(`connection`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
+
+#### Returns
+
+`string`
+
+#### Overrides
+
+[Query](Query.md).[_getQuery](Query.md#_getquery)
+
+#### Defined in
+
+[src/TemporaryTableQuery.ts:35](https://github.com/breautek/storm/blob/3ad3438/src/TemporaryTableQuery.ts#L35)
+
+___
+
+### execute
+
+▸ **execute**(`connection`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Inherited from
+
+[Query](Query.md).[execute](Query.md#execute)
+
+#### Defined in
+
+[src/Query.ts:62](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L62)
+
+___
+
+### getParameters
+
+▸ **getParameters**(): `any`
+
+#### Returns
+
+`any`
+
+#### Inherited from
+
+[Query](Query.md).[getParameters](Query.md#getparameters)
+
+#### Defined in
+
+[src/Query.ts:26](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L26)
+
+___
+
+### getParametersForQuery
+
+▸ **getParametersForQuery**(): `Record`<`any`, `any`\>
+
+#### Returns
+
+`Record`<`any`, `any`\>
+
+#### Overrides
+
+[Query](Query.md).[getParametersForQuery](Query.md#getparametersforquery)
+
+#### Defined in
+
+[src/TemporaryTableQuery.ts:27](https://github.com/breautek/storm/blob/3ad3438/src/TemporaryTableQuery.ts#L27)
+
+___
+
+### getQuery
+
+▸ **getQuery**(`connection`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+[Query](Query.md).[getQuery](Query.md#getquery)
+
+#### Defined in
+
+[src/Query.ts:36](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L36)
+
+___
+
+### onPostProcess
+
+▸ **onPostProcess**(`connection`, `resultSet`): `Promise`<`any`\>
+
+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` | `any` | - |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Inherited from
+
+[Query](Query.md).[onPostProcess](Query.md#onpostprocess)
+
+#### Defined in
+
+[src/Query.ts:57](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L57)
+
+___
+
+### 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`\>
+
+#### Inherited from
+
+[Query](Query.md).[onPreQuery](Query.md#onprequery)
+
+#### Defined in
+
+[src/Query.ts:47](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L47)