Skip to content

gRPC Analytical Connector API

gRPC Analytical Connector API for version 12.287.0.

Package: qlik.sse

Analytical Connector Protobuf API specification

Methods

GetCapabilities

A handshake call for the Qlik engine to retrieve the capability of the plugin.

Parameters:

Type Description
Empty An empty message used when nothing is to be passed in a call.

Response:

Type Description
Capabilities A full description of the plugin, sent to the Qlik engine, listing all functions available and indicating whether script evaluation is allowed.

ExecuteFunction

Requests a function to be executed as specified in the header.

Parameters:

Type Description
BundledRows A number of rows collected in one message. The actual number will depend on the size of each row and is adjusted to optimize throughput.

Response:

Type Description
BundledRows A number of rows collected in one message. The actual number will depend on the size of each row and is adjusted to optimize throughput.

EvaluateScript

Requests a script to be evaluated as specified in the header.

Parameters:

Type Description
BundledRows A number of rows collected in one message. The actual number will depend on the size of each row and is adjusted to optimize throughput.

Response:

Type Description
BundledRows A number of rows collected in one message. The actual number will depend on the size of each row and is adjusted to optimize throughput.

Definitions

BundledRows

A number of rows collected in one message. The actual number will depend on the size of each row and is adjusted to optimize throughput.

Fields:

Name Description Type Label Default
rows No description. Row repeated No default value.

Capabilities

A full description of the plugin, sent to the Qlik engine, listing all functions available and indicating whether script evaluation is allowed.

Fields:

Name Description Type Label Default
allowScript When true, the Qlik engine allows scripts to be sent to the plugin. bool optional No default value.
functions The definitions of all available functions. FunctionDefinition repeated No default value.
pluginIdentifier The ID or name of the plugin. string optional No default value.
pluginVersion The version of the plugin. string optional No default value.

CommonRequestHeader

A header sent at the start of both an EvaluateScript request and an ExecuteFunction request under the key "qlik-commonrequestheader-bin".

Fields:

Name Description Type Label Default
appId The ID of the app the request was executed in. string optional No default value.
userId The ID of the user the request was executed by. string optional No default value.
cardinality The cardinality of the parameters. int64 optional No default value.

Dual

The basic data type for the data stream. Can contain double, string, or both.

Fields:

Name Description Type Label Default
numData Numeric value as double. double optional No default value.
strData String. string optional No default value.

Empty

An empty message used when nothing is to be passed in a call.

FieldDescription

Field definition for function and script calls.

Fields:

Name Description Type Label Default
dataType The data type of the field. DataType optional No default value.
name The name of the field. string optional No default value.
tags The tags of the field. string repeated No default value.

FunctionDefinition

The definition of a function, which informs the Qlik engine how to use it.

Fields:

Name Description Type Label Default
name The name of the function. string optional No default value.
functionType The type of the function. FunctionType optional No default value.
returnType The return type of the function. DataType optional No default value.
params The parameters the function takes. Parameter repeated No default value.
functionId A unique ID number for the function, set by the plugin, to be used in calls from the Qlik engine to the plugin. int32 optional No default value.

FunctionRequestHeader

A header sent at the start of an ExecuteFunction request under the key "qlik-functionrequestheader-bin".

Fields:

Name Description Type Label Default
functionId The ID of the function to be executed. int32 optional No default value.
version A dummy variable as a workaround for an issue. string optional No default value.

Parameter

Parameter definition for functions and script calls.

Fields:

Name Description Type Label Default
dataType The data type of the parameter. DataType optional No default value.
name The name of the parameter. string optional No default value.

Row

A row of duals.

Fields:

Name Description Type Label Default
duals Row of duals. Dual repeated No default value.

ScriptRequestHeader

A header sent at the start of an EvaluateScript request under the key "qlik-scriptrequestheader-bin".

Fields:

Name Description Type Label Default
script The script to be executed. string optional No default value.
functionType The function type of the script evaluation: scalar, aggregation or tensor. FunctionType optional No default value.
returnType The return type from the script evaluation: numeric, string or both. DataType optional No default value.
params The parameters names and types passed to the script. Parameter repeated No default value.

TableDescription

A header sent before returning data to Qlik, under the key "qlik-tabledescription-bin".

Fields:

Name Description Type Label Default
fields The fields of the table. FieldDescription repeated No default value.
name The name of the table. string optional No default value.
numberOfRows Number of rows in table. int64 optional No default value.

Enums

DataType

Data types of the parameters and return values.

Name Number Description
STRING 0 Contains only string.
NUMERIC 1 Contains only double.
DUAL 2 Contains both a string and a double.

FunctionType

Types of functions (determined by their return values).

Name Number Description
SCALAR 0 The return value is a scalar per row.
AGGREGATION 1 All rows are aggregated into a single scalar.
TENSOR 2 Multiple rows in, multiple rows out.

Scalar Value Types

double

cpp cs go java php python ruby
double double float64 double float float Float

float

cpp cs go java php python ruby
float float float32 float float float Float

int32

cpp cs go java php python ruby
int32 int int32 int integer int Bignum or Fixnum (as required)

int64

cpp cs go java php python ruby
int64 long int64 long integer/string int/long Bignum

uint32

cpp cs go java php python ruby
uint32 uint uint32 int integer int/long Bignum or Fixnum (as required)

uint64

cpp cs go java php python ruby
uint64 ulong uint64 long integer/string int/long Bignum or Fixnum (as required)

sint32

cpp cs go java php python ruby
int32 int int32 int integer int Bignum or Fixnum (as required)

sint64

cpp cs go java php python ruby
int64 long int64 long integer/string int/long Bignum

fixed32

cpp cs go java php python ruby
uint32 uint uint32 int integer int Bignum or Fixnum (as required)

fixed64

cpp cs go java php python ruby
uint64 ulong uint64 long integer/string int/long Bignum

sfixed32

cpp cs go java php python ruby
int32 int int32 int integer int Bignum or Fixnum (as required)

sfixed64

cpp cs go java php python ruby
int64 long int64 long integer/string int/long Bignum

bool

cpp cs go java php python ruby
bool bool bool boolean boolean boolean TrueClass/FalseClass

string

cpp cs go java php python ruby
string string string String string str/unicode String (UTF-8)

bytes

cpp cs go java php python ruby
string ByteString []byte ByteString string str String (ASCII-8BIT)