mysqlxcursor

Documentation

Index

• Variables
• type Close
  • func (*Close) Descriptor() ([]byte, []int)
  • func (x *Close) GetCursorId() uint32
  • func (*Close) ProtoMessage()
  • func (x *Close) ProtoReflect() protoreflect.Message
  • func (x *Close) Reset()
  • func (x *Close) String() string
• type Fetch
  • func (*Fetch) Descriptor() ([]byte, []int)
  • func (x *Fetch) GetCursorId() uint32
  • func (x *Fetch) GetFetchRows() uint64
  • func (*Fetch) ProtoMessage()
  • func (x *Fetch) ProtoReflect() protoreflect.Message
  • func (x *Fetch) Reset()
  • func (x *Fetch) String() string
• type Open
  • func (*Open) Descriptor() ([]byte, []int)
  • func (x *Open) GetCursorId() uint32
  • func (x *Open) GetFetchRows() uint64
  • func (x *Open) GetStmt() *Open_OneOfMessage
  • func (*Open) ProtoMessage()
  • func (x *Open) ProtoReflect() protoreflect.Message
  • func (x *Open) Reset()
  • func (x *Open) String() string
• type Open_OneOfMessage
  • func (*Open_OneOfMessage) Descriptor() ([]byte, []int)
  • func (x *Open_OneOfMessage) GetPrepareExecute() *mysqlxprepare.Execute
  • func (x *Open_OneOfMessage) GetType() Open_OneOfMessage_Type
  • func (*Open_OneOfMessage) ProtoMessage()
  • func (x *Open_OneOfMessage) ProtoReflect() protoreflect.Message
  • func (x *Open_OneOfMessage) Reset()
  • func (x *Open_OneOfMessage) String() string
• type Open_OneOfMessage_Type
  • func (Open_OneOfMessage_Type) Descriptor() protoreflect.EnumDescriptor
  • func (x Open_OneOfMessage_Type) Enum() *Open_OneOfMessage_Type
  • func (Open_OneOfMessage_Type) EnumDescriptor() ([]byte, []int)
  • func (x Open_OneOfMessage_Type) Number() protoreflect.EnumNumber
  • func (x Open_OneOfMessage_Type) String() string
  • func (Open_OneOfMessage_Type) Type() protoreflect.EnumType
  • func (x *Open_OneOfMessage_Type) UnmarshalJSON(b []byte) error

Variables

var (
	Open_OneOfMessage_Type_name = map[int32]string{
		0: "PREPARE_EXECUTE",
	}
	Open_OneOfMessage_Type_value = map[string]int32{
		"PREPARE_EXECUTE": 0,
	}
)

Enum value maps for Open_OneOfMessage_Type.

var File_mysqlx_cursor_proto protoreflect.FileDescriptor

Types

type Close

type Close struct {

	// * client-side assigned cursor ID; must be allocated/open
	CursorId *uint32 `protobuf:"varint,1,req,name=cursor_id,json=cursorId" json:"cursor_id,omitempty"`
	// contains filtered or unexported fields
}

* Close cursor

@startuml client -> server: Close alt Success client <- server: Ok else Failure client <- server: Error end @enduml

@returns @ref Mysqlx::Ok or @ref Mysqlx::Error

func (*Close) Descriptor

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

Deprecated: Use Close.ProtoReflect.Descriptor instead.

func (*Close) GetCursorId

func (x *Close) GetCursorId() uint32

func (*Close) ProtoMessage

func (*Close) ProtoMessage()

func (*Close) ProtoReflect

func (x *Close) ProtoReflect() protoreflect.Message

func (*Close) Reset

func (x *Close) Reset()

func (*Close) String

func (x *Close) String() string

type Fetch

type Fetch struct {

	// * client-side assigned cursor ID; must be already open
	CursorId *uint32 `protobuf:"varint,1,req,name=cursor_id,json=cursorId" json:"cursor_id,omitempty"`
	// * number of rows that should be retrieved from sequential cursor
	FetchRows *uint64 `protobuf:"varint,5,opt,name=fetch_rows,json=fetchRows" json:"fetch_rows,omitempty"`
	// contains filtered or unexported fields
}

* Fetch next portion of data from a cursor

@startuml client -> server: Fetch alt Success ... none or partial Resultsets or full Resultsets ... client <- server: StmtExecuteOk else client <- server: Error end @enduml

func (*Fetch) Descriptor

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

Deprecated: Use Fetch.ProtoReflect.Descriptor instead.

func (*Fetch) GetCursorId

func (x *Fetch) GetCursorId() uint32

func (*Fetch) GetFetchRows

func (x *Fetch) GetFetchRows() uint64

func (*Fetch) ProtoMessage

func (*Fetch) ProtoMessage()

func (*Fetch) ProtoReflect

func (x *Fetch) ProtoReflect() protoreflect.Message

func (*Fetch) Reset

func (x *Fetch) Reset()

func (*Fetch) String

func (x *Fetch) String() string

type Open

type Open struct {

	// * client-side assigned cursor ID; the ID is going to represent
	// the new cursor and assigned to it the statement
	CursorId *uint32 `protobuf:"varint,1,req,name=cursor_id,json=cursorId" json:"cursor_id,omitempty"`
	// * statement for which the resultset is going to be iterated through by the cursor
	Stmt *Open_OneOfMessage `protobuf:"bytes,4,req,name=stmt" json:"stmt,omitempty"`
	// * number of rows that should be retrieved from sequential cursor
	FetchRows *uint64 `protobuf:"varint,5,opt,name=fetch_rows,json=fetchRows" json:"fetch_rows,omitempty"`
	// contains filtered or unexported fields
}

* Open a cursor

@startuml client -> server: Open alt Success ... none or partial Resultsets or full Resultsets ... client <- server: StmtExecuteOk else Failure client <- server: Error end alt @enduml

@returns @ref Mysqlx::Ok

func (*Open) Descriptor

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

Deprecated: Use Open.ProtoReflect.Descriptor instead.

func (*Open) GetCursorId

func (x *Open) GetCursorId() uint32

func (*Open) GetFetchRows

func (x *Open) GetFetchRows() uint64

func (*Open) GetStmt

func (x *Open) GetStmt() *Open_OneOfMessage

func (*Open) ProtoMessage

func (*Open) ProtoMessage()

func (*Open) ProtoReflect

func (x *Open) ProtoReflect() protoreflect.Message

func (*Open) Reset

func (x *Open) Reset()

func (*Open) String

func (x *Open) String() string

type Open_OneOfMessage

type Open_OneOfMessage struct {
	Type           *Open_OneOfMessage_Type `protobuf:"varint,1,req,name=type,enum=Mysqlx.Cursor.Open_OneOfMessage_Type" json:"type,omitempty"`
	PrepareExecute *mysqlxprepare.Execute  `protobuf:"bytes,2,opt,name=prepare_execute,json=prepareExecute" json:"prepare_execute,omitempty"`
	// contains filtered or unexported fields
}

func (*Open_OneOfMessage) Descriptor

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

Deprecated: Use Open_OneOfMessage.ProtoReflect.Descriptor instead.

func (*Open_OneOfMessage) GetPrepareExecute

func (x *Open_OneOfMessage) GetPrepareExecute() *mysqlxprepare.Execute

func (*Open_OneOfMessage) GetType

func (x *Open_OneOfMessage) GetType() Open_OneOfMessage_Type

func (*Open_OneOfMessage) ProtoMessage

func (*Open_OneOfMessage) ProtoMessage()

func (*Open_OneOfMessage) ProtoReflect

func (x *Open_OneOfMessage) ProtoReflect() protoreflect.Message

func (*Open_OneOfMessage) Reset

func (x *Open_OneOfMessage) Reset()

func (*Open_OneOfMessage) String

func (x *Open_OneOfMessage) String() string

type Open_OneOfMessage_Type

type Open_OneOfMessage_Type int32

const (
	Open_OneOfMessage_PREPARE_EXECUTE Open_OneOfMessage_Type = 0
)

func (Open_OneOfMessage_Type) Descriptor

func (Open_OneOfMessage_Type) Descriptor() protoreflect.EnumDescriptor

func (Open_OneOfMessage_Type) Enum

func (x Open_OneOfMessage_Type) Enum() *Open_OneOfMessage_Type

func (Open_OneOfMessage_Type) EnumDescriptor

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

Deprecated: Use Open_OneOfMessage_Type.Descriptor instead.

func (Open_OneOfMessage_Type) Number

func (x Open_OneOfMessage_Type) Number() protoreflect.EnumNumber

func (Open_OneOfMessage_Type) String

func (x Open_OneOfMessage_Type) String() string

func (Open_OneOfMessage_Type) Type

func (Open_OneOfMessage_Type) Type() protoreflect.EnumType

func (*Open_OneOfMessage_Type) UnmarshalJSON

func (x *Open_OneOfMessage_Type) UnmarshalJSON(b []byte) error

Deprecated: Do not use.