Class RawQuery<TQueryParameters, TQueryResultSet, TQueryPostProcessedResultSet>

Type Parameters

TQueryParameters = any
TQueryResultSet = any
TQueryPostProcessedResultSet = TQueryResultSet

Hierarchy (View Summary)

Query<TQueryParameters, TQueryResultSet, TQueryPostProcessedResultSet>
- RawQuery

Index

Constructors

Methods

_getQuery execute getParameters getParametersForQuery getQuery onPostProcess onPostQuery onPreQuery

Constructors

constructor

new RawQuery<
    TQueryParameters = any,
    TQueryResultSet = any,
    TQueryPostProcessedResultSet = TQueryResultSet,
>(
    query: string,
    parameters?: TQueryParameters,
): RawQuery<TQueryParameters, TQueryResultSet, TQueryPostProcessedResultSet>
Type Parameters
- TQueryParameters = any
- TQueryResultSet = any
- TQueryPostProcessedResultSet = TQueryResultSet
Parameters
- query: string
- Optionalparameters: TQueryParameters
Returns RawQuery<TQueryParameters, TQueryResultSet, TQueryPostProcessedResultSet>
Overrides Query.constructor
- Defined in src/RawQuery.ts:22

Methods

`Protected`_getQuery

_getQuery(): string
Returns string
Overrides Query._getQuery
- Defined in src/RawQuery.ts:27

execute

execute(connection: IDatabaseConnection): Promise<TQueryPostProcessedResultSet>
Parameters
- connection: IDatabaseConnection
Returns Promise<TQueryPostProcessedResultSet>
Inherited from Query.execute
- Defined in src/Query.ts:89

getParameters

getParameters(): TQueryParameters
Returns TQueryParameters
parameters that was passed into the constructor.
Inherited from Query.getParameters
- Defined in src/Query.ts:30

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.
Inherited from Query.getParametersForQuery
- Defined in src/Query.ts:39

getQuery

getQuery(connection: IDatabaseConnection): string
Parameters
- connection: IDatabaseConnection
Returns string
Inherited from Query.getQuery
- Defined in src/Query.ts:45

onPostProcess

onPostProcess(
connection: IDatabaseConnection,
resultSet: TQueryResultSet,
): Promise<TQueryPostProcessedResultSet>
Override to augment/manipulate the returned result set.
Parameters
- connection: IDatabaseConnection
  The connection object used for this query execution. Useful if further queries are required.
- resultSet: TQueryResultSet
Returns Promise<TQueryPostProcessedResultSet>
Deprecated
- Streaming queries does not support post processing, creating a confusing API
Inherited from Query.onPostProcess
- Defined in src/Query.ts:84

onPostQuery

onPostQuery(connection: IDatabaseConnection): Promise<void>
Overridable to execute statements after the main query. Can be used to clean up session variables or temporary tables, etc

Unlike onPostProcess, this hook does not provide the result set, and will be invoked even if the main query produces an error.
Parameters
- connection: IDatabaseConnection
Returns Promise<void>
Since
8.3.0
Inherited from Query.onPostQuery
- Defined in src/Query.ts:72

onPreQuery

onPreQuery(connection: IDatabaseConnection): Promise<void>
Overridable to execute statements before the main query. Can be used to set session variables or create temporary tables, etc.
Parameters
- connection: IDatabaseConnection
Returns Promise<void>
Inherited from Query.onPreQuery
- Defined in src/Query.ts:56