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

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

/*
 * Copyright (c) 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 ExprParser = require('../ExprParser');

/**
 * Factory function to create instances of an informal type that encapsulates
 * a set of order for column names and document fields as a string or an X
 * DevAPI expression (computed or not).
 * @private
 * @module SortExprStr
 */

const parsers = {
    [ExprParser.Mode.DOCUMENT]: ExprParser({ type: ExprParser.Type.SORT_EXPR }),
    [ExprParser.Mode.TABLE]: ExprParser({ mode: ExprParser.Mode.TABLE, type: ExprParser.Type.SORT_EXPR })
};

/**
 * A column name and optional alias to include as part of a result set.
 * @typedef {string|module:Expr} SortExprStr
 * @global
 */

/**
 * One or more column names and corresponding optional aliases.
 * @typedef {SortExprStr|SortExprStr[]} SortExprStrList
 * @global
 * @see {@link https://dev.mysql.com/doc/x-devapi-userguide/en/crud-ebnf-other-definitions.html#crud-ebnf-sortexprstrlist|SortExprStrList}
 */

/**
 * @private
 * @alias module:SortExprStr
 * @param {SortExprStr} value - String or X DevAPI expression instance
 * containing a column or field name and the direction in which it should
 * be ordered on the result set.
 * @returns {module:SortExprStr}
 */
function SortExprStr ({ dataModel = ExprParser.Mode.DOCUMENT, value }) {
    return {
        /**
         * Parses the underlying order expression and return the result.
         * @private
         * @function
         * @name module:ProjectedSearchExprStr#getValue
         * @returns {ExpressionTree} An object that represents an expression
         * tree that results from parsing a given X DevAPI order
         * expression string.
         */
        getValue () {
            return parsers[dataModel].parse(value);
        }
    };
}

module.exports = SortExprStr;