@mysql/xdevapi/lib/DevAPI/DocResult.js

MySQL Connector/Node.js - A Node.js driver for MySQL using the X Protocol and X DevAPI.

/*
 * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2.0, as
 * published by the Free Software Foundation.
 *
 * This program is also distributed with certain software (including
 * but not limited to OpenSSL) that is licensed under separate terms,
 * as designated in a particular file or component or in included license
 * documentation.  The authors of MySQL hereby grant you an
 * additional permission to link the program and your derivative works
 * with the separately licensed software that they have included with
 * MySQL.
 *
 * Without limiting anything contained in the foregoing, this file,
 * which is part of MySQL Connector/Node.js, is also subject to the
 * Universal FOSS Exception, version 1.0, a copy of which can be found at
 * http://oss.oracle.com/licenses/universal-foss-exception.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License, version 2.0, for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
 */

'use strict';

const baseResult = require('./BaseResult');

/**
 * API for Document Store retrieval operations.
 * @module DocResult
 * @mixes module:BaseResult
 */

/**
 * @private
 * @alias module:DocResult
 * @param {int64.Type} [integerType] - The convertion mode selected by the
 * application to handle integer values in result sets for the current session.
 * @param {Array<Array<*>>} [results] - The list of rows (each one a list of
 * column values in and of itself).
 * @param {Array<Warning>} [warnings] - The list of warnings generated by the
 * @returns {module:DocResult}
 */
function DocResult ({ integerType, results = [], warnings } = {}) {
    return {
        ...baseResult({ warnings }),
        /**
         * Consume the current result set from memory (and flush it).
         * @function
         * @name module:DocResult#fetchAll
         * @example
         * collection.find()
         *   .execute()
         *   .then(res => {
         *     // get the list of documents in the result set
         *     var docs = res.fetchAll()
         *   })
         * @returns {Array<Object>} A list of documents.
         */
        fetchAll () {
            if (!results.length) {
                return [];
            }

            const rows = results.splice(0, 1)[0];

            if (!rows || !rows.length) {
                return [];
            }

            return rows.map(row => row.toArray({ integerType })[0]);
        },

        /**
         * Consume a single result set document from memory (and flush it).
         * @function
         * @name module:DocResult#fetchOne
         * @example
         * collection.find()
         *   .execute()
         *   .then(res => {
         *     // iterate over the documents in the result set
         *     while (var doc = res.fetchOne()) {
         *       // do something with the current document
         *     }
         *   })
         * @returns {Object} A document.
         */
        fetchOne () {
            if (!results.length) {
                return;
            }

            const row = results[0].splice(0, 1)[0];

            if (!row) {
                return;
            }

            return row.toArray({ integerType })[0];
        },

        /**
         * Returns the result set (without flushing) as a JavaScript Arrray.
         * @function
         * @name module:DocResult#toArray
         * @returns {Array}
         */
        toArray () {
            if (!results.length) {
                return [];
            }

            return results[0].map(row => row.toArray({ integerType })[0]);
        }
    };
}

module.exports = DocResult;