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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
/*
* 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
*/
// tell protobuf 3.0 to use protobuf 2.x rules
syntax = "proto2";
import "mysqlx.proto"; // comment_out_if PROTOBUF_LITE
// ifdef PROTOBUF_LITE: option optimize_for = LITE_RUNTIME;
/**
@namespace Mysqlx::Notice
@brief A notice
- is sent from the server to the client
- may be global or relate to the current message sequence
The server may send notices @ref Mysqlx::Notice::Frame
to the client at any time.
A notice can be:
- global (``.scope == GLOBAL``) or
- belong to the currently executed @ref messages_Message_Sequence
(``.scope == LOCAL + message sequence is active``):
@note
If the Server sends a ``LOCAL`` notice while no message sequence is
active, the Notice should be ignored.
@par Tip
For more information, see @ref mysqlx_protocol_notices "Notices".
*/
package Mysqlx.Notice;
option java_package = "com.mysql.cj.x.protobuf";
import "mysqlx_datatypes.proto";
/**
Common frame for all notices
| ``.type`` | Value |
|---------------------------------------------------|------ |
| @ref Mysqlx::Notice::Warning | 1 |
| @ref Mysqlx::Notice::SessionVariableChanged | 2 |
| @ref Mysqlx::Notice::SessionStateChanged | 3 |
| @ref Mysqlx::Notice::GroupReplicationStateChanged | 4 |
| @ref Mysqlx::Notice::ServerHello | 5 |
*/
message Frame {
/** scope of notice */
enum Scope {
GLOBAL = 1;
LOCAL = 2;
}
/** type of notice payload*/
enum Type {
WARNING = 1;
SESSION_VARIABLE_CHANGED = 2;
SESSION_STATE_CHANGED = 3;
GROUP_REPLICATION_STATE_CHANGED = 4;
SERVER_HELLO = 5;
}
/** the type of the payload */
required uint32 type = 1;
/** global or local notification */
optional Scope scope = 2 [ default = GLOBAL ];
/** the payload of the notification */
optional bytes payload = 3;
option (server_message_id) = NOTICE; // comment_out_if PROTOBUF_LITE
}
/**
Server-side warnings and notes
@par ``.scope`` == ``local``
``.level``, ``.code`` and ``.msg`` map the content of:
@code{sql}
SHOW WARNINGS
@endcode
@par ``.scope`` == ``global``
(undefined) Will be used for global, unstructured messages like:
- server is shutting down
- a node disconnected from group
- schema or table dropped
| @ref Mysqlx::Notice::Frame Field | Value |
|-----------------------------------|-------------------------|
| ``.type`` | 1 |
| ``.scope`` | ``local`` or ``global`` |
*/
message Warning {
enum Level {
NOTE = 1;
WARNING = 2;
ERROR = 3;
}
/** Note or Warning */
optional Level level = 1 [ default = WARNING ];
/** warning code */
required uint32 code = 2;
/** warning message */
required string msg = 3;
}
/**
Notify clients about changes to the current session variables.
Every change to a variable that is accessible through:
@code{sql}
SHOW SESSION VARIABLES
@endcode
| @ref Mysqlx::Notice::Frame Field | Value |
|-----------------------------------|----------|
| ``.type`` | 2 |
| ``.scope`` | ``local``|
*/
message SessionVariableChanged {
/** name of the variable */
required string param = 1;
/** the changed value of param */
optional Mysqlx.Datatypes.Scalar value = 2;
}
/**
Notify clients about changes to the internal session state.
| @ref Mysqlx::Notice::Frame Field | Value |
|-----------------------------------|----------|
| ``.type`` | 3 |
| ``.scope`` | ``local``|
*/
message SessionStateChanged {
enum Parameter {
CURRENT_SCHEMA = 1;
ACCOUNT_EXPIRED = 2;
GENERATED_INSERT_ID = 3;
ROWS_AFFECTED = 4;
ROWS_FOUND = 5;
ROWS_MATCHED = 6;
TRX_COMMITTED = 7;
TRX_ROLLEDBACK = 9;
PRODUCED_MESSAGE = 10;
CLIENT_ID_ASSIGNED = 11;
GENERATED_DOCUMENT_IDS = 12;
// .. more to be added
}
/** parameter key */
required Parameter param = 1;
/** updated value */
repeated Mysqlx.Datatypes.Scalar value = 2;
}
/**
Notify clients about group replication state changes
| @ref Mysqlx::Notice::Frame Field | Value |
|-----------------------------------|------------|
|``.type`` | 4 |
|``.scope`` | ``global`` |
*/
message GroupReplicationStateChanged {
enum Type {
MEMBERSHIP_QUORUM_LOSS = 1;
MEMBERSHIP_VIEW_CHANGE = 2;
MEMBER_ROLE_CHANGE = 3;
MEMBER_STATE_CHANGE = 4;
}
/** type of group replication event */
required uint32 type = 1;
/** view identifier */
optional string view_id = 2;
}
/**
Notify clients about connection to X Protocol server
| @ref Mysqlx::Notice::Frame Field | Value |
|-----------------------------------|------------|
|``.type`` | 5 |
|``.scope`` | ``global`` |
*/
message ServerHello {
}
|
