Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
IDIEP-9
AuthorPavel Tupitsyn
SponsorPavel Tupitsyn
Created20-NOV-2017
Status
Status
colourGreyGreen
titleDRAFTCOMPLETED


Table of Contents

Info

This page includes low-level protocol documentation that might be outdated and is not maintained. Refer to the official protocol documentation here: https://apacheignite.readme.io/docs/binary-client-protocol

Motivation

Implement thin Ignite client in any programming language / platform using a well-defined binary connectiona protocol.

...

Response
bool

False: binary type does not exist, response end.

True: binary type exists, response as follows.

intType id
stringType name
stringAffinity key field name
intBinaryField count
BinaryField * count
BinaryField
stringField name
intType id
intField id
boolIs enum
int (if isEnum)Enum field count
(string + int) * count (if isEnum)Enum values
intSchema count
(int + int[](schema id) + int (field count) + int (field id) * n) * countBinary schemas, set of (schemaId + fieldIds) pairs

...

Request
intType id
stringType name
stringAffinity key field name
intBinaryField count
BinaryField * count
BinaryField
stringField name
intType id
intField id
boolIs enum
int (if isEnum)Enum field count
(string + int) * count (if isEnum)Enum values
intSchema count
(int (schema id) + int (field count) + int * n (field idsid) * n) * countBinary schemas, set of (schemaId + fieldIds) pairs

...

Request
intCache ID: Java-style hash code of the cache name
BinaryObjectFilter object
byte (if filter object is not null)Filter platform, JAVA = 1, DOTNET = 2, CPP = 3
intCursor page size
intPartition to query (negative to query entire cache)
boolLocal flag
Response
longCursor id

 

...

intRow count for the first page
(Object + Object) * countCache entries, key + value

bool

Indicates whether more results are available to be fetched with OP_QUERY_SCAN_CURSOR_GET_PAGE

 


OP_QUERY_SCAN_CURSOR_GET_PAGE = 2001

Retrieves next SQL query cursor page by cursor id from OP_QUERY_SCAN. 

...

Tickets

See "thin client" component in JIRA

...