package msgs

import "github.com/vertica/vertica-sql-go/msgs"

Index

Functions

func NewMsgBufferFromBytes

func NewMsgBufferFromBytes(b []byte) *msgBuffer

Types

type BEAuthenticationMsg

type BEAuthenticationMsg struct {
	Response      int32
	ExtraAuthData []byte
}

BEAuthenticationMsg docs

func (*BEAuthenticationMsg) CreateFromMsgBody

func (b *BEAuthenticationMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

CreateFromMsgBody docs

func (*BEAuthenticationMsg) String

func (b *BEAuthenticationMsg) String() string

type BEBindCompleteMsg

type BEBindCompleteMsg struct {
}

func (*BEBindCompleteMsg) CreateFromMsgBody

func (m *BEBindCompleteMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

CreateFromMsgBody

func (*BEBindCompleteMsg) String

func (m *BEBindCompleteMsg) String() string

type BECloseCompleteMsg

type BECloseCompleteMsg struct {
}

func (*BECloseCompleteMsg) CreateFromMsgBody

func (m *BECloseCompleteMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

CreateFromMsgBody

func (*BECloseCompleteMsg) String

func (m *BECloseCompleteMsg) String() string

type BECmdCompleteMsg

type BECmdCompleteMsg struct {
	Tag string
}

BECmdCompleteMsg docs

func (*BECmdCompleteMsg) CreateFromMsgBody

func (b *BECmdCompleteMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

CreateFromMsgBody docs

func (*BECmdCompleteMsg) String

func (b *BECmdCompleteMsg) String() string

type BECmdDescriptionMsg

type BECmdDescriptionMsg struct {
	CommandTag     string
	HasCopyRewrite bool
	CopyRewrite    string
}

func (*BECmdDescriptionMsg) CreateFromMsgBody

func (m *BECmdDescriptionMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

CreateFromMsgBody

func (*BECmdDescriptionMsg) String

func (m *BECmdDescriptionMsg) String() string

type BEDataRowMsg

type BEDataRowMsg []byte

BEDataRowMsg docs

func (*BEDataRowMsg) Columns

func (b *BEDataRowMsg) Columns() ColumnExtractor

Columns provides an extractor to begin reading columns

func (*BEDataRowMsg) CreateFromMsgBody

func (b *BEDataRowMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

CreateFromMsgBody docs

func (*BEDataRowMsg) RevertToBytes

func (b *BEDataRowMsg) RevertToBytes() []byte

RevertToBytes dumps the message back into plain bytes

func (*BEDataRowMsg) String

func (b *BEDataRowMsg) String() string

type BEEmptyQueryResponseMsg

type BEEmptyQueryResponseMsg struct {
}

func (*BEEmptyQueryResponseMsg) CreateFromMsgBody

func (m *BEEmptyQueryResponseMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

CreateFromMsgBody

func (*BEEmptyQueryResponseMsg) String

func (m *BEEmptyQueryResponseMsg) String() string

type BEErrorMsg

type BEErrorMsg struct {
	InternalQuery    string
	Severity         string
	Message          string
	SQLState         string
	Detail           string
	Hint             string
	Position         string
	Where            string
	InternalPosition string
	Routine          string
	File             string
	Line             string
	ErrorCode        string
}

BEErrorMsg docs

func (*BEErrorMsg) CreateFromMsgBody

func (b *BEErrorMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

CreateFromMsgBody docs

func (*BEErrorMsg) String

func (b *BEErrorMsg) String() string

type BEInitSTDINLoadMsg

type BEInitSTDINLoadMsg struct {
	IsBinary      bool
	ColumnFormats []int16
}

BEInitSTDINLoadMsg docs

func (*BEInitSTDINLoadMsg) CreateFromMsgBody

func (b *BEInitSTDINLoadMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

InitFromMsgBody docs

func (*BEInitSTDINLoadMsg) String

func (b *BEInitSTDINLoadMsg) String() string

type BEKeyDataMsg

type BEKeyDataMsg struct {
	BackendPID uint32
	CancelKey  uint32
}

func (*BEKeyDataMsg) CreateFromMsgBody

func (m *BEKeyDataMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

CreateFromMsgBody

func (*BEKeyDataMsg) String

func (m *BEKeyDataMsg) String() string

type BELoadBalanceMsg

type BELoadBalanceMsg struct {
	Port uint32
	Host string
}

func (*BELoadBalanceMsg) CreateFromMsgBody

func (m *BELoadBalanceMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

CreateFromMsgBody

func (*BELoadBalanceMsg) String

func (m *BELoadBalanceMsg) String() string

type BELoadNewFileMsg

type BELoadNewFileMsg struct {
	FileName string
}

func (*BELoadNewFileMsg) CreateFromMsgBody

func (m *BELoadNewFileMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

CreateFromMsgBody

func (*BELoadNewFileMsg) String

func (m *BELoadNewFileMsg) String() string

type BENoDataMsg

type BENoDataMsg struct {
}

func (*BENoDataMsg) CreateFromMsgBody

func (m *BENoDataMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

CreateFromMsgBody

func (*BENoDataMsg) String

func (m *BENoDataMsg) String() string

type BENoticeMsg

type BENoticeMsg struct {
	InternalQuery    string
	Severity         string
	Message          string
	SQLState         string
	Detail           string
	Hint             string
	Position         string
	Where            string
	InternalPosition string
	Routine          string
	File             string
	Line             string
	ErrorCode        string
}

BENoticeMsg docs

func (*BENoticeMsg) CreateFromMsgBody

func (b *BENoticeMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

CreateFromMsgBody docs

func (*BENoticeMsg) String

func (b *BENoticeMsg) String() string

type BEParamStatusMsg

type BEParamStatusMsg struct {
	ParamName  string
	ParamValue string
}

func (*BEParamStatusMsg) CreateFromMsgBody

func (m *BEParamStatusMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

CreateFromMsgBody

func (*BEParamStatusMsg) String

func (m *BEParamStatusMsg) String() string

type BEParameterDescMsg

type BEParameterDescMsg struct {
	ParameterTypes []common.ParameterType
}

func (*BEParameterDescMsg) CreateFromMsgBody

func (m *BEParameterDescMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

CreateFromMsgBody docs

func (*BEParameterDescMsg) String

func (m *BEParameterDescMsg) String() string

type BEParseCompleteMsg

type BEParseCompleteMsg struct {
}

func (*BEParseCompleteMsg) CreateFromMsgBody

func (m *BEParseCompleteMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

CreateFromMsgBody

func (*BEParseCompleteMsg) String

func (m *BEParseCompleteMsg) String() string

type BEPortalSuspendedMsg

type BEPortalSuspendedMsg struct {
	TransactionState byte
}

func (*BEPortalSuspendedMsg) CreateFromMsgBody

func (m *BEPortalSuspendedMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

CreateFromMsgBody

func (*BEPortalSuspendedMsg) String

func (m *BEPortalSuspendedMsg) String() string

type BEReadyForQueryMsg

type BEReadyForQueryMsg struct {
	TransactionState byte
}

func (*BEReadyForQueryMsg) CreateFromMsgBody

func (m *BEReadyForQueryMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

CreateFromMsgBody

func (*BEReadyForQueryMsg) String

func (m *BEReadyForQueryMsg) String() string

type BERowDescColumnDef

type BERowDescColumnDef struct {
	FieldName    string
	SchemaName   string
	TableName    string
	TableOID     int64
	Nullable     bool
	IsIdentity   bool
	AttribNum    int16
	DataTypeOID  uint32
	DataTypeName string
	Length       int16
	DataTypeMod  int32
	FormatCode   uint16
}

BERowDescColumnDef docs

type BERowDescMsg

type BERowDescMsg struct {
	Columns []*BERowDescColumnDef
}

BERowDescMsg docs

func (*BERowDescMsg) CreateFromMsgBody

func (m *BERowDescMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

CreateFromMsgBody docs

func (*BERowDescMsg) String

func (m *BERowDescMsg) String() string

type BEVerifyLoadFilesMsg

type BEVerifyLoadFilesMsg struct {
	FileList       []string
	RejectedPath   string
	ExceptionsPath string
}

func (*BEVerifyLoadFilesMsg) CreateFromMsgBody

func (m *BEVerifyLoadFilesMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

CreateFromMsgBody

func (*BEVerifyLoadFilesMsg) String

func (m *BEVerifyLoadFilesMsg) String() string

type BEWriteFileMsg

type BEWriteFileMsg struct {
	FileName string
	Data     []byte
}

func (*BEWriteFileMsg) CreateFromMsgBody

func (m *BEWriteFileMsg) CreateFromMsgBody(buf *msgBuffer) (BackEndMsg, error)

CreateFromMsgBody

func (*BEWriteFileMsg) String

func (m *BEWriteFileMsg) String() string

type BackEndMsg

type BackEndMsg interface {
	CreateFromMsgBody(*msgBuffer) (BackEndMsg, error)
	String() string
}

BackEndMsg is received from the database

func CreateBackEndMsg

func CreateBackEndMsg(msgType byte, body []byte) (BackEndMsg, error)

CreateBackEndMsg docs

type CmdTargetType

type CmdTargetType byte

CmdTargetType describes the target of a command

const (
	CmdTargetTypePortal    CmdTargetType = 'P'
	CmdTargetTypeStatement CmdTargetType = 'S'
)

Possible command targets

type ColumnExtractor

type ColumnExtractor struct {
	NumCols uint16
	// contains filtered or unexported fields
}

ColumnExtractor pulls columns out of a row

func (*ColumnExtractor) Chunk

func (c *ColumnExtractor) Chunk() []byte

Chunk provides the raw bytes for a column of data

type FEBindMsg

type FEBindMsg struct {
	Portal    string
	Statement string
	NamedArgs []driver.NamedValue
	OIDTypes  []int32
}

FEBindMsg docs

func (*FEBindMsg) Flatten

func (m *FEBindMsg) Flatten() ([]byte, byte)

Flatten docs

func (*FEBindMsg) String

func (m *FEBindMsg) String() string

type FECancelMsg

type FECancelMsg struct {
	PID uint32
	Key uint32
}

FECancelMsg signals a cancellation by the user

func (*FECancelMsg) Flatten

func (m *FECancelMsg) Flatten() ([]byte, byte)

Flatten docs

func (*FECancelMsg) String

func (m *FECancelMsg) String() string

type FECloseMsg

type FECloseMsg struct {
	TargetType CmdTargetType
	TargetName string
}

func (*FECloseMsg) Flatten

func (m *FECloseMsg) Flatten() ([]byte, byte)

Flatten docs

func (*FECloseMsg) String

func (m *FECloseMsg) String() string

type FEDescribeMsg

type FEDescribeMsg struct {
	TargetType CmdTargetType
	TargetName string
}

FEDescribeMsg docs

func (*FEDescribeMsg) Flatten

func (m *FEDescribeMsg) Flatten() ([]byte, byte)

Flatten docs

func (*FEDescribeMsg) String

func (m *FEDescribeMsg) String() string

type FEErrorMsg

type FEErrorMsg struct {
	FileName   string
	LineNumber int
	Method     string
	ErrorMsg   string
}

FEErrorMsg docs

func (*FEErrorMsg) Flatten

func (m *FEErrorMsg) Flatten() ([]byte, byte)

Flatten docs

func (*FEErrorMsg) String

func (m *FEErrorMsg) String() string

type FEExecuteMsg

type FEExecuteMsg struct {
	Portal   string
	RowLimit uint32
}

FEExecuteMsg docs

func (*FEExecuteMsg) Flatten

func (m *FEExecuteMsg) Flatten() ([]byte, byte)

Flatten docs

func (*FEExecuteMsg) String

func (m *FEExecuteMsg) String() string

type FEFlushMsg

type FEFlushMsg struct {
}

func (*FEFlushMsg) Flatten

func (m *FEFlushMsg) Flatten() ([]byte, byte)

Flatten docs

func (*FEFlushMsg) String

func (m *FEFlushMsg) String() string

type FELoadBalanceMsg

type FELoadBalanceMsg struct {
}

FELoadBalanceMsg docs

func (*FELoadBalanceMsg) Flatten

func (m *FELoadBalanceMsg) Flatten() ([]byte, byte)

Flatten docs

func (*FELoadBalanceMsg) String

func (m *FELoadBalanceMsg) String() string

type FELoadDataMsg

type FELoadDataMsg struct {
	Data      []byte
	UsedBytes int
}

FELoadDataMsg docs

func (*FELoadDataMsg) Flatten

func (m *FELoadDataMsg) Flatten() ([]byte, byte)

Flatten docs

func (*FELoadDataMsg) String

func (m *FELoadDataMsg) String() string

type FELoadDoneMsg

type FELoadDoneMsg struct {
}

FELoadDoneMsg docs

func (*FELoadDoneMsg) Flatten

func (m *FELoadDoneMsg) Flatten() ([]byte, byte)

Flatten docs

func (*FELoadDoneMsg) String

func (m *FELoadDoneMsg) String() string

type FELoadFailMsg

type FELoadFailMsg struct {
	Message string
}

FELoadDoneMsg docs

func (*FELoadFailMsg) Flatten

func (m *FELoadFailMsg) Flatten() ([]byte, byte)

Flatten docs

func (*FELoadFailMsg) String

func (m *FELoadFailMsg) String() string

type FEParseMsg

type FEParseMsg struct {
	PreparedName string
	Command      string
	NumArgs      uint16
}

FEParseMsg docs

func (*FEParseMsg) Flatten

func (m *FEParseMsg) Flatten() ([]byte, byte)

Flatten docs

func (*FEParseMsg) String

func (m *FEParseMsg) String() string

type FEPasswordMsg

type FEPasswordMsg struct {
	PasswordData string
}

func (*FEPasswordMsg) Flatten

func (m *FEPasswordMsg) Flatten() ([]byte, byte)

Flatten docs

func (*FEPasswordMsg) String

func (m *FEPasswordMsg) String() string

type FEQueryMsg

type FEQueryMsg struct {
	Query string
}

FEQueyMsg docs

func (*FEQueryMsg) Flatten

func (m *FEQueryMsg) Flatten() ([]byte, byte)

Flatten docs

func (*FEQueryMsg) String

func (m *FEQueryMsg) String() string

type FESSLMsg

type FESSLMsg struct {
}

FESSLMsg docs

func (*FESSLMsg) Flatten

func (m *FESSLMsg) Flatten() ([]byte, byte)

Flatten docs

func (*FESSLMsg) String

func (m *FESSLMsg) String() string

type FEStartupMsg

type FEStartupMsg struct {
	ProtocolVersion  uint32
	DriverName       string
	DriverVersion    string
	Username         string
	Database         string
	SessionID        string
	ClientPID        int
	ClientOS         string
	OSUsername       string
	Autocommit       string
	OAuthAccessToken string
	ClientOSHostname string
	Workload         string
}

FEStartupMsg docs

func (*FEStartupMsg) Flatten

func (m *FEStartupMsg) Flatten() ([]byte, byte)

Flatten docs

func (*FEStartupMsg) String

func (m *FEStartupMsg) String() string

type FESyncMsg

type FESyncMsg struct {
}

FEParseMsg docs

func (*FESyncMsg) Flatten

func (m *FESyncMsg) Flatten() ([]byte, byte)

Flatten docs

func (*FESyncMsg) String

func (m *FESyncMsg) String() string

type FETerminateMsg

type FETerminateMsg struct {
}

func (*FETerminateMsg) Flatten

func (m *FETerminateMsg) Flatten() ([]byte, byte)

Flatten docs

func (*FETerminateMsg) String

func (m *FETerminateMsg) String() string

type FEVerifyLoadFiles

type FEVerifyLoadFiles struct {
	FileNames []string
	FileSizes []uint64
}

FEVerifyLoadFiles docs

func (*FEVerifyLoadFiles) Flatten

func (m *FEVerifyLoadFiles) Flatten() ([]byte, byte)

Flatten docs

func (*FEVerifyLoadFiles) String

func (m *FEVerifyLoadFiles) String() string

type FrontEndMsg

type FrontEndMsg interface {
	Flatten() ([]byte, byte)
	String() string
}

FrontEndMsg is sent from the adapter to the database

Source Files

beauthenticationmsg.go bebindcompletemsg.go beclosecompletemsg.go becmdcompletemsg.go becmddescriptionmsg.go bedatarowmsg.go beemptyqueryrespmsg.go beerrormsg.go beinitstdinloadmsg.go bekeydatamsg.go beloadbalancemsg.go beloadnewfilemsg.go benodatamsg.go benoticemsg.go beparameterdescmsg.go beparamstatusmsg.go beparsecomplete.go beportalsuspendedmsg.go bereadyforquerymsg.go berowdescmsg.go beverifyloadfilesmsg.go bewritefilemsg.go febindmsg.go fecancelmsg.go feclosemsg.go fedescribemsg.go feerrormsg.go feexecutemsg.go feflush.go feloadbalancemsg.go feloaddatamsg.go feloaddonemsg.go feloadfailmsg.go feparsemsg.go fepasswordmsg.go fequerymsg.go fesslmsg.go festartupmsg.go fesyncmsg.go feterminatemsg.go feverifyloadfiles.go msg.go msgbuffer.go

Version
v1.3.3 (latest)
Published
Aug 4, 2023
Platform
js/wasm
Imports
9 packages
Last checked
4 hours ago

Tools for package owners.