@breautek/storm 8.1.4 → 8.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +13 -0
- package/docs/assets/hierarchy.js +1 -1
- package/docs/assets/main.js +4 -4
- package/docs/assets/search.js +1 -1
- package/docs/assets/style.css +5 -4
- package/docs/classes/Application.html +144 -143
- package/docs/classes/BackendAuthenticationMiddleware.html +5 -5
- package/docs/classes/CORSMiddleware.html +10 -10
- package/docs/classes/ConfigLoader.html +5 -5
- package/docs/classes/Database.html +13 -13
- package/docs/classes/DatabaseCastObject.html +5 -5
- package/docs/classes/DatabaseConnection.html +41 -41
- package/docs/classes/DatabaseQueryError.html +22 -22
- package/docs/classes/DeadLockError.html +23 -23
- package/docs/classes/DiskSpaceError.html +22 -22
- package/docs/classes/DropTemporaryTableQuery.html +19 -13
- package/docs/classes/DuplicateEntryError.html +22 -22
- package/docs/classes/EntityNotFoundError.html +22 -22
- package/docs/classes/ExpiredTokenError.html +22 -22
- package/docs/classes/Handler.html +14 -14
- package/docs/classes/InternalError.html +22 -22
- package/docs/classes/InvalidCredentialsError.html +22 -22
- package/docs/classes/InvalidValueError.html +22 -22
- package/docs/classes/LineString.html +5 -5
- package/docs/classes/LockWaitTimeoutError.html +23 -23
- package/docs/classes/ManagedDatabaseConnection.html +22 -22
- package/docs/classes/Middleware.html +4 -4
- package/docs/classes/MissingConfigError.html +22 -22
- package/docs/classes/MissingParameterError.html +22 -22
- package/docs/classes/MySQLConnection.html +46 -46
- package/docs/classes/MySQLDatabase.html +14 -14
- package/docs/classes/NotImplementedError.html +22 -22
- package/docs/classes/Point.html +5 -5
- package/docs/classes/Polygon.html +5 -5
- package/docs/classes/Query.html +19 -13
- package/docs/classes/RawError.html +23 -23
- package/docs/classes/RawQuery.html +19 -13
- package/docs/classes/Request.html +19 -19
- package/docs/classes/Response.html +12 -12
- package/docs/classes/ResponseData.html +8 -8
- package/docs/classes/ServiceProvider.html +16 -16
- package/docs/classes/ServiceResponse.html +6 -6
- package/docs/classes/SetSessionVariableQuery.html +19 -13
- package/docs/classes/StormError.html +22 -22
- package/docs/classes/TemporaryTableQuery.html +19 -13
- package/docs/classes/TimeoutError.html +23 -23
- package/docs/classes/Token.html +3 -3
- package/docs/classes/TokenManager.html +5 -5
- package/docs/classes/Transaction.html +9 -8
- package/docs/classes/UnauthorizedAccessError.html +22 -22
- package/docs/enums/ErrorCode.html +10 -10
- package/docs/enums/ExitCode.html +3 -3
- package/docs/enums/HTTPMethod.html +5 -5
- package/docs/enums/IsolationLevel.html +5 -5
- package/docs/enums/JWTError.html +3 -3
- package/docs/enums/StatusCode.html +49 -49
- package/docs/functions/getInstance.html +2 -2
- package/docs/hierarchy.html +1 -1
- package/docs/index.html +1 -1
- package/docs/interfaces/IAdditionalErrorDetails.html +1 -1
- package/docs/interfaces/IAuthTokenData.html +4 -4
- package/docs/interfaces/ICloudwatchConfig.html +4 -4
- package/docs/interfaces/ICloudwatchCredentials.html +3 -3
- package/docs/interfaces/ICloudwatchStreamConfig.html +3 -3
- package/docs/interfaces/IConfig.html +10 -10
- package/docs/interfaces/IDatabaseConfig.html +7 -7
- package/docs/interfaces/IDatabaseConnection.html +17 -17
- package/docs/interfaces/IDatabasePosition.html +4 -4
- package/docs/interfaces/IErrorResponse.html +6 -6
- package/docs/interfaces/IFormData.html +3 -3
- package/docs/interfaces/IHandler.html +2 -2
- package/docs/interfaces/IInsertQueryResult.html +4 -4
- package/docs/interfaces/IJWTVerifyOptions.html +2 -2
- package/docs/interfaces/IOKPacket.html +10 -10
- package/docs/interfaces/IParameterMap.html +1 -1
- package/docs/interfaces/IQueryable.html +7 -6
- package/docs/interfaces/IRequestResponse.html +3 -3
- package/docs/interfaces/IServiceHeaders.html +1 -1
- package/docs/interfaces/ISetSessionVariableQueryInput.html +3 -3
- package/docs/interfaces/IStormCLIArgs.html +7 -7
- package/docs/interfaces/ITemporaryTableQueryInput.html +3 -3
- package/docs/interfaces/IUpdateQueryResult.html +3 -3
- package/docs/modules/formidable.html +1 -1
- package/docs/types/IDeleteQueryResult.html +1 -1
- package/docs/types/IHandlerError.html +2 -2
- package/docs/types/IHandlerResponse.html +2 -2
- package/docs/types/IStoredProcedureResult.html +3 -3
- package/docs/types/TCoordinate.html +1 -1
- package/docs/variables/formidable-1.html +1 -1
- package/lib/Application.d.ts +1 -0
- package/lib/Application.js +3 -0
- package/lib/Application.js.map +1 -1
- package/lib/DatabaseConnection.js +14 -2
- package/lib/DatabaseConnection.js.map +1 -1
- package/lib/IQueryable.d.ts +1 -0
- package/lib/Query.d.ts +13 -0
- package/lib/Query.js +15 -0
- package/lib/Query.js.map +1 -1
- package/lib/Transaction.d.ts +1 -0
- package/lib/Transaction.js +1 -0
- package/lib/Transaction.js.map +1 -1
- package/package.json +7 -7
- package/src/Application.ts +4 -0
- package/src/DatabaseConnection.ts +18 -2
- package/src/IQueryable.ts +1 -0
- package/src/Query.ts +16 -0
- package/src/Transaction.ts +1 -0
|
@@ -1,16 +1,22 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RawQuery | @breautek/storm</title><meta name="description" content="Documentation for @breautek/storm"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@breautek/storm</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@breautek/storm</a></li><li><a href="RawQuery.html">RawQuery</a></li></ul><h1>Class RawQuery<TQueryParameters, TQueryResultSet, TQueryPostProcessedResultSet></h1></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="tqueryparameters" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TQueryParameters</span> = <span class="tsd-signature-type">any</span></span></li><li><span><a id="tqueryresultset" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TQueryResultSet</span> = <span class="tsd-signature-type">any</span></span></li><li><span><a id="tquerypostprocessedresultset" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TQueryPostProcessedResultSet</span> = <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryresultset">TQueryResultSet</a></span></li></ul></section> <section class="tsd-panel tsd-hierarchy" data-refl="
|
|
2
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="RawQuery.html#_getquery" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_get<wbr/>Query</span></a>
|
|
3
|
-
<a href="RawQuery.html#execute" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>execute</span></a>
|
|
4
|
-
<a href="RawQuery.html#getparameters" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Parameters</span></a>
|
|
5
|
-
<a href="RawQuery.html#getparametersforquery" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Parameters<wbr/>For<wbr/>Query</span></a>
|
|
6
|
-
<a href="RawQuery.html#getquery" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Query</span></a>
|
|
7
|
-
<a href="RawQuery.html#onpostprocess" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Post<wbr/>Process</span></a>
|
|
8
|
-
<a href="RawQuery.html#
|
|
9
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructorrawquery" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">RawQuery</span><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryparameters">TQueryParameters</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryresultset">TQueryResultSet</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytquerypostprocessedresultset">TQueryPostProcessedResultSet</a> <span class="tsd-signature-symbol">=</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryresultset">TQueryResultSet</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryparameters">TQueryParameters</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="RawQuery.html" class="tsd-signature-type tsd-kind-class">RawQuery</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryparameters">TQueryParameters</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryresultset">TQueryResultSet</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytquerypostprocessedresultset">TQueryPostProcessedResultSet</a><span class="tsd-signature-symbol">></span><a href="#constructorrawquery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="constructorrawquerytqueryparameters" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TQueryParameters</span> = <span class="tsd-signature-type">any</span></span></li><li><span><a id="constructorrawquerytqueryresultset" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TQueryResultSet</span> = <span class="tsd-signature-type">any</span></span></li><li><span><a id="constructorrawquerytquerypostprocessedresultset" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TQueryPostProcessedResultSet</span> = <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryresultset">TQueryResultSet</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">parameters</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryparameters">TQueryParameters</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="RawQuery.html" class="tsd-signature-type tsd-kind-class">RawQuery</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryparameters">TQueryParameters</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryresultset">TQueryResultSet</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytquerypostprocessedresultset">TQueryPostProcessedResultSet</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Overrides <a href="Query.html">Query</a>.<a href="Query.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/breautek/storm/blob/98a42a5ea145f78d0208ffc6475e1b29c80e0ad6/src/RawQuery.ts#L22">src/RawQuery.ts:22</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member tsd-is-protected"><a id="_getquery" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>_get<wbr/>Query</span><a href="#_getquery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected"><li class="tsd-signature tsd-anchor-link"><a id="_getquery-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">_getQuery</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#_getquery-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Overrides <a href="Query.html">Query</a>.<a href="Query.html#_getquery">_getQuery</a></p><ul><li>Defined in <a href="https://github.com/breautek/storm/blob/98a42a5ea145f78d0208ffc6475e1b29c80e0ad6/src/RawQuery.ts#L27">src/RawQuery.ts:27</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="execute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>execute</span><a href="#execute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="execute-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">execute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connection</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/IDatabaseConnection.html" class="tsd-signature-type tsd-kind-interface">IDatabaseConnection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytquerypostprocessedresultset">TQueryPostProcessedResultSet</a><span class="tsd-signature-symbol">></span><a href="#execute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">connection</span>: <a href="../interfaces/IDatabaseConnection.html" class="tsd-signature-type tsd-kind-interface">IDatabaseConnection</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytquerypostprocessedresultset">TQueryPostProcessedResultSet</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="Query.html">Query</a>.<a href="Query.html#execute">execute</a></p><ul><li>Defined in <a href="https://github.com/breautek/storm/blob/98a42a5ea145f78d0208ffc6475e1b29c80e0ad6/src/Query.ts#L71">src/Query.ts:71</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getparameters" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Parameters</span><a href="#getparameters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getparameters-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getParameters</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryparameters">TQueryParameters</a><a href="#getparameters-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryparameters">TQueryParameters</a></h4><p>parameters that was passed into the constructor.</p>
|
|
10
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Query.html">Query</a>.<a href="Query.html#getparameters">getParameters</a></p><ul><li>Defined in <a href="https://github.com/breautek/storm/blob/98a42a5ea145f78d0208ffc6475e1b29c80e0ad6/src/Query.ts#L30">src/Query.ts:30</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getparametersforquery" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Parameters<wbr/>For<wbr/>Query</span><a href="#getparametersforquery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getparametersforquery-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getParametersForQuery</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#getparametersforquery-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Query implementations may override this API to augment the parameters.</p>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RawQuery | @breautek/storm</title><meta name="description" content="Documentation for @breautek/storm"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@breautek/storm</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@breautek/storm</a></li><li><a href="RawQuery.html">RawQuery</a></li></ul><h1>Class RawQuery<TQueryParameters, TQueryResultSet, TQueryPostProcessedResultSet></h1></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="tqueryparameters" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TQueryParameters</span> = <span class="tsd-signature-type">any</span></span></li><li><span><a id="tqueryresultset" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TQueryResultSet</span> = <span class="tsd-signature-type">any</span></span></li><li><span><a id="tquerypostprocessedresultset" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TQueryPostProcessedResultSet</span> = <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryresultset">TQueryResultSet</a></span></li></ul></section> <section class="tsd-panel tsd-hierarchy" data-refl="677"><h4>Hierarchy (<a href="../hierarchy.html#RawQuery">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="Query.html" class="tsd-signature-type tsd-kind-class">Query</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryparameters">TQueryParameters</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryresultset">TQueryResultSet</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytquerypostprocessedresultset">TQueryPostProcessedResultSet</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">RawQuery</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/breautek/storm/blob/16ca0191092b3df9a574e48b774c94d7b12b8ee9/src/RawQuery.ts#L19">src/RawQuery.ts:19</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="RawQuery.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
2
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="RawQuery.html#_getquery" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_get<wbr/>Query</span></a>
|
|
3
|
+
<a href="RawQuery.html#execute" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>execute</span></a>
|
|
4
|
+
<a href="RawQuery.html#getparameters" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Parameters</span></a>
|
|
5
|
+
<a href="RawQuery.html#getparametersforquery" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Parameters<wbr/>For<wbr/>Query</span></a>
|
|
6
|
+
<a href="RawQuery.html#getquery" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Query</span></a>
|
|
7
|
+
<a href="RawQuery.html#onpostprocess" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Post<wbr/>Process</span></a>
|
|
8
|
+
<a href="RawQuery.html#onpostquery" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Post<wbr/>Query</span></a>
|
|
9
|
+
<a href="RawQuery.html#onprequery" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Pre<wbr/>Query</span></a>
|
|
10
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructorrawquery" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">RawQuery</span><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryparameters">TQueryParameters</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryresultset">TQueryResultSet</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytquerypostprocessedresultset">TQueryPostProcessedResultSet</a> <span class="tsd-signature-symbol">=</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryresultset">TQueryResultSet</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryparameters">TQueryParameters</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="RawQuery.html" class="tsd-signature-type tsd-kind-class">RawQuery</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryparameters">TQueryParameters</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryresultset">TQueryResultSet</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytquerypostprocessedresultset">TQueryPostProcessedResultSet</a><span class="tsd-signature-symbol">></span><a href="#constructorrawquery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="constructorrawquerytqueryparameters" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TQueryParameters</span> = <span class="tsd-signature-type">any</span></span></li><li><span><a id="constructorrawquerytqueryresultset" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TQueryResultSet</span> = <span class="tsd-signature-type">any</span></span></li><li><span><a id="constructorrawquerytquerypostprocessedresultset" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TQueryPostProcessedResultSet</span> = <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryresultset">TQueryResultSet</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">parameters</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryparameters">TQueryParameters</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="RawQuery.html" class="tsd-signature-type tsd-kind-class">RawQuery</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryparameters">TQueryParameters</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryresultset">TQueryResultSet</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytquerypostprocessedresultset">TQueryPostProcessedResultSet</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Overrides <a href="Query.html">Query</a>.<a href="Query.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/breautek/storm/blob/16ca0191092b3df9a574e48b774c94d7b12b8ee9/src/RawQuery.ts#L22">src/RawQuery.ts:22</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member tsd-is-protected"><a id="_getquery" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>_get<wbr/>Query</span><a href="#_getquery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="_getquery-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">_getQuery</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#_getquery-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Overrides <a href="Query.html">Query</a>.<a href="Query.html#_getquery">_getQuery</a></p><ul><li>Defined in <a href="https://github.com/breautek/storm/blob/16ca0191092b3df9a574e48b774c94d7b12b8ee9/src/RawQuery.ts#L27">src/RawQuery.ts:27</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="execute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>execute</span><a href="#execute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="execute-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">execute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connection</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/IDatabaseConnection.html" class="tsd-signature-type tsd-kind-interface">IDatabaseConnection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytquerypostprocessedresultset">TQueryPostProcessedResultSet</a><span class="tsd-signature-symbol">></span><a href="#execute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">connection</span>: <a href="../interfaces/IDatabaseConnection.html" class="tsd-signature-type tsd-kind-interface">IDatabaseConnection</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytquerypostprocessedresultset">TQueryPostProcessedResultSet</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="Query.html">Query</a>.<a href="Query.html#execute">execute</a></p><ul><li>Defined in <a href="https://github.com/breautek/storm/blob/16ca0191092b3df9a574e48b774c94d7b12b8ee9/src/Query.ts#L87">src/Query.ts:87</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getparameters" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Parameters</span><a href="#getparameters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getparameters-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getParameters</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryparameters">TQueryParameters</a><a href="#getparameters-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryparameters">TQueryParameters</a></h4><p>parameters that was passed into the constructor.</p>
|
|
11
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Query.html">Query</a>.<a href="Query.html#getparameters">getParameters</a></p><ul><li>Defined in <a href="https://github.com/breautek/storm/blob/16ca0191092b3df9a574e48b774c94d7b12b8ee9/src/Query.ts#L30">src/Query.ts:30</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getparametersforquery" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Parameters<wbr/>For<wbr/>Query</span><a href="#getparametersforquery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getparametersforquery-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getParametersForQuery</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#getparametersforquery-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Query implementations may override this API to augment the parameters.</p>
|
|
11
12
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><p>parameters that will be used when this query is ran.</p>
|
|
12
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Query.html">Query</a>.<a href="Query.html#getparametersforquery">getParametersForQuery</a></p><ul><li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
13
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Query.html">Query</a>.<a href="Query.html#getparametersforquery">getParametersForQuery</a></p><ul><li>Defined in <a href="https://github.com/breautek/storm/blob/16ca0191092b3df9a574e48b774c94d7b12b8ee9/src/Query.ts#L39">src/Query.ts:39</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getquery" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Query</span><a href="#getquery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getquery-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getQuery</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connection</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/IDatabaseConnection.html" class="tsd-signature-type tsd-kind-interface">IDatabaseConnection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#getquery-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">connection</span>: <a href="../interfaces/IDatabaseConnection.html" class="tsd-signature-type tsd-kind-interface">IDatabaseConnection</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Inherited from <a href="Query.html">Query</a>.<a href="Query.html#getquery">getQuery</a></p><ul><li>Defined in <a href="https://github.com/breautek/storm/blob/16ca0191092b3df9a574e48b774c94d7b12b8ee9/src/Query.ts#L45">src/Query.ts:45</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="onpostprocess" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on<wbr/>Post<wbr/>Process</span><a href="#onpostprocess" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="onpostprocess-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">onPostProcess</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">connection</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/IDatabaseConnection.html" class="tsd-signature-type tsd-kind-interface">IDatabaseConnection</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">resultSet</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryresultset">TQueryResultSet</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytquerypostprocessedresultset">TQueryPostProcessedResultSet</a><span class="tsd-signature-symbol">></span><a href="#onpostprocess-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Override to augment/manipulate the returned result set.</p>
|
|
13
14
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">connection</span>: <a href="../interfaces/IDatabaseConnection.html" class="tsd-signature-type tsd-kind-interface">IDatabaseConnection</a></span><div class="tsd-comment tsd-typography"><p>The connection object used for this query execution. Useful if further queries are required.</p>
|
|
14
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">resultSet</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryresultset">TQueryResultSet</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytquerypostprocessedresultset">TQueryPostProcessedResultSet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Query.html">Query</a>.<a href="Query.html#onpostprocess">onPostProcess</a></p><ul><li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
15
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">resultSet</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytqueryresultset">TQueryResultSet</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="RawQuery.html#constructorrawquerytquerypostprocessedresultset">TQueryPostProcessedResultSet</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Query.html">Query</a>.<a href="Query.html#onpostprocess">onPostProcess</a></p><ul><li>Defined in <a href="https://github.com/breautek/storm/blob/16ca0191092b3df9a574e48b774c94d7b12b8ee9/src/Query.ts#L82">src/Query.ts:82</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="onpostquery" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on<wbr/>Post<wbr/>Query</span><a href="#onpostquery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="onpostquery-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">onPostQuery</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connection</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/IDatabaseConnection.html" class="tsd-signature-type tsd-kind-interface">IDatabaseConnection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#onpostquery-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Overridable to execute statements after the main query.
|
|
16
|
+
Can be used to clean up session variables or temporary tables, etc</p>
|
|
17
|
+
<p>Unlike <a href="RawQuery.html#onpostprocess" class="tsd-kind-method">onPostProcess</a>, this hook does not provide the result set,
|
|
18
|
+
and will be invoked even if the main query produces an error.</p>
|
|
19
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">connection</span>: <a href="../interfaces/IDatabaseConnection.html" class="tsd-signature-type tsd-kind-interface">IDatabaseConnection</a></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-since"><h4 class="tsd-anchor-link"><a id="since" class="tsd-anchor"></a>Since<a href="#since" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>8.3.0</p>
|
|
20
|
+
</div></div><aside class="tsd-sources"><p>Inherited from <a href="Query.html">Query</a>.<a href="Query.html#onpostquery">onPostQuery</a></p><ul><li>Defined in <a href="https://github.com/breautek/storm/blob/16ca0191092b3df9a574e48b774c94d7b12b8ee9/src/Query.ts#L72">src/Query.ts:72</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="onprequery" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on<wbr/>Pre<wbr/>Query</span><a href="#onprequery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="onprequery-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">onPreQuery</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connection</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/IDatabaseConnection.html" class="tsd-signature-type tsd-kind-interface">IDatabaseConnection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#onprequery-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Overridable to execute statements before the main query.
|
|
15
21
|
Can be used to set session variables or create temporary tables, etc.</p>
|
|
16
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">connection</span>: <a href="../interfaces/IDatabaseConnection.html" class="tsd-signature-type tsd-kind-interface">IDatabaseConnection</a></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Query.html">Query</a>.<a href="Query.html#onprequery">onPreQuery</a></p><ul><li>Defined in <a href="https://github.com/breautek/storm/blob/
|
|
22
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">connection</span>: <a href="../interfaces/IDatabaseConnection.html" class="tsd-signature-type tsd-kind-interface">IDatabaseConnection</a></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="Query.html">Query</a>.<a href="Query.html#onprequery">onPreQuery</a></p><ul><li>Defined in <a href="https://github.com/breautek/storm/blob/16ca0191092b3df9a574e48b774c94d7b12b8ee9/src/Query.ts#L56">src/Query.ts:56</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#_getquery" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_get<wbr/>Query</span></a><a href="#execute" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>execute</span></a><a href="#getparameters" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Parameters</span></a><a href="#getparametersforquery" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Parameters<wbr/>For<wbr/>Query</span></a><a href="#getquery" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Query</span></a><a href="#onpostprocess" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Post<wbr/>Process</span></a><a href="#onpostquery" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Post<wbr/>Query</span></a><a href="#onprequery" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Pre<wbr/>Query</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">@breautek/storm</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|