@mysql/xdevapi/lib/DevAPI/CollectionOrdering.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 SortExprStr = require('./SortExprStr');

/**
 * This mixin grants sorting capabilities to a collection statement instance
 * via composition.
 * @mixin
 * @alias CollectionOrdering
 * @param {ExpressionTree[]} [orderList] - A list of order expression instances
 * for one ore more collection fields.
 * @param {Preparing} preparable - The instance of the underlying prepared
 * statement.
 * @returns {CollectionOrdering}
 */
function CollectionOrdering ({ orderList = [], preparable }) {
    return {
        /**
         * Retrieves the list of ordering expressions associated to a given
         * collection statement.
         * @private
         * @function
         * @name CollectionOrdering#getOrderList_
         * @returns {ExpressionTree[]} The List of order expression instances.
         */
        getOrderList_ () {
            return orderList;
        },

        /**
         * Establishes the order of one or more specific fields in the result
         * set.
         * This method does not cause the statement to be executed but changes
         * the statement boundaries, which means that if it has been prepared
         * before, it needs to be re-prepared.
         * @function
         * @name CollectionOrdering#sort
         * @param {...SortExprStrList} [sortExprStrList] - One or more
         * expressions establishing the order on which the given fields
         * are sorted.
         * @example
         * // arguments as columns (and direction) to sort
         * const query = collection.find().sort('foo asc', 'bar desc')
         *
         * // array of columns (and direction) to sort
         * const query = collection.find().sort(['foo asc', 'bar desc'])
         * @returns {CollectionOrdering} The instance of the statement itself
         * following a fluent API convention.
         */
        sort (...sortExprStrList) {
            preparable.forceRestart();

            sortExprStrList.flat().forEach(fieldOrColumn => {
                orderList.push(SortExprStr({ value: fieldOrColumn }).getValue());
            });

            return this;
        }
    };
}

module.exports = CollectionOrdering;