Flat JSON format
For the complete documentation index see: llms.txt
All documentation pages available in markdown.
Aerospike Connect represents change notifications as Flat JSON objects when you choose the Flat JSON outbound format. Each object describes one cluster event, such as a record write, update, or delete, including key fields and message metadata defined on this page.
Flat JSON serialization format
Key Format
The record key has the following properties
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:
[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", "set": "premium", "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", "set": "premium", "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=" }]