@mysql/xdevapi/types/lib/DevAPI/SqlExecute.d.ts

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
 */

import SqlResult from './SqlResult';
import { Literal } from './Statement';

/**
 * Statement generated by `session.sql()`.
 */
interface SqlExecute {
    /**
     * Appends one or more placeholder arguments to the SQL statement to be
     * executed. Although the X Protocol supports additional, types, in the
     * scope of SQL statements, for now, only scalar values make sense.
     * @param args - One or more placeholders individually or as a list.
     * @returns The instance of the X DevAPI wrapper of the current statement.
     */
    bind: (arg: Literal, ...args: Literal[]) => SqlExecute
    /**
     * Sends the current SQL statement to the server.
     * @returns A `Promise` that resolves to an instance of the corresponding
     * result set when the statement has been executed in the server.
     */
    execute: () => Promise<SqlResult>
}

export default SqlExecute;