Skip to main content

The format section of aerospike-pubsub-outbound.yml

The format section of the /etc/aerospike-pubsub-outbound/aerospike-pubsub-outbound.yml YAML file specifies the serialization format of the data output. The supported formats are:

Aerospike record metadata

The Aerospike record metadata has the following fields

MetadataTypeDescriptionPresent in
msgstringWrite/Delete operation.Delete and Write
namespacestringNamespace of the Aerospike record.Delete and Write
setstringSet of the Aerospike record.Write
userKeylong, double, bytes or stringThe user key of the Aerospike record.Write (only if user key is stored on server)
digestbytesThe digest of the Aerospike record.Delete and Write
genintThe generation of the Aerospike record.Write
lutintThe last update time of the Aerospike record.Write
expintThe expiry of the Aerospike record.Write
durablebooleanWhether the delete is durable.Delete

WARNING

  • If the Aerospike record cannot be serialized according to the configuration of the selected format, the record is skipped.
  • HyperLogLog bins are forwarded as is, as bytes or (for string-based formats) as Base64-encoded strings.

Avro

Specifies that the data be serialized as Avro format. The Avro schema can be a map or a record. In the case of a map, just specifying the type of the map values is sufficient. In the case of a record, the exact field names and types need to be specified.

OptionRequiredDefaultExpected valueDescription
modeyesavroSelects avro format.
schemanoThe schema of the data.
schema-filenoThe file containing the schema of the data.
stringify-map-keysnofalseWhether the numeric keys in CDT maps should be converted to strings. See stringify map keys in avro

One of schema or schema-file has to be specified.

Flat JSON

Specifies that the data be serialized to Flat JSON format. The type information of bins is not part of the output.

OptionRequiredDefaultExpected valueDescription
modeyesflat-jsonSelects Flat JSON format.
metadata-keyyesThe Aerospike record metadata will be inserted into this top level key.
stringify-map-keysnofalseWhether the numeric keys in CDT maps should be converted to strings. See stringify map keys

Example

format:
mode: flat-json
metadata-key: metadata

JSON

Specifies that the data be serialized to JSON format with the type information of bins.

OptionRequiredDefaultExpected valueDescription
modeyesjsonSelects JSON format.
stringify-map-keysnofalseWhether the numeric keys in CDT maps should be converted to strings. See stringify map keys

Stringify Map Keys

Aerospike supports string, numeric types, and binary for map keys. JSON supports only string keys. If a map key is a numeric type and if stringify-map-keys is set to true, that key is converted to a string.

In all other cases, a map with non-string keys cannot be parsed by the connector, and the connector throws an error.

Example

format:
mode: json

MessagePack

Specifies that the data be serialized to MessagePack format with the type information of bins.

OptionRequiredExpected valueDescription
modeyesmessage-packSelects message pack format.

Example

format:
mode: message-pack

Custom

Specifies that the data be serialized with user provided custom code. See Format Transform.

Example

format:
mode: custom
class: com.aerospike.connect.outbound.example.Formatter