QueryExecutor
age-schema-client / QueryExecutor
Class: QueryExecutor
Defined in: src/db/query.ts:250
Query executor class
Constructors
Constructor
new QueryExecutor(connection, logger): QueryExecutor;
Defined in: src/db/query.ts:260
Create a new query executor
Parameters
| Parameter | Type | Description |
|---|---|---|
connection | Connection | Database connection |
logger | QueryLogger | Query logger |
Returns
QueryExecutor
Methods
executeSQL()
executeSQL<T>(
sql,
params?,
options?): Promise<QueryResult<T>>;
Defined in: src/db/query.ts:276
Execute a SQL query
Type Parameters
| Type Parameter | Default type |
|---|---|
T | any |
Parameters
| Parameter | Type | Description |
|---|---|---|
sql | string | SQL query |
params? | any[] | Query parameters |
options? | QueryOptions | Query options |
Returns
Promise<QueryResult<T>>
Query result
executeCypher()
executeCypher<T>(
cypher,
params?,
graphName?,
options?): Promise<QueryResult<T>>;
Defined in: src/db/query.ts:425
Execute a Cypher query
Type Parameters
| Type Parameter | Default type |
|---|---|
T | any |
Parameters
| Parameter | Type | Description |
|---|---|---|
cypher | string | Cypher query |
params? | Record<string, any> | Query parameters |
graphName? | string | Graph name |
options? | QueryOptions | Query options |
Returns
Promise<QueryResult<T>>
Query result
executeCopyFrom()
executeCopyFrom(
sql,
data,
options): Promise<QueryResult<any>>;
Defined in: src/db/query.ts:701
Execute a COPY FROM operation to load data from a string
Parameters
| Parameter | Type | Description |
|---|---|---|
sql | string | COPY SQL statement |
data | string | Data to load |
options | QueryOptions & object | Query options |
Returns
Promise<QueryResult<any>>
Query result
beginTransaction()
beginTransaction(): Promise<any>;
Defined in: src/db/query.ts:829
Begin a transaction
Returns
Promise<any>
Transaction object
transformResult()
transformResult<T, R>(result, transformer): R[];
Defined in: src/db/query.ts:848
Transform query result
Type Parameters
| Type Parameter |
|---|
T |
R |
Parameters
| Parameter | Type | Description |
|---|---|---|
result | QueryResult<T> | Raw query result |
transformer | (row) => R | Transformer function |
Returns
R[]
Transformed result