1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
/*
* Copyright (c) 2015, 2025, 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 designed to work 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 either included with
* the program or referenced in the documentation.
*
* 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
*/
syntax = "proto2";
// ifdef PROTOBUF_LITE: option optimize_for = LITE_RUNTIME;
import "mysqlx_datatypes.proto";
import "mysqlx.proto";
/**
@namespace Mysqlx::Connection
*/
package Mysqlx.Connection;
option java_package = "com.mysql.cj.x.protobuf";
/**
Capability
A tuple of a ``name`` and a @ref Mysqlx::Datatypes::Any
*/
message Capability {
required string name = 1;
required Mysqlx.Datatypes.Any value = 2;
}
/**
Capabilities
list of Capability
*/
message Capabilities {
repeated Capability capabilities = 1;
option (server_message_id) = CONN_CAPABILITIES; // comment_out_if PROTOBUF_LITE
}
/**
Get supported connection capabilities and their current state.
@returns @ref Mysqlx::Connection::Capabilities or @ref Mysqlx::Error
*/
message CapabilitiesGet {
option (client_message_id) = CON_CAPABILITIES_GET; // comment_out_if PROTOBUF_LITE
}
/**
Set connection capabilities atomically.
Only provided values are changed; other values are left
unchanged. If any of the changes fails, all changes are
discarded.
@pre active sessions == 0
@returns @ref Mysqlx::Ok or @ref Mysqlx::Error
*/
message CapabilitiesSet {
required Capabilities capabilities = 1;
option (client_message_id) = CON_CAPABILITIES_SET; // comment_out_if PROTOBUF_LITE
}
/**
Announce to the server that the client wants to close the connection.
It discards any session state of the server.
@returns @ref Mysqlx::Ok
*/
message Close {
option (client_message_id) = CON_CLOSE; // comment_out_if PROTOBUF_LITE
}
message Compression {
optional uint64 uncompressed_size = 1;
optional Mysqlx.ServerMessages.Type server_messages = 2;
optional Mysqlx.ClientMessages.Type client_messages = 3;
required bytes payload = 4;
option (server_message_id) = COMPRESSION; // comment_out_if PROTOBUF_LITE
option (client_message_id) = COMPRESSION; // comment_out_if PROTOBUF_LITE
}
|
