Skip to main content
Loading

Flat JSON Format

Flat JSON Serialization Formatโ€‹

This page specifies the Flat JSON data serialization format used by Aerospike Connect. It describes how Aerospike notification messages are represented as Flat JSON objects. Each message represents an event that occurred in an Aerospike database cluster. Different kinds of messages are used to describe events such as record creation/update and record deletions.

Key Formatโ€‹

The record key has the following properties

FieldTypeDescription
namespacestringNamespace of the Aerospike record.
setstringSet of the Aerospike record. Maybe missing in some cases.
userKeynumber, bytes (Base64 encoded) or stringThe user key of the Aerospike record. Is available if user key is stored on the Aerospike server.
digestbytes (Base64 encoded)The digest of the Aerospike record.

Example Keyโ€‹

{
"namespace": "users",
"set": "premium",
"userKey": "id123",
"digest": "IBlTW5m3UGqbFxfrsoDxCrLkKYQ="
}

Message Formatโ€‹

Each message is a JSON object with the metadata included in the specified metadata-key in the config and all the bins are present as top level objects.

Message metadataโ€‹

The message metadata properties are:

MetadataTypeDescription
msgstringWrite/Delete operation.
namespacestringNamespace of the Aerospike record.
setstringSet of the Aerospike record.
userKeylong, double, bytes or stringUser key of the Aerospike record. Present only if it is a write operation and the user key is stored on the Aerospike server.
digestbytesDigest of the Aerospike record.
genintGeneration of the Aerospike record.
lutlongTime when the record was last updated, in milliseconds since the Unix epoch. It is available whenever the Aerospike server ships last-update time. [1][2]
expintTime when the record will expire, in seconds since the Unix epoch. Zero means the record will not expire. Present only in write operation.
durablebooleanWhether the delete is durable. Present only in delete operation.
note

All metadata is affected by both delete and write operations, except where the description indicates otherwise.

[1] When the Aerospike server does not ship lut, then the following versions of these outbound connectors ship lut as zero:

  • JMS outbound connector, versions prior to 3.0.0
  • Kafka outbound connector, versions prior to 4.0.0
  • Pulsar outbound connector, versions prior to 2.0.0

[2] Breaking Change When the Aerospike server ships lut, then the following versions of these outbound connectors ship lut as a value of the data type "integer":

  • JMS outbound connector, versions prior to 3.0.0
  • Kafka outbound connector, versions prior to 4.0.0
  • Pulsar outbound connector, versions prior to 2.0.0

Example Write Messageโ€‹

Record with bins color and size.

{
"metadata": {
"msg": "write",
"namespace": "users",
"set": "premium",
"userKey": 7612,
"gen": 4,
"lut": 1617167159548,
"digest": "IBlTW5m3UGqbFxfrsoDxCrLkKYQ=",
"exp": 1682797792
},
"color": "red",
"size": 123
}

Example Delete Messageโ€‹

{
"metadata": {
"msg": "delete",
"namespace": "users",
"digest": "IBlTW5m3UGqbFxfrsoDxCrLkKYQ=",
"gen": 4,
"lut": 1617167159548,
"durable": false
}
}

Batch Flat JSON Serialization Formatโ€‹

If batching is configured then the records in the batch will be a JSON array of Flat JSON formatted records.

Example batch of Flat JSON formatted records.โ€‹

[
{
"metadata": {
"msg": "write",
"namespace": "users",
"set": "premium",
"userKey": 7612,
"gen": 4,
"lut": 1617167159548,
"digest": "IBlTW5m3UGqbFxfrsoDxCrLkKYQ=",
"exp": 1682797792
},
"color": "red",
"size": 123
},
{
"metadata": {
"msg": "delete",
"namespace": "users",
"digest": "IBlTW5m3UGqbFxfrsoDxCrLkKYQ=",
"gen": 4,
"lut": 1617167159548,
"durable": false
}
}
]

If the keys of a batch are configured to be concatenated, then the payload key of the batch will be a JSON array of Flat JSON formatted keys.

Example batch of Flat JSON formatted keysโ€‹

[
{
"namespace": "users",
"set": "premium",
"userKey": "id123",
"digest": "IBlTW5m3UGqbFxfrsoDxCrLkKYQ="
},
{
"namespace": "users",
"set": "premium",
"userKey": "id124",
"digest": "JQlTW5m3UGqbFxfxsoDxCrLkKYQ="
}
]