You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
40 lines
1.3 KiB
40 lines
1.3 KiB
2 years ago
|
/*
|
||
|
|
* Copyright (c) 2015-present, Vitaly Tomilov
|
||
|
|
*
|
||
|
|
* See the LICENSE file at the top-level directory of this distribution
|
||
|
|
* for licensing information.
|
||
|
|
*
|
||
|
|
* Removal or modification of this copyright notice is prohibited.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @enum {number}
|
||
|
|
* @alias queryResult
|
||
|
|
* @readonly
|
||
|
|
* @description
|
||
|
|
* **Query Result Mask**
|
||
|
|
*
|
||
|
|
* Binary mask that represents the number of rows expected from a query method,
|
||
|
|
* used by generic {@link Database#query query} method, plus {@link Database#func func}.
|
||
|
|
*
|
||
|
|
* The mask is always the last optional parameter, which defaults to `queryResult.any`.
|
||
|
|
*
|
||
|
|
* Any combination of flags is supported, except for `one + many`.
|
||
|
|
*
|
||
|
|
* The type is available from the library's root: `pgp.queryResult`.
|
||
|
|
*
|
||
|
|
* @see {@link Database#query Database.query}, {@link Database#func Database.func}
|
||
|
|
*/
|
||
|
|
const queryResult = {
|
||
|
|
/** Single row is expected, to be resolved as a single row-object. */
|
||
|
|
one: 1,
|
||
|
|
/** One or more rows expected, to be resolved as an array, with at least 1 row-object. */
|
||
|
|
many: 2,
|
||
|
|
/** Expecting no rows, to be resolved with `null`. */
|
||
|
|
none: 4,
|
||
|
|
/** `many|none` - any result is expected, to be resolved with an array of rows-objects. */
|
||
|
|
any: 6
|
||
|
|
};
|
||
|
|
|
||
|
|
module.exports = {queryResult};
|