Documentation ¶
Overview ¶
Package Mysqlx_Notice is a generated protocol buffer package.
Notices ¶
A notice ¶
* is sent from the server to the client * may be global or relate to the current message sequence
It is generated from these files:
github.com/pingcap/tipb/go-mysqlx/Notice/mysqlx_notice.proto
It has these top-level messages:
Frame Warning SessionVariableChanged SessionStateChanged
Index ¶
- Variables
- type Frame
- func (*Frame) Descriptor() ([]byte, []int)
- func (m *Frame) GetPayload() []byte
- func (m *Frame) GetScope() Frame_Scope
- func (m *Frame) GetType() uint32
- func (m *Frame) Marshal() (dAtA []byte, err error)
- func (m *Frame) MarshalTo(dAtA []byte) (int, error)
- func (*Frame) ProtoMessage()
- func (m *Frame) Reset()
- func (m *Frame) Size() (n int)
- func (m *Frame) String() string
- func (m *Frame) Unmarshal(dAtA []byte) error
- type Frame_Scope
- type SessionStateChanged
- func (*SessionStateChanged) Descriptor() ([]byte, []int)
- func (m *SessionStateChanged) GetParam() SessionStateChanged_Parameter
- func (m *SessionStateChanged) GetValue() *Mysqlx_Datatypes.Scalar
- func (m *SessionStateChanged) Marshal() (dAtA []byte, err error)
- func (m *SessionStateChanged) MarshalTo(dAtA []byte) (int, error)
- func (*SessionStateChanged) ProtoMessage()
- func (m *SessionStateChanged) Reset()
- func (m *SessionStateChanged) Size() (n int)
- func (m *SessionStateChanged) String() string
- func (m *SessionStateChanged) Unmarshal(dAtA []byte) error
- type SessionStateChanged_Parameter
- type SessionVariableChanged
- func (*SessionVariableChanged) Descriptor() ([]byte, []int)
- func (m *SessionVariableChanged) GetParam() string
- func (m *SessionVariableChanged) GetValue() *Mysqlx_Datatypes.Scalar
- func (m *SessionVariableChanged) Marshal() (dAtA []byte, err error)
- func (m *SessionVariableChanged) MarshalTo(dAtA []byte) (int, error)
- func (*SessionVariableChanged) ProtoMessage()
- func (m *SessionVariableChanged) Reset()
- func (m *SessionVariableChanged) Size() (n int)
- func (m *SessionVariableChanged) String() string
- func (m *SessionVariableChanged) Unmarshal(dAtA []byte) error
- type Warning
- func (*Warning) Descriptor() ([]byte, []int)
- func (m *Warning) GetCode() uint32
- func (m *Warning) GetLevel() Warning_Level
- func (m *Warning) GetMsg() string
- func (m *Warning) Marshal() (dAtA []byte, err error)
- func (m *Warning) MarshalTo(dAtA []byte) (int, error)
- func (*Warning) ProtoMessage()
- func (m *Warning) Reset()
- func (m *Warning) Size() (n int)
- func (m *Warning) String() string
- func (m *Warning) Unmarshal(dAtA []byte) error
- type Warning_Level
Constants ¶
This section is empty.
Variables ¶
var ( ErrInvalidLengthMysqlxNotice = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowMysqlxNotice = fmt.Errorf("proto: integer overflow") )
var Frame_Scope_name = map[int32]string{
1: "GLOBAL",
2: "LOCAL",
}
var Frame_Scope_value = map[string]int32{
"GLOBAL": 1,
"LOCAL": 2,
}
var SessionStateChanged_Parameter_name = map[int32]string{
1: "CURRENT_SCHEMA",
2: "ACCOUNT_EXPIRED",
3: "GENERATED_INSERT_ID",
4: "ROWS_AFFECTED",
5: "ROWS_FOUND",
6: "ROWS_MATCHED",
7: "TRX_COMMITTED",
9: "TRX_ROLLEDBACK",
10: "PRODUCED_MESSAGE",
11: "CLIENT_ID_ASSIGNED",
}
var SessionStateChanged_Parameter_value = map[string]int32{
"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,
}
var Warning_Level_name = map[int32]string{
1: "NOTE",
2: "WARNING",
3: "ERROR",
}
var Warning_Level_value = map[string]int32{
"NOTE": 1,
"WARNING": 2,
"ERROR": 3,
}
Functions ¶
This section is empty.
Types ¶
type Frame ¶
type Frame struct { Type *uint32 `protobuf:"varint,1,req,name=type" json:"type,omitempty"` Scope *Frame_Scope `protobuf:"varint,2,opt,name=scope,enum=Mysqlx.Notice.Frame_Scope,def=1" json:"scope,omitempty"` Payload []byte `protobuf:"bytes,3,opt,name=payload" json:"payload,omitempty"` XXX_unrecognized []byte `json:"-"` }
Common Frame for all Notices
===================================================== ===== .type value ===================================================== ===== :protobuf:msg:`Mysqlx.Notice::Warning` 1 :protobuf:msg:`Mysqlx.Notice::SessionVariableChanged` 2 :protobuf:msg:`Mysqlx.Notice::SessionStateChanged` 3 ===================================================== =====
:param type: the type of the payload :param payload: the payload of the notification :param scope: global or local notification
func (*Frame) Descriptor ¶
func (*Frame) GetPayload ¶
func (*Frame) GetScope ¶
func (m *Frame) GetScope() Frame_Scope
func (*Frame) ProtoMessage ¶
func (*Frame) ProtoMessage()
type Frame_Scope ¶
type Frame_Scope int32
const ( Frame_GLOBAL Frame_Scope = 1 Frame_LOCAL Frame_Scope = 2 )
const Default_Frame_Scope Frame_Scope = Frame_GLOBAL
func (Frame_Scope) Enum ¶
func (x Frame_Scope) Enum() *Frame_Scope
func (Frame_Scope) EnumDescriptor ¶
func (Frame_Scope) EnumDescriptor() ([]byte, []int)
func (Frame_Scope) String ¶
func (x Frame_Scope) String() string
func (*Frame_Scope) UnmarshalJSON ¶
func (x *Frame_Scope) UnmarshalJSON(data []byte) error
type SessionStateChanged ¶
type SessionStateChanged struct { Param *SessionStateChanged_Parameter `protobuf:"varint,1,req,name=param,enum=Mysqlx.Notice.SessionStateChanged_Parameter" json:"param,omitempty"` Value *Mysqlx_Datatypes.Scalar `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"` XXX_unrecognized []byte `json:"-"` }
Notify clients about changes to the internal session state
========================================== ========= :protobuf:msg:`Mysqlx.Notice::Frame` field value ========================================== ========= “.type“ 3 “.scope“ “local“ ========================================== =========
:param param: parameter key :param value: updated value
func (*SessionStateChanged) Descriptor ¶
func (*SessionStateChanged) Descriptor() ([]byte, []int)
func (*SessionStateChanged) GetParam ¶
func (m *SessionStateChanged) GetParam() SessionStateChanged_Parameter
func (*SessionStateChanged) GetValue ¶
func (m *SessionStateChanged) GetValue() *Mysqlx_Datatypes.Scalar
func (*SessionStateChanged) Marshal ¶
func (m *SessionStateChanged) Marshal() (dAtA []byte, err error)
func (*SessionStateChanged) MarshalTo ¶
func (m *SessionStateChanged) MarshalTo(dAtA []byte) (int, error)
func (*SessionStateChanged) ProtoMessage ¶
func (*SessionStateChanged) ProtoMessage()
func (*SessionStateChanged) Reset ¶
func (m *SessionStateChanged) Reset()
func (*SessionStateChanged) Size ¶
func (m *SessionStateChanged) Size() (n int)
func (*SessionStateChanged) String ¶
func (m *SessionStateChanged) String() string
func (*SessionStateChanged) Unmarshal ¶
func (m *SessionStateChanged) Unmarshal(dAtA []byte) error
type SessionStateChanged_Parameter ¶
type SessionStateChanged_Parameter int32
const ( SessionStateChanged_CURRENT_SCHEMA SessionStateChanged_Parameter = 1 SessionStateChanged_ACCOUNT_EXPIRED SessionStateChanged_Parameter = 2 SessionStateChanged_GENERATED_INSERT_ID SessionStateChanged_Parameter = 3 SessionStateChanged_ROWS_AFFECTED SessionStateChanged_Parameter = 4 SessionStateChanged_ROWS_FOUND SessionStateChanged_Parameter = 5 SessionStateChanged_ROWS_MATCHED SessionStateChanged_Parameter = 6 SessionStateChanged_TRX_COMMITTED SessionStateChanged_Parameter = 7 SessionStateChanged_TRX_ROLLEDBACK SessionStateChanged_Parameter = 9 SessionStateChanged_PRODUCED_MESSAGE SessionStateChanged_Parameter = 10 SessionStateChanged_CLIENT_ID_ASSIGNED SessionStateChanged_Parameter = 11 )
func (SessionStateChanged_Parameter) Enum ¶
func (x SessionStateChanged_Parameter) Enum() *SessionStateChanged_Parameter
func (SessionStateChanged_Parameter) EnumDescriptor ¶
func (SessionStateChanged_Parameter) EnumDescriptor() ([]byte, []int)
func (SessionStateChanged_Parameter) String ¶
func (x SessionStateChanged_Parameter) String() string
func (*SessionStateChanged_Parameter) UnmarshalJSON ¶
func (x *SessionStateChanged_Parameter) UnmarshalJSON(data []byte) error
type SessionVariableChanged ¶
type SessionVariableChanged struct { Param *string `protobuf:"bytes,1,req,name=param" json:"param,omitempty"` Value *Mysqlx_Datatypes.Scalar `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"` XXX_unrecognized []byte `json:"-"` }
Notify clients about changes to the current session variables
Every change to a variable that is accessable through:
.. code-block:: sql
SHOW SESSION VARIABLES
========================================== ========= :protobuf:msg:`Mysqlx.Notice::Frame` field value ========================================== ========= “.type“ 2 “.scope“ “local“ ========================================== =========
:param namespace: namespace that param belongs to :param param: name of the variable :param value: the changed value of param
func (*SessionVariableChanged) Descriptor ¶
func (*SessionVariableChanged) Descriptor() ([]byte, []int)
func (*SessionVariableChanged) GetParam ¶
func (m *SessionVariableChanged) GetParam() string
func (*SessionVariableChanged) GetValue ¶
func (m *SessionVariableChanged) GetValue() *Mysqlx_Datatypes.Scalar
func (*SessionVariableChanged) Marshal ¶
func (m *SessionVariableChanged) Marshal() (dAtA []byte, err error)
func (*SessionVariableChanged) MarshalTo ¶
func (m *SessionVariableChanged) MarshalTo(dAtA []byte) (int, error)
func (*SessionVariableChanged) ProtoMessage ¶
func (*SessionVariableChanged) ProtoMessage()
func (*SessionVariableChanged) Reset ¶
func (m *SessionVariableChanged) Reset()
func (*SessionVariableChanged) Size ¶
func (m *SessionVariableChanged) Size() (n int)
func (*SessionVariableChanged) String ¶
func (m *SessionVariableChanged) String() string
func (*SessionVariableChanged) Unmarshal ¶
func (m *SessionVariableChanged) Unmarshal(dAtA []byte) error
type Warning ¶
type Warning struct { Level *Warning_Level `protobuf:"varint,1,opt,name=level,enum=Mysqlx.Notice.Warning_Level,def=2" json:"level,omitempty"` Code *uint32 `protobuf:"varint,2,req,name=code" json:"code,omitempty"` Msg *string `protobuf:"bytes,3,req,name=msg" json:"msg,omitempty"` XXX_unrecognized []byte `json:"-"` }
Server-side warnings and notes
“.scope“ == “local“
``.level``, ``.code`` and ``.msg`` map the content of .. code-block:: sql SHOW WARNINGS
“.scope“ == “global“
(undefined) will be used for global, unstructured messages like: * server is shutting down * a node disconnected from group * schema or table dropped
========================================== ======================= :protobuf:msg:`Mysqlx.Notice::Frame` field value ========================================== ======================= “.type“ 1 “.scope“ “local“ or “global“ ========================================== =======================
:param level: warning level: Note or Warning :param code: warning code :param msg: warning message
func (*Warning) Descriptor ¶
func (*Warning) GetLevel ¶
func (m *Warning) GetLevel() Warning_Level
func (*Warning) ProtoMessage ¶
func (*Warning) ProtoMessage()
type Warning_Level ¶
type Warning_Level int32
const ( Warning_NOTE Warning_Level = 1 Warning_WARNING Warning_Level = 2 Warning_ERROR Warning_Level = 3 )
const Default_Warning_Level Warning_Level = Warning_WARNING
func (Warning_Level) Enum ¶
func (x Warning_Level) Enum() *Warning_Level
func (Warning_Level) EnumDescriptor ¶
func (Warning_Level) EnumDescriptor() ([]byte, []int)
func (Warning_Level) String ¶
func (x Warning_Level) String() string
func (*Warning_Level) UnmarshalJSON ¶
func (x *Warning_Level) UnmarshalJSON(data []byte) error