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

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

/*
 * Copyright (c) 2016, 2023, 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 uint64 = require('../Protocol/Wrappers/ScalarValues/uint64');
const Warnings = require('../../lib/constants/warnings');
const baseResult = require('./BaseResult');
const logger = require('../logger');

const log = logger('api:result');

/**
 * Result set object returned by each database operation.
 * @module Result
 * @mixes module:BaseResult
 */

/**
 * @private
 * @alias module:Result
 * @param {Array<String>} [generatedDocumentIds] - The list of document ids
 * that were auto-generated by the X Plugin for the statement.
 * @param {BigInt} [generatedInsertId] - The first AUTO_INCREMENT value
 * generated by the statement.
 * @param {int64.Type} [integerType] - The convertion mode selected by the
 * application to handle integer values in result sets for the current session.
 * @param {BigInt} [rowsAffected] - The number of rows affected by the statement.
 * @param {Array<Warning>} [warnings] - The list of warnings generated by the
 * statement.
 * @returns {module:Result}
 */
function Result ({ generatedDocumentIds = [], generatedInsertId = 0n, integerType, rowsAffected = 0n, warnings } = {}) {
    return {
        ...baseResult({ warnings }),
        /**
         * Retrieve the number of documents affected by the operation.
         * @function
         * @name module:Result#getAffectedItemsCount
         * @returns {int64} The number of documents.
         */
        getAffectedItemsCount () {
            return uint64.create(rowsAffected, { type: integerType }).valueOf();
        },

        /**
         * Retrieve the number of rows affected by the operation.
         * @function
         * @name module:Result#getAffectedRowsCount
         * @returns {int64} The number of rows.
         * @deprecated since version 8.0.19. Will be removed in future versions. Use {@link module:Result#getAffectedItemsCount|Result.getAffectedItemsCount()} instead.
         */
        getAffectedRowsCount () {
            log.warning('getAffectedRowsCount', Warnings.MESSAGES.WARN_DEPRECATED_RESULT_GET_AFFECTED_ROWS_COUNT, {
                type: Warnings.TYPES.DEPRECATION,
                code: Warnings.CODES.DEPRECATION
            });

            return this.getAffectedItemsCount();
        },

        /**
         * Retrieve the first <code>AUTO INCREMENT</code> value generated by the operation.
         * @function
         * @name module:Result#getAutoIncrementValue
         * @returns {int64} The first value.
         */
        getAutoIncrementValue () {
            return uint64.create(generatedInsertId, { type: integerType }).valueOf();
        },

        /**
         * Retrieve the list of server-side generated document ids.
         * @function
         * @name module:Result#getGeneratedIds
         * @returns {string[]} The list of ids.
         */
        getGeneratedIds () {
            // ids are encoded as V_OCTETS and should be decoded as utf8 strings
            return generatedDocumentIds.map(v => v.toString());
        }
    };
}

module.exports = Result;