Mysqlx_Session

Documentation

Overview

Package Mysqlx_Session is a generated protocol buffer package.

Messages to manage Sessions

.. uml::

== session start ==
Client -> Server: AuthenticateStart
opt
Server --> Client: AuthenticateContinue
Client --> Server: AuthenticateContinue
end
alt
Server --> Client: AuthenticateOk
else
Server --> Client: Error
end
...
== session reset ==
Client -> Server: Reset
Server --> Client: Ok
== session end ==
Client -> Server: Close
Server --> Client: Ok

It is generated from these files:

github.com/pingcap/tipb/go-mysqlx/Session/mysqlx_session.proto

It has these top-level messages:

AuthenticateStart
AuthenticateContinue
AuthenticateOk
Reset
Close

Index

• Variables
• type AuthenticateContinue
  • func (*AuthenticateContinue) Descriptor() ([]byte, []int)
  • func (m *AuthenticateContinue) GetAuthData() []byte
  • func (m *AuthenticateContinue) Marshal() (dAtA []byte, err error)
  • func (m *AuthenticateContinue) MarshalTo(dAtA []byte) (int, error)
  • func (*AuthenticateContinue) ProtoMessage()
  • func (m *AuthenticateContinue) Reset()
  • func (m *AuthenticateContinue) Size() (n int)
  • func (m *AuthenticateContinue) String() string
  • func (m *AuthenticateContinue) Unmarshal(dAtA []byte) error
• type AuthenticateOk
  • func (*AuthenticateOk) Descriptor() ([]byte, []int)
  • func (m *AuthenticateOk) GetAuthData() []byte
  • func (m *AuthenticateOk) Marshal() (dAtA []byte, err error)
  • func (m *AuthenticateOk) MarshalTo(dAtA []byte) (int, error)
  • func (*AuthenticateOk) ProtoMessage()
  • func (m *AuthenticateOk) Reset()
  • func (m *AuthenticateOk) Size() (n int)
  • func (m *AuthenticateOk) String() string
  • func (m *AuthenticateOk) Unmarshal(dAtA []byte) error
• type AuthenticateStart
  • func (*AuthenticateStart) Descriptor() ([]byte, []int)
  • func (m *AuthenticateStart) GetAuthData() []byte
  • func (m *AuthenticateStart) GetInitialResponse() []byte
  • func (m *AuthenticateStart) GetMechName() string
  • func (m *AuthenticateStart) Marshal() (dAtA []byte, err error)
  • func (m *AuthenticateStart) MarshalTo(dAtA []byte) (int, error)
  • func (*AuthenticateStart) ProtoMessage()
  • func (m *AuthenticateStart) Reset()
  • func (m *AuthenticateStart) Size() (n int)
  • func (m *AuthenticateStart) String() string
  • func (m *AuthenticateStart) Unmarshal(dAtA []byte) error
• type Close
  • func (*Close) Descriptor() ([]byte, []int)
  • func (m *Close) Marshal() (dAtA []byte, err error)
  • func (m *Close) MarshalTo(dAtA []byte) (int, error)
  • func (*Close) ProtoMessage()
  • func (m *Close) Reset()
  • func (m *Close) Size() (n int)
  • func (m *Close) String() string
  • func (m *Close) Unmarshal(dAtA []byte) error
• type Reset
  • func (*Reset) Descriptor() ([]byte, []int)
  • func (m *Reset) Marshal() (dAtA []byte, err error)
  • func (m *Reset) MarshalTo(dAtA []byte) (int, error)
  • func (*Reset) ProtoMessage()
  • func (m *Reset) Reset()
  • func (m *Reset) Size() (n int)
  • func (m *Reset) String() string
  • func (m *Reset) Unmarshal(dAtA []byte) error

Variables

var (
	ErrInvalidLengthMysqlxSession = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowMysqlxSession   = fmt.Errorf("proto: integer overflow")
)

Types

type AuthenticateContinue

type AuthenticateContinue struct {
	AuthData         []byte `protobuf:"bytes,1,req,name=auth_data,json=authData" json:"auth_data,omitempty"`
	XXX_unrecognized []byte `json:"-"`
}

send by client or server after a :protobuf:msg:`Mysqlx.Session::AuthenticateStart` to exchange more auth data

:param auth_data: authentication data :Returns: :protobuf:msg:`Mysqlx.Session::AuthenticateContinue`

func (*AuthenticateContinue) Descriptor

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

func (*AuthenticateContinue) GetAuthData

func (m *AuthenticateContinue) GetAuthData() []byte

func (*AuthenticateContinue) Marshal

func (m *AuthenticateContinue) Marshal() (dAtA []byte, err error)

func (*AuthenticateContinue) MarshalTo

func (m *AuthenticateContinue) MarshalTo(dAtA []byte) (int, error)

func (*AuthenticateContinue) ProtoMessage

func (*AuthenticateContinue) ProtoMessage()

func (*AuthenticateContinue) Reset

func (m *AuthenticateContinue) Reset()

func (*AuthenticateContinue) Size

func (m *AuthenticateContinue) Size() (n int)

func (*AuthenticateContinue) String

func (m *AuthenticateContinue) String() string

func (*AuthenticateContinue) Unmarshal

func (m *AuthenticateContinue) Unmarshal(dAtA []byte) error

type AuthenticateOk

type AuthenticateOk struct {
	AuthData         []byte `protobuf:"bytes,1,opt,name=auth_data,json=authData" json:"auth_data,omitempty"`
	XXX_unrecognized []byte `json:"-"`
}

sent by the server after successful authentication

:param auth_data: authentication data

func (*AuthenticateOk) Descriptor

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

func (*AuthenticateOk) GetAuthData

func (m *AuthenticateOk) GetAuthData() []byte

func (*AuthenticateOk) Marshal

func (m *AuthenticateOk) Marshal() (dAtA []byte, err error)

func (*AuthenticateOk) MarshalTo

func (m *AuthenticateOk) MarshalTo(dAtA []byte) (int, error)

func (*AuthenticateOk) ProtoMessage

func (*AuthenticateOk) ProtoMessage()

func (*AuthenticateOk) Reset

func (m *AuthenticateOk) Reset()

func (*AuthenticateOk) Size

func (m *AuthenticateOk) Size() (n int)

func (*AuthenticateOk) String

func (m *AuthenticateOk) String() string

func (*AuthenticateOk) Unmarshal

func (m *AuthenticateOk) Unmarshal(dAtA []byte) error

type AuthenticateStart

type AuthenticateStart struct {
	MechName         *string `protobuf:"bytes,1,req,name=mech_name,json=mechName" json:"mech_name,omitempty"`
	AuthData         []byte  `protobuf:"bytes,2,opt,name=auth_data,json=authData" json:"auth_data,omitempty"`
	InitialResponse  []byte  `protobuf:"bytes,3,opt,name=initial_response,json=initialResponse" json:"initial_response,omitempty"`
	XXX_unrecognized []byte  `json:"-"`
}

the initial message send from the client to the server to start the authentication proccess

:param mech_name: authentication mechanism name :param auth_data: authentication data :param initial_response: initial response :Returns: :protobuf:msg:`Mysqlx.Session::AuthenticateContinue`

func (*AuthenticateStart) Descriptor

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

func (*AuthenticateStart) GetAuthData

func (m *AuthenticateStart) GetAuthData() []byte

func (*AuthenticateStart) GetInitialResponse

func (m *AuthenticateStart) GetInitialResponse() []byte

func (*AuthenticateStart) GetMechName

func (m *AuthenticateStart) GetMechName() string

func (*AuthenticateStart) Marshal

func (m *AuthenticateStart) Marshal() (dAtA []byte, err error)

func (*AuthenticateStart) MarshalTo

func (m *AuthenticateStart) MarshalTo(dAtA []byte) (int, error)

func (*AuthenticateStart) ProtoMessage

func (*AuthenticateStart) ProtoMessage()

func (*AuthenticateStart) Reset

func (m *AuthenticateStart) Reset()

func (*AuthenticateStart) Size

func (m *AuthenticateStart) Size() (n int)

func (*AuthenticateStart) String

func (m *AuthenticateStart) String() string

func (*AuthenticateStart) Unmarshal

func (m *AuthenticateStart) Unmarshal(dAtA []byte) error

type Close

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

close the current session

:Returns: :protobuf:msg:`Mysqlx::Ok`

func (*Close) Descriptor

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

func (*Close) Marshal

func (m *Close) Marshal() (dAtA []byte, err error)

func (*Close) MarshalTo

func (m *Close) MarshalTo(dAtA []byte) (int, error)

func (*Close) ProtoMessage

func (*Close) ProtoMessage()

func (*Close) Reset

func (m *Close) Reset()

func (*Close) Size

func (m *Close) Size() (n int)

func (*Close) String

func (m *Close) String() string

func (*Close) Unmarshal

func (m *Close) Unmarshal(dAtA []byte) error

type Reset

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

reset the current session

:Returns: :protobuf:msg:`Mysqlx::Ok`

func (*Reset) Descriptor

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

func (*Reset) Marshal

func (m *Reset) Marshal() (dAtA []byte, err error)

func (*Reset) MarshalTo

func (m *Reset) MarshalTo(dAtA []byte) (int, error)

func (*Reset) ProtoMessage

func (*Reset) ProtoMessage()

func (*Reset) Reset

func (m *Reset) Reset()

func (*Reset) Size

func (m *Reset) Size() (n int)

func (*Reset) String

func (m *Reset) String() string

func (*Reset) Unmarshal

func (m *Reset) Unmarshal(dAtA []byte) error