polardbxengine/plugin/polarx_rpc/protocol/polarx_sql.proto

79 lines
2.6 KiB
Protocol Buffer

/*
* Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; version 2 of the
* License.
*
* 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 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
*/
syntax = "proto2";
// ifdef PROTOBUF_LITE: option optimize_for = LITE_RUNTIME;
// Messages of the MySQL Package
package Polarx.Sql;
option java_package = "com.mysql.cj.polarx.protobuf";
import "polarx_datatypes.proto";
// execute a statement in the given namespace
//
// .. uml::
//
// client -> server: StmtExecute
// ... zero or more Resultsets ...
// server --> client: StmtExecuteOk
//
// Notices:
// This message may generate a notice containing WARNINGs generated by its execution.
// This message may generate a notice containing INFO messages generated by its execution.
//
// :param namespace: namespace of the statement to be executed
// :param stmt: statement that shall be executed.
// :param args: values for wildcard replacements
// :param compact_metadata: send only type information for :protobuf:msg:`Polarx.Resultset::ColumnMetadata`, skipping names and others
// :returns:
// * zero or one :protobuf:msg:`Polarx.Resultset::` followed by :protobuf:msg:`Polarx.Sql::StmtExecuteOk`
message StmtExecute {
optional string namespace = 3 [ default = "sql" ];
optional bytes stmt = 1;
optional bytes stmt_digest = 12;
optional bytes hint = 13;
optional bool chunk_result = 14 [default = false];
optional bool feed_back = 16 [default = false];
repeated Polarx.Datatypes.Any args = 2;
optional bool compact_metadata = 4 [ default = false ];
// For auto commit request.
optional string schema_name = 5;
repeated Polarx.Datatypes.SessionVariable session_variables = 6;
optional string encoding = 7;
optional int32 token = 8;
optional bool reset_error = 9;
optional uint64 snapshot_seq = 10;
optional uint64 commit_seq = 11;
optional bool use_cts_transaction = 15;
}
// statement executed successful
message StmtExecuteOk {
}
message TokenOffer {
optional int32 token = 1 [ default = -1];
}