mysqlx

Documentation

Overview

Package mysqlx is a generated protocol buffer package.

It is generated from these files:

mysqlx.proto

It has these top-level messages:

ClientMessages
ServerMessages
Ok
Error

Index

• Variables
• type ClientMessages
  • func (*ClientMessages) Descriptor() ([]byte, []int)
  • func (*ClientMessages) ProtoMessage()
  • func (m *ClientMessages) Reset()
  • func (m *ClientMessages) String() string
• type ClientMessages_Type
  • func (x ClientMessages_Type) Enum() *ClientMessages_Type
  • func (ClientMessages_Type) EnumDescriptor() ([]byte, []int)
  • func (x ClientMessages_Type) String() string
  • func (x *ClientMessages_Type) UnmarshalJSON(data []byte) error
• type Error
  • func (*Error) Descriptor() ([]byte, []int)
  • func (m *Error) GetCode() uint32
  • func (m *Error) GetMsg() string
  • func (m *Error) GetSeverity() Error_Severity
  • func (m *Error) GetSqlState() string
  • func (*Error) ProtoMessage()
  • func (m *Error) Reset()
  • func (m *Error) String() string
• type Error_Severity
  • func (x Error_Severity) Enum() *Error_Severity
  • func (Error_Severity) EnumDescriptor() ([]byte, []int)
  • func (x Error_Severity) String() string
  • func (x *Error_Severity) UnmarshalJSON(data []byte) error
• type Ok
  • func (*Ok) Descriptor() ([]byte, []int)
  • func (m *Ok) GetMsg() string
  • func (*Ok) ProtoMessage()
  • func (m *Ok) Reset()
  • func (m *Ok) String() string
• type ServerMessages
  • func (*ServerMessages) Descriptor() ([]byte, []int)
  • func (*ServerMessages) ProtoMessage()
  • func (m *ServerMessages) Reset()
  • func (m *ServerMessages) String() string
• type ServerMessages_Type
  • func (x ServerMessages_Type) Enum() *ServerMessages_Type
  • func (ServerMessages_Type) EnumDescriptor() ([]byte, []int)
  • func (x ServerMessages_Type) String() string
  • func (x *ServerMessages_Type) UnmarshalJSON(data []byte) error

Variables

var ClientMessages_Type_name = map[int32]string{
	1:  "CON_CAPABILITIES_GET",
	2:  "CON_CAPABILITIES_SET",
	3:  "CON_CLOSE",
	4:  "SESS_AUTHENTICATE_START",
	5:  "SESS_AUTHENTICATE_CONTINUE",
	6:  "SESS_RESET",
	7:  "SESS_CLOSE",
	12: "SQL_STMT_EXECUTE",
	17: "CRUD_FIND",
	18: "CRUD_INSERT",
	19: "CRUD_UPDATE",
	20: "CRUD_DELETE",
	24: "EXPECT_OPEN",
	25: "EXPECT_CLOSE",
	30: "CRUD_CREATE_VIEW",
	31: "CRUD_MODIFY_VIEW",
	32: "CRUD_DROP_VIEW",
}

var ClientMessages_Type_value = map[string]int32{
	"CON_CAPABILITIES_GET":       1,
	"CON_CAPABILITIES_SET":       2,
	"CON_CLOSE":                  3,
	"SESS_AUTHENTICATE_START":    4,
	"SESS_AUTHENTICATE_CONTINUE": 5,
	"SESS_RESET":                 6,
	"SESS_CLOSE":                 7,
	"SQL_STMT_EXECUTE":           12,
	"CRUD_FIND":                  17,
	"CRUD_INSERT":                18,
	"CRUD_UPDATE":                19,
	"CRUD_DELETE":                20,
	"EXPECT_OPEN":                24,
	"EXPECT_CLOSE":               25,
	"CRUD_CREATE_VIEW":           30,
	"CRUD_MODIFY_VIEW":           31,
	"CRUD_DROP_VIEW":             32,
}

var E_ClientMessageId = &proto.ExtensionDesc{
	ExtendedType:  (*google_protobuf.MessageOptions)(nil),
	ExtensionType: (*ClientMessages_Type)(nil),
	Field:         100001,
	Name:          "Mysqlx.client_message_id",
	Tag:           "varint,100001,opt,name=client_message_id,json=clientMessageId,enum=Mysqlx.ClientMessages_Type",
	Filename:      "mysqlx.proto",
}

var E_ServerMessageId = &proto.ExtensionDesc{
	ExtendedType:  (*google_protobuf.MessageOptions)(nil),
	ExtensionType: (*ServerMessages_Type)(nil),
	Field:         100002,
	Name:          "Mysqlx.server_message_id",
	Tag:           "varint,100002,opt,name=server_message_id,json=serverMessageId,enum=Mysqlx.ServerMessages_Type",
	Filename:      "mysqlx.proto",
}

var Error_Severity_name = map[int32]string{
	0: "ERROR",
	1: "FATAL",
}

var Error_Severity_value = map[string]int32{
	"ERROR": 0,
	"FATAL": 1,
}

var ServerMessages_Type_name = map[int32]string{
	0:  "OK",
	1:  "ERROR",
	2:  "CONN_CAPABILITIES",
	3:  "SESS_AUTHENTICATE_CONTINUE",
	4:  "SESS_AUTHENTICATE_OK",
	11: "NOTICE",
	12: "RESULTSET_COLUMN_META_DATA",
	13: "RESULTSET_ROW",
	14: "RESULTSET_FETCH_DONE",
	15: "RESULTSET_FETCH_SUSPENDED",
	16: "RESULTSET_FETCH_DONE_MORE_RESULTSETS",
	17: "SQL_STMT_EXECUTE_OK",
	18: "RESULTSET_FETCH_DONE_MORE_OUT_PARAMS",
}

var ServerMessages_Type_value = map[string]int32{
	"OK":                                   0,
	"ERROR":                                1,
	"CONN_CAPABILITIES":                    2,
	"SESS_AUTHENTICATE_CONTINUE":           3,
	"SESS_AUTHENTICATE_OK":                 4,
	"NOTICE":                               11,
	"RESULTSET_COLUMN_META_DATA":           12,
	"RESULTSET_ROW":                        13,
	"RESULTSET_FETCH_DONE":                 14,
	"RESULTSET_FETCH_SUSPENDED":            15,
	"RESULTSET_FETCH_DONE_MORE_RESULTSETS": 16,
	"SQL_STMT_EXECUTE_OK":                  17,
	"RESULTSET_FETCH_DONE_MORE_OUT_PARAMS": 18,
}

Types

type ClientMessages

type ClientMessages struct {
	XXX_unrecognized []byte `json:"-"`
}

IDs of messages that can be sent from client to the server

.. note::

this message is never sent on the wire. It is only used to let ``protoc``

* generate constants
* check for uniqueness

func (*ClientMessages) Descriptor

func (*ClientMessages) Descriptor() ([]byte, []int)

func (*ClientMessages) ProtoMessage

func (*ClientMessages) ProtoMessage()

func (*ClientMessages) Reset

func (m *ClientMessages) Reset()

func (*ClientMessages) String

func (m *ClientMessages) String() string

type ClientMessages_Type

type ClientMessages_Type int32

const (
	ClientMessages_CON_CAPABILITIES_GET       ClientMessages_Type = 1
	ClientMessages_CON_CAPABILITIES_SET       ClientMessages_Type = 2
	ClientMessages_CON_CLOSE                  ClientMessages_Type = 3
	ClientMessages_SESS_AUTHENTICATE_START    ClientMessages_Type = 4
	ClientMessages_SESS_AUTHENTICATE_CONTINUE ClientMessages_Type = 5
	ClientMessages_SESS_RESET                 ClientMessages_Type = 6
	ClientMessages_SESS_CLOSE                 ClientMessages_Type = 7
	ClientMessages_SQL_STMT_EXECUTE           ClientMessages_Type = 12
	ClientMessages_CRUD_FIND                  ClientMessages_Type = 17
	ClientMessages_CRUD_INSERT                ClientMessages_Type = 18
	ClientMessages_CRUD_UPDATE                ClientMessages_Type = 19
	ClientMessages_CRUD_DELETE                ClientMessages_Type = 20
	ClientMessages_EXPECT_OPEN                ClientMessages_Type = 24
	ClientMessages_EXPECT_CLOSE               ClientMessages_Type = 25
	ClientMessages_CRUD_CREATE_VIEW           ClientMessages_Type = 30
	ClientMessages_CRUD_MODIFY_VIEW           ClientMessages_Type = 31
	ClientMessages_CRUD_DROP_VIEW             ClientMessages_Type = 32
)

func (ClientMessages_Type) Enum

func (x ClientMessages_Type) Enum() *ClientMessages_Type

func (ClientMessages_Type) EnumDescriptor

func (ClientMessages_Type) EnumDescriptor() ([]byte, []int)

func (ClientMessages_Type) String

func (x ClientMessages_Type) String() string

func (*ClientMessages_Type) UnmarshalJSON

func (x *ClientMessages_Type) UnmarshalJSON(data []byte) error

type Error

type Error struct {
	Severity         *Error_Severity `protobuf:"varint,1,opt,name=severity,enum=Mysqlx.Error_Severity,def=0" json:"severity,omitempty"`
	Code             *uint32         `protobuf:"varint,2,req,name=code" json:"code,omitempty"`
	SqlState         *string         `protobuf:"bytes,4,req,name=sql_state,json=sqlState" json:"sql_state,omitempty"`
	Msg              *string         `protobuf:"bytes,3,req,name=msg" json:"msg,omitempty"`
	XXX_unrecognized []byte          `json:"-"`
}

generic Error message

A “severity“ of “ERROR“ indicates the current message sequence is aborted for the given error and the session is ready for more.

In case of a “FATAL“ error message the client should not expect the server to continue handling any further messages and should close the connection.

:param severity: severity of the error message :param code: error-code :param sql_state: SQL state :param msg: human readable error message

func (*Error) Descriptor

func (*Error) Descriptor() ([]byte, []int)

func (*Error) GetCode

func (m *Error) GetCode() uint32

func (*Error) GetMsg

func (m *Error) GetMsg() string

func (*Error) GetSeverity

func (m *Error) GetSeverity() Error_Severity

func (*Error) GetSqlState

func (m *Error) GetSqlState() string

func (*Error) ProtoMessage

func (*Error) ProtoMessage()

func (*Error) Reset

func (m *Error) Reset()

func (*Error) String

func (m *Error) String() string

type Error_Severity

type Error_Severity int32

const (
	Error_ERROR Error_Severity = 0
	Error_FATAL Error_Severity = 1
)

const Default_Error_Severity Error_Severity = Error_ERROR

func (Error_Severity) Enum

func (x Error_Severity) Enum() *Error_Severity

func (Error_Severity) EnumDescriptor

func (Error_Severity) EnumDescriptor() ([]byte, []int)

func (Error_Severity) String

func (x Error_Severity) String() string

func (*Error_Severity) UnmarshalJSON

func (x *Error_Severity) UnmarshalJSON(data []byte) error

type Ok

type Ok struct {
	Msg              *string `protobuf:"bytes,1,opt,name=msg" json:"msg,omitempty"`
	XXX_unrecognized []byte  `json:"-"`
}

generic Ok message

func (*Ok) Descriptor

func (*Ok) Descriptor() ([]byte, []int)

func (*Ok) GetMsg

func (m *Ok) GetMsg() string

func (*Ok) ProtoMessage

func (*Ok) ProtoMessage()

func (*Ok) Reset

func (m *Ok) Reset()

func (*Ok) String

func (m *Ok) String() string

type ServerMessages

type ServerMessages struct {
	XXX_unrecognized []byte `json:"-"`
}

IDs of messages that can be sent from server to client

.. note::

this message is never sent on the wire. It is only used to let ``protoc``

* generate constants
* check for uniqueness

func (*ServerMessages) Descriptor

func (*ServerMessages) Descriptor() ([]byte, []int)

func (*ServerMessages) ProtoMessage

func (*ServerMessages) ProtoMessage()

func (*ServerMessages) Reset

func (m *ServerMessages) Reset()

func (*ServerMessages) String

func (m *ServerMessages) String() string

type ServerMessages_Type

type ServerMessages_Type int32

const (
	ServerMessages_OK                         ServerMessages_Type = 0
	ServerMessages_ERROR                      ServerMessages_Type = 1
	ServerMessages_CONN_CAPABILITIES          ServerMessages_Type = 2
	ServerMessages_SESS_AUTHENTICATE_CONTINUE ServerMessages_Type = 3
	ServerMessages_SESS_AUTHENTICATE_OK       ServerMessages_Type = 4
	// NOTICE has to stay at 11 forever
	ServerMessages_NOTICE                               ServerMessages_Type = 11
	ServerMessages_RESULTSET_COLUMN_META_DATA           ServerMessages_Type = 12
	ServerMessages_RESULTSET_ROW                        ServerMessages_Type = 13
	ServerMessages_RESULTSET_FETCH_DONE                 ServerMessages_Type = 14
	ServerMessages_RESULTSET_FETCH_SUSPENDED            ServerMessages_Type = 15
	ServerMessages_RESULTSET_FETCH_DONE_MORE_RESULTSETS ServerMessages_Type = 16
	ServerMessages_SQL_STMT_EXECUTE_OK                  ServerMessages_Type = 17
	ServerMessages_RESULTSET_FETCH_DONE_MORE_OUT_PARAMS ServerMessages_Type = 18
)

func (ServerMessages_Type) Enum

func (x ServerMessages_Type) Enum() *ServerMessages_Type

func (ServerMessages_Type) EnumDescriptor

func (ServerMessages_Type) EnumDescriptor() ([]byte, []int)

func (ServerMessages_Type) String

func (x ServerMessages_Type) String() string

func (*ServerMessages_Type) UnmarshalJSON

func (x *ServerMessages_Type) UnmarshalJSON(data []byte) error