You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -237,11 +237,11 @@ The only required property for a query is `text`, however, the behavior of the `
237
237
| Property | Type | Description |
238
238
| ------- | ------- | ----------- |
239
239
| text | string | SQL code to be executed against the database |
240
-
| mask | enum? | Optional result mask; can be one of the following values: [`list`, `single`]. If `mask` is not provided, no results will be returned to the caller (even for SELECT statements).<br>When `mask=list`, an array of rows retrieved from the database will be returned to the caller (or [] if no rows were returned).<br/>When `mask=single`, first row retrieved from the database will be returned to the caller (or undefined if no rows were returned) |
241
-
| mode | enum? | Optional row mode; can be one of the following values: [`object`, `array`]; default is `object`.When `mode=object`, each row will be returned as an object with property keys being field names; when `mode=array` each row will be returned as an array of values (without the field names) |
240
+
| mask | enum? | Optional result mask; can be one of the following values: [`list`, `single`]. If `mask` is not provided, no results will be returned to the caller (even for SELECT statements).<br/><br/>When `mask=list`, an array of rows retrieved from the database will be returned to the caller (or [] if no rows were returned).<br/><br/>When `mask=single`, first row retrieved from the database will be returned to the caller (or undefined if no rows were returned). |
241
+
| mode | enum? | Optional row mode; can be one of the following values: [`object`, `array`]; default is `object`.<br/><br/>When `mode=object`, each row will be returned as an object with property keys being field names.<br/><br/>When `mode=array` each row will be returned as an array of values (without the field names). |
242
242
| name | string? | Optional query name; used for logging. Also, when `execute()` is called with an array of queries, the returned map of results will be indexed by query name. For queries which don't have a name, the results will be held under the `undefined` key. If several executed queries have the same name, an array of results will be stored under the key for that name |
243
-
| params | object? | Optional query parameters to apply to to the query (see [parametarization](#parmetrized-queries))
244
-
| handler | <[ResultHandler](#result-parsing)> | Optional result handler to apply custom parsing logic |
243
+
| params | object? | Optional parameters to apply to to the query (see [parameterized queries](#parameterized-queries))
244
+
| handler | object? | Optional result handler to apply custom parsing logic (see [result parsing](#result-parsing) ) |
Queries can be parametrized using named parameters. Parameters must be enclosed in `{{}}` brackets and `params` object should be provided with parameter values.
Copy file name to clipboardExpand all lines: bin/README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -237,11 +237,11 @@ The only required property for a query is `text`, however, the behavior of the `
237
237
| Property | Type | Description |
238
238
| ------- | ------- | ----------- |
239
239
| text | string | SQL code to be executed against the database |
240
-
| mask | enum? | Optional result mask; can be one of the following values: [`list`, `single`]. If `mask` is not provided, no results will be returned to the caller (even for SELECT statements).<br>When `mask=list`, an array of rows retrieved from the database will be returned to the caller (or [] if no rows were returned).<br/>When `mask=single`, first row retrieved from the database will be returned to the caller (or undefined if no rows were returned) |
241
-
| mode | enum? | Optional row mode; can be one of the following values: [`object`, `array`]; default is `object`.When `mode=object`, each row will be returned as an object with property keys being field names; when `mode=array` each row will be returned as an array of values (without the field names) |
240
+
| mask | enum? | Optional result mask; can be one of the following values: [`list`, `single`]. If `mask` is not provided, no results will be returned to the caller (even for SELECT statements).<br/><br/>When `mask=list`, an array of rows retrieved from the database will be returned to the caller (or [] if no rows were returned).<br/><br/>When `mask=single`, first row retrieved from the database will be returned to the caller (or undefined if no rows were returned). |
241
+
| mode | enum? | Optional row mode; can be one of the following values: [`object`, `array`]; default is `object`.<br/><br/>When `mode=object`, each row will be returned as an object with property keys being field names.<br/><br/>When `mode=array` each row will be returned as an array of values (without the field names). |
242
242
| name | string? | Optional query name; used for logging. Also, when `execute()` is called with an array of queries, the returned map of results will be indexed by query name. For queries which don't have a name, the results will be held under the `undefined` key. If several executed queries have the same name, an array of results will be stored under the key for that name |
243
-
| params | object? | Optional query parameters to apply to to the query (see [parametarization](#parmetrized-queries))
244
-
| handler | <[ResultHandler](#result-parsing)> | Optional result handler to apply custom parsing logic |
243
+
| params | object? | Optional parameters to apply to to the query (see [parameterized queries](#parameterized-queries))
244
+
| handler | object? | Optional result handler to apply custom parsing logic (see [result parsing](#result-parsing) ) |
Queries can be parametrized using named parameters. Parameters must be enclosed in `{{}}` brackets and `params` object should be provided with parameter values.
0 commit comments