qlik_connect

package
v0.0.0-...-ca7d6aa Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 12, 2020 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Package qlik_connect is a generated protocol buffer package.

It is generated from these files: 

grpc_server.proto

It has these top-level messages: 

ConnectionInfo
SessionInfo
Parameter
DataInfo
DataRequest
DataChunk
FieldAttributes
FieldInfo
GetDataResponse
MetaInfo
MetaInfoRequest

Index

Constants

This section is empty.

Variables

View Source 
var FieldAttrType_name = map[int32]string{
	0:  "UNKNOWN",
	1:  "TEXT",
	2:  "REAL",
	3:  "DATE",
	4:  "TIME",
	5:  "TIMESTAMP",
	6:  "INTERVAL",
	10: "INTEGER",
	11: "FIX",
	12: "MONEY",
}
View Source 
var FieldAttrType_value = map[string]int32{
	"UNKNOWN":   0,
	"TEXT":      1,
	"REAL":      2,
	"DATE":      3,
	"TIME":      4,
	"TIMESTAMP": 5,
	"INTERVAL":  6,
	"INTEGER":   10,
	"FIX":       11,
	"MONEY":     12,
}
View Source 
var SemanticType_name = map[int32]string{
	0: "DEFAULT",
	1: "UNIX_SECONDS_SINCE_1970_UTC",
	2: "ISO_8601",
}
View Source 
var SemanticType_value = map[string]int32{
	"DEFAULT":                     0,
	"UNIX_SECONDS_SINCE_1970_UTC": 1,
	"ISO_8601":                    2,
}

Functions

func RegisterConnectorServer 

func RegisterConnectorServer(s *grpc.Server, srv ConnectorServer)

Types

type ConnectionInfo 

type ConnectionInfo struct {
	ConnectionString string `protobuf:"bytes,1,opt,name=connectionString" json:"connectionString,omitempty"`
	User             string `protobuf:"bytes,2,opt,name=user" json:"user,omitempty"`
	Password         string `protobuf:"bytes,3,opt,name=password" json:"password,omitempty"`
}

func (*ConnectionInfo) Descriptor 

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

func (*ConnectionInfo) GetConnectionString 

func (m *ConnectionInfo) GetConnectionString() string

func (*ConnectionInfo) GetPassword 

func (m *ConnectionInfo) GetPassword() string

func (*ConnectionInfo) GetUser 

func (m *ConnectionInfo) GetUser() string

func (*ConnectionInfo) ProtoMessage 

func (*ConnectionInfo) ProtoMessage()

func (*ConnectionInfo) Reset 

func (m *ConnectionInfo) Reset()

func (*ConnectionInfo) String 

func (m *ConnectionInfo) String() string

type ConnectorClient 

type ConnectorClient interface {
	// * The standard way to send data.
	// First send GetDataResponse as initial meta data.
	// Then send DataChunk stream.
	GetData(ctx context.Context, in *DataRequest, opts ...grpc.CallOption) (Connector_GetDataClient, error)
	GetMetaInfo(ctx context.Context, in *MetaInfoRequest, opts ...grpc.CallOption) (*MetaInfo, error)
}

func NewConnectorClient 

func NewConnectorClient(cc *grpc.ClientConn) ConnectorClient

type ConnectorServer 

type ConnectorServer interface {
	// * The standard way to send data.
	// First send GetDataResponse as initial meta data.
	// Then send DataChunk stream.
	GetData(*DataRequest, Connector_GetDataServer) error
	GetMetaInfo(context.Context, *MetaInfoRequest) (*MetaInfo, error)
}

type Connector_GetDataClient 

type Connector_GetDataClient interface {
	Recv() (*DataChunk, error)
	grpc.ClientStream
}

type Connector_GetDataServer 

type Connector_GetDataServer interface {
	Send(*DataChunk) error
	grpc.ServerStream
}

type DataChunk 

type DataChunk struct {
	// Value buckets
	StringBucket []string  `protobuf:"bytes,1,rep,name=stringBucket" json:"stringBucket,omitempty"`
	DoubleBucket []float64 `protobuf:"fixed64,2,rep,packed,name=doubleBucket" json:"doubleBucket,omitempty"`
	// Code arrays
	StringCodes []int32 `protobuf:"zigzag32,3,rep,packed,name=stringCodes" json:"stringCodes,omitempty"`
	NumberCodes []int64 `protobuf:"zigzag64,4,rep,packed,name=numberCodes" json:"numberCodes,omitempty"`
}

* A structure for streaming field values.

This message conatins two parts. A value bucket part and a code part.

Every transferred value have a string code and one or two numeric codes. These codes can be negative to inicate special things. -1 indicates null for example.

Otherwise they can index into the value buckets. A value with a null string and a null number is a null value in the Qlik Engine.

Number code have a special mechanism to escape an integer value inline with -2.

Each chunk starts anywhere in any row and continues for an arbitary length and may wrap to another row. A DataChunk will typically transfer many rows.

Each DataChunk must be equal or less in size to the default Grpc message size limit. This is currently 4 MB.

64 KB or slightly less is the optimal size for bandwith performance. But anything from 20 to 120 KB will give good performance if used with the hint option when writing.

Very large strings can be sent in many DataChunk messages by using the -3 escape sequence.

func (*DataChunk) Descriptor 

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

func (*DataChunk) GetDoubleBucket 

func (m *DataChunk) GetDoubleBucket() []float64

func (*DataChunk) GetNumberCodes 

func (m *DataChunk) GetNumberCodes() []int64

func (*DataChunk) GetStringBucket 

func (m *DataChunk) GetStringBucket() []string

func (*DataChunk) GetStringCodes 

func (m *DataChunk) GetStringCodes() []int32

func (*DataChunk) ProtoMessage 

func (*DataChunk) ProtoMessage()

func (*DataChunk) Reset 

func (m *DataChunk) Reset()

func (*DataChunk) String 

func (m *DataChunk) String() string

type DataInfo 

type DataInfo struct {
	Statement  string       `protobuf:"bytes,1,opt,name=statement" json:"statement,omitempty"`
	Parameters []*Parameter `protobuf:"bytes,2,rep,name=parameters" json:"parameters,omitempty"`
}

func (*DataInfo) Descriptor 

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

func (*DataInfo) GetParameters 

func (m *DataInfo) GetParameters() []*Parameter

func (*DataInfo) GetStatement 

func (m *DataInfo) GetStatement() string

func (*DataInfo) ProtoMessage 

func (*DataInfo) ProtoMessage()

func (*DataInfo) Reset 

func (m *DataInfo) Reset()

func (*DataInfo) String 

func (m *DataInfo) String() string

type DataRequest 

type DataRequest struct {
	Connection  *ConnectionInfo `protobuf:"bytes,1,opt,name=connection" json:"connection,omitempty"`
	SessionInfo *SessionInfo    `protobuf:"bytes,2,opt,name=sessionInfo" json:"sessionInfo,omitempty"`
	Parameters  *DataInfo       `protobuf:"bytes,3,opt,name=parameters" json:"parameters,omitempty"`
}

func (*DataRequest) Descriptor 

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

func (*DataRequest) GetConnection 

func (m *DataRequest) GetConnection() *ConnectionInfo

func (*DataRequest) GetParameters 

func (m *DataRequest) GetParameters() *DataInfo

func (*DataRequest) GetSessionInfo 

func (m *DataRequest) GetSessionInfo() *SessionInfo

func (*DataRequest) ProtoMessage 

func (*DataRequest) ProtoMessage()

func (*DataRequest) Reset 

func (m *DataRequest) Reset()

func (*DataRequest) String 

func (m *DataRequest) String() string

type FieldAttrType 

type FieldAttrType int32

* Direct copy of FieldAttrType in Qlik Engine. How to display the data. 

const (
	FieldAttrType_UNKNOWN   FieldAttrType = 0
	FieldAttrType_TEXT      FieldAttrType = 1
	FieldAttrType_REAL      FieldAttrType = 2
	FieldAttrType_DATE      FieldAttrType = 3
	FieldAttrType_TIME      FieldAttrType = 4
	FieldAttrType_TIMESTAMP FieldAttrType = 5
	FieldAttrType_INTERVAL  FieldAttrType = 6
	FieldAttrType_INTEGER   FieldAttrType = 10
	FieldAttrType_FIX       FieldAttrType = 11
	FieldAttrType_MONEY     FieldAttrType = 12
)

func (FieldAttrType) EnumDescriptor 

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

func (FieldAttrType) String 

func (x FieldAttrType) String() string

type FieldAttributes 

type FieldAttributes struct {
	Type FieldAttrType `protobuf:"varint,1,opt,name=Type,enum=qlik.connect.FieldAttrType" json:"Type,omitempty"`
}

* Subset of classic Qlik Engine number format

func (*FieldAttributes) Descriptor 

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

func (*FieldAttributes) GetType 

func (m *FieldAttributes) GetType() FieldAttrType

func (*FieldAttributes) ProtoMessage 

func (*FieldAttributes) ProtoMessage()

func (*FieldAttributes) Reset 

func (m *FieldAttributes) Reset()

func (*FieldAttributes) String 

func (m *FieldAttributes) String() string

type FieldInfo 

type FieldInfo struct {
	Name            string           `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	SemanticType    SemanticType     `protobuf:"varint,2,opt,name=semanticType,enum=qlik.connect.SemanticType" json:"semanticType,omitempty"`
	FieldAttributes *FieldAttributes `protobuf:"bytes,3,opt,name=fieldAttributes" json:"fieldAttributes,omitempty"`
	Tags            []string         `protobuf:"bytes,4,rep,name=tags" json:"tags,omitempty"`
}

func (*FieldInfo) Descriptor 

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

func (*FieldInfo) GetFieldAttributes 

func (m *FieldInfo) GetFieldAttributes() *FieldAttributes

func (*FieldInfo) GetName 

func (m *FieldInfo) GetName() string

func (*FieldInfo) GetSemanticType 

func (m *FieldInfo) GetSemanticType() SemanticType

func (*FieldInfo) GetTags 

func (m *FieldInfo) GetTags() []string

func (*FieldInfo) ProtoMessage 

func (*FieldInfo) ProtoMessage()

func (*FieldInfo) Reset 

func (m *FieldInfo) Reset()

func (*FieldInfo) String 

func (m *FieldInfo) String() string

type GetDataResponse 

type GetDataResponse struct {
	FieldInfo []*FieldInfo `protobuf:"bytes,1,rep,name=fieldInfo" json:"fieldInfo,omitempty"`
	TableName string       `protobuf:"bytes,2,opt,name=tableName" json:"tableName,omitempty"`
}

* Transferred as initial metadata with the name "x-qlik-getdata-bin".

func (*GetDataResponse) Descriptor 

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

func (*GetDataResponse) GetFieldInfo 

func (m *GetDataResponse) GetFieldInfo() []*FieldInfo

func (*GetDataResponse) GetTableName 

func (m *GetDataResponse) GetTableName() string

func (*GetDataResponse) ProtoMessage 

func (*GetDataResponse) ProtoMessage()

func (*GetDataResponse) Reset 

func (m *GetDataResponse) Reset()

func (*GetDataResponse) String 

func (m *GetDataResponse) String() string

type MetaInfo 

type MetaInfo struct {
	Name    string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Version string `protobuf:"bytes,2,opt,name=version" json:"version,omitempty"`
	// /     Example: "1.0.0.0" or "1.23 Beta" or "Buildnumber: 1234" or "2018-Feb-06"
	Developer string `protobuf:"bytes,3,opt,name=developer" json:"developer,omitempty"`
}

* Usefull for debugging.

func (*MetaInfo) Descriptor 

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

func (*MetaInfo) GetDeveloper 

func (m *MetaInfo) GetDeveloper() string

func (*MetaInfo) GetName 

func (m *MetaInfo) GetName() string

func (*MetaInfo) GetVersion 

func (m *MetaInfo) GetVersion() string

func (*MetaInfo) ProtoMessage 

func (*MetaInfo) ProtoMessage()

func (*MetaInfo) Reset 

func (m *MetaInfo) Reset()

func (*MetaInfo) String 

func (m *MetaInfo) String() string

type MetaInfoRequest 

type MetaInfoRequest struct {
}

func (*MetaInfoRequest) Descriptor 

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

func (*MetaInfoRequest) ProtoMessage 

func (*MetaInfoRequest) ProtoMessage()

func (*MetaInfoRequest) Reset 

func (m *MetaInfoRequest) Reset()

func (*MetaInfoRequest) String 

func (m *MetaInfoRequest) String() string

type Parameter 

type Parameter struct {
	Name  string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
}

func (*Parameter) Descriptor 

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

func (*Parameter) GetName 

func (m *Parameter) GetName() string

func (*Parameter) GetValue 

func (m *Parameter) GetValue() string

func (*Parameter) ProtoMessage 

func (*Parameter) ProtoMessage()

func (*Parameter) Reset 

func (m *Parameter) Reset()

func (*Parameter) String 

func (m *Parameter) String() string

type SemanticType 

type SemanticType int32

* How to interpret the data. If dates or times are already in the Qlik Engine format (fractional day since 1899-12-30), then the fastest way to import is to use SemanticType=DEFAULT. And transferr the date as a double and set FieldAttributes::Type = DATE. If the dates are in "days since 1904-01-01" format the best way is to add 1462 to them and send as 1899-12-30 dates. 

const (
	SemanticType_DEFAULT                     SemanticType = 0
	SemanticType_UNIX_SECONDS_SINCE_1970_UTC SemanticType = 1
	SemanticType_ISO_8601                    SemanticType = 2
)

func (SemanticType) EnumDescriptor 

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

func (SemanticType) String 

func (x SemanticType) String() string

type SessionInfo 

type SessionInfo struct {
	User      string `protobuf:"bytes,1,opt,name=user" json:"user,omitempty"`
	SessionId string `protobuf:"bytes,2,opt,name=sessionId" json:"sessionId,omitempty"`
	DocId     string `protobuf:"bytes,3,opt,name=docId" json:"docId,omitempty"`
}

func (*SessionInfo) Descriptor 

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

func (*SessionInfo) GetDocId 

func (m *SessionInfo) GetDocId() string

func (*SessionInfo) GetSessionId 

func (m *SessionInfo) GetSessionId() string

func (*SessionInfo) GetUser 

func (m *SessionInfo) GetUser() string

func (*SessionInfo) ProtoMessage 

func (*SessionInfo) ProtoMessage()

func (*SessionInfo) Reset 

func (m *SessionInfo) Reset()

func (*SessionInfo) String 

func (m *SessionInfo) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.