...
Ignite Type | Size | MsgPack Type | Notes |
---|---|---|---|
Bitmask(n) | ⌈n/8⌉ bytes | bin8 / bin16 / bin32 | Extension 8 |
IntX, UintX | 1-8 bytes | fixint / intX / uintX | Integer types are interchangeable when possible. fixint (1 byte) can be passed as a value for uint64 column. |
Float | 4 bytes | float32 | |
Double | 8 bytes | float64 | |
Number([n]) | Variable | ext16 (up to 2^8 - 1 bytes) | Extension 1 |
Decimal | Variable | ext16 (up to 2^8 - 1 bytes) | Extension 2 |
UUID | 16 bytes | fixext16 | Extension 3 |
String | Variable | str | |
Date | 3 bytes | fixext4 | Extension 4 |
Time | 5 bytes | ext8 | Extension 5 |
Datetime | 7 bytes | fixext8 | Extension 6 |
Timestamp | 10 bytes | ext8 | Extension 7 |
IgniteUuid | 24 bytes | ext8 | Extension 9 |
NoValue | 1 byte | fixext1 | Extension 10 |
Binary | Variable | bin32 (up to 2^32 - 1 bytes) |
...
Key tuples are tuples with key columns only. Key columns always come first in the schema. So if there are 2 key columns, first two values of the tuple is the key.
IEP-54: Schema-first Approach includes "dynamic schema expansion" feature, which means that users can insert arbitrary tuples and Ignite will automatically update the schema with extra fields, if any.
Ignite Table API handles "column set to null" (1) and "column not set" (2) differently.
NoValue custom protocol type reflects this distinctionTo support this feature, we provide schemaless alternatives for all operations that can involve automatic schema updates (upsert, insert, etc).
Request | |
---|---|
4 bytes | Magic number 49 47 4E 49, or "IGNI". Helps to identify misconfigured SSL or other apps probing the port. |
int | Payload length |
int | Version major |
int | Version minor |
int | Version patch |
int | Client code (1 for JDBC, 2 for general-purpose client) |
bin | Features (bitmask) |
map (string → any) | Extensions (auth, attributes, etc). Server can skip unknown extension data (when client is newer). |
...
Response | |
---|---|
4 bytes | Magic number 49 47 4E 49, or "IGNI". Helps to identify misconfigured SSL or different server on the port. |
int | Payload length |
int | Server version major |
int | Server version minor |
int | Server version patch |
int | Error code (0 for success) |
string | Error message (when error code is not 0) |
bin | When error code is 0: Server features (bitmask) |
map (string → any) | When error code is 0: Extensions (auth, attributes, etc). Client can skip unknown extension data (when server is newer). |
Upon successful handshake, client can start performing operations by sending a request with specific op code. Each operation has its own request and response format, with a common header.
...
Request or response without operation-specific data is called basic request or basic response below.
Clients should expect notification messages at any moment after the successful handshake.
...
Operation codes and request ids are omitted everywhere below for brevity.
...
...
Basic response.
Basic request.
...
...
...
...
Basic response.
Client side is supposed to match provided columns against the latest known schema.
...
Basic response.
...
int | Server version minor |
int | Server version patch |
int | Error code (0 for success) |
string | Error message (when error code is not 0) |
int | When error code is 0: Server idle timeout |
string | When error code is 0: Server node id |
string | When error code is 0: Server node name (consistent id) |
bin | When error code is 0: Server features (bitmask) |
map (string → any) | When error code is 0: Extensions (auth, attributes, etc). Client can skip unknown extension data (when server is newer). |
Upon successful handshake, client can start performing operations by sending a request with specific op code. Each operation has its own request and response format, with a common header.
Request | |
int | Operation code |
int | Request id, generated by client and returned as-is in response |
... | Operation-specific data |
Response | |
int | Type = 0 |
int | Request id |
int | Flags (1 = partition assignment changed) |
long | Observable timestamp (causality token) |
uuid or null | Trace id (null for success) |
int | Error code (when trace id is not null) |
string | Error message (when trace id is not null) |
string or null | Error stack trace (when trace id is not null) |
map or null | Error details (when trace id is not null) |
... | Operation-specific data (when trace id is null) |
Request or response without operation-specific data is called basic request or basic response below.
Clients should expect notification messages at any moment after the successful handshake.
Notification | |
int | Type = 1 |
int | Notification code |
... | Notification-specific data |
Operation codes and request ids are omitted everywhere below for brevity.
Basic request.
Response | |
---|---|
map (UUID -> string) | map of table ids and names |
Note: tables can only be created/deleted with SQL, there are no TABLE_CREATE or TABLE_DROP operations.
Request | |
---|---|
string | table name |
Response | |
---|---|
UUID or nil | table ID or null when a table with the given name does not exist |
Request | |
---|---|
UUID | table ID |
arr or nil | schema IDs, or null to get latest |
Response | |
---|---|
map (int → array (array)) | Map from schema ID to columns. Column is represented by an array of values for: name, type, isKey, isNullable. The array can contain extra data in future for additional properties. |
Clients should retrieve schemas with SCHEMAS_GET and cache them per table.
...
Request | |
---|---|
UUID | table ID |
int or nil | schema transaction ID |
introw | countschema ID |
values | rows with values for all columns in given schema (nil when value is missing for a column) |
Basic response.
...
Basic response.
...
Client side is supposed to match provided columns against the latest known schema.
Request | |
---|---|
UUID | table ID |
int or nilschema ID, or nil when result set is | emptytransaction ID |
introw | countschema ID |
values | array of rows with values for key columns (in schema order) |
Response | |
---|---|
int or nil | schema ID (for all tuples in response) |
int | row count |
values | rows with values in schema order |
...
id for the current tuple, or nil when there is no matching record | |
values | values for value columns in schema order, when schema id is not nil |
Clients should retrieve schemas with SCHEMAS_GET and cache them per table.
Request | |
---|---|
UUID | table ID |
int or nil | transaction ID |
int | schema ID |
intschema | IDrow count |
values | rows with values for all columns in given schema (nil when value is missing for a column) |
Response | |
int or nil | schema id for the current tuple, or nil when there is no matching record |
values | values for value columns in schema order |
Basic response.
...
Request | ||
---|---|---|
UUID | table ID | |
map | tuple as map | |
int or nil | transaction ID | Response|
int or nil | schema id for the current tupleID, or nil when there is no matching recordresult set is empty | |
int | row count | |
valuestuple values | array of rows with values for key columns (in schema order when schema id in not null |
...
) |
Response | |
---|---|
int | schema ID (for all tuples in response) |
int | row count |
values | rows with values in schema order |
Request | |
---|---|
UUID | table ID |
int or nil | transaction ID |
int | schema ID |
values | values for all columns in given schema (nil when value is missing for a column) |
Response | |
---|---|
bool | Insert result |
...
int or nil | schema id for the current tuple, or nil when there is no matching record |
values | values for value columns in schema order |
Request | |
---|---|
UUID | table ID |
int or nil | schema transaction ID |
introw | countschema ID |
values | rows with values for all columns in given schema (nil when value is missing for a column) |
Response |
---|
bool | Insert result |
...
...
Request | |
---|---|
UUID | table ID |
arr of map | array of tuples |
int or nil | transaction ID |
int | schema ID |
int | row count |
values | rows with values for all columns in given schema (nil when value is missing for a column) |
Response | |
---|---|
int | schema id |
Response | |
arr of map | skipped rows, or nil when none no rows were skipped |
int | skipped row count |
values | skipped rows (values in schema order) |
Request | |
---|---|
UUID | table ID |
int or nil | transaction ID |
int | schema ID |
values | values for all columns in given schema (nil when value is missing for a column) |
Response | |
bool | Replace result |
missing for a column) |
Request | |
---|---|
UUID | table ID |
map | tuple as map |
Response | |
bool | Replace result |
Request | |
---|---|
UUID | table ID |
int or nil | transaction ID |
int | schema ID |
values | oldRec: values for all columns in given schema (nil when value is missing for a column) |
values | newRec: values for all columns in given schema (nil when value is missing for a column) |
Response | |
bool | Replace result |
value is missing for a column) |
Request | |
---|---|
UUID | table ID |
map | oldRec: tuple as map |
map | newRec: tuple as map |
Response | |
bool | Replace result |
Request | |
---|---|
UUID | table ID |
int or nil | transaction ID |
int | schema ID |
values | values for all columns in given schema (nil when value is missing for a column) |
...
Response | |
---|---|
int or nil | schema id for the current tuple, or nil when there is no matching recordthere is no matching record |
values | values for value columns in schema order |
Request | |
---|---|
UUID | table ID |
int or nil | transaction ID |
int | schema ID |
values | values for value key columns in schema ordergiven schema |
Response | |
---|---|
bool | Delete result |
...
Request | |
---|---|
UUID | table ID |
int or nil | transaction ID |
int | schema ID |
int | row count |
values | rows with values for key columns in a given schema |
Response | |
---|---|
int |
schema id |
, or nil when |
no rows were skipped | |
int | skipped row count |
values |
skipped rows (values for key columns in schema order) |
...
Request | |
---|---|
UUID | table ID |
int or nil | transaction ID |
int | schema ID |
values | values for key all columns in given schema (nil when value is missing for a column) |
Response | |
---|---|
bool | Delete result |
...
Request | |
---|---|
UUID | table ID |
int or nil | transaction ID |
int | schema ID |
int | row count |
values | rows with values for key all columns in a given schema (nil when value is missing for a column) |
Response | |
---|---|
int | schema id, or nil when no rows were skipped |
int | skipped row |
count | |
values | skipped rows (values for |
key columns in |
schema order) |
...
...
...
...
Request | |
---|---|
UUID | table ID |
int or nil | schema transaction ID |
introw | countschema ID |
values | rows with values for all columns in given schema (nil when value is missing for a column) |
Response | |
---|---|
int or nil | schema id for the current tuple, or nil when |
there is no matching record |
values |
values for |
value columns in schema order |
, when schema id is not null |
...
...
...
Request | |
---|---|
UUID | table ID |
int or nil | transaction ID |
int | schema ID |
values | values for all columns in given schema (nil when value is missing for a column) |
Response | |
int or nil | schema id for the current tuple, or nil when there is no matching record |
values | values for value columns in schema order, when schema id is not null |
...
key columns |
Response | |
---|---|
bool | whether a tuple with the given key exists |
Request | |
---|---|
bool | Read-only tx flag |
long | Observable timestamp (value from server - see standard response header) |
Response | |
---|---|
int | Transaction ID |
Request | |
---|---|
int | Transaction ID |
Basic response
Request | |
---|---|
int | Transaction ID |
Basic response
...
...