The DataFormat to use for decoding and encoding binary values. The default is MsgpackDataFormat.
the default bucket used for newly created keys
The minimum snapshot version to use for new transactions. This will be used when starting a new transaction in order to guarantee session guarantees like monotonic reads and read-your-writes
Option, which determines if snapshots should be monotonic.
If set to true, this will update minSnapshotTime whenever
lastCommitTimestamp is updated
Inverse of jsToBinary
Closes the connection to Antidote
returns a reference to a counter object
returns a reference to a fat_counter object
returns a reference to an disable-wins flag object
returns a reference to an enable-wins flag object
returns the timestamp for the last commited transaction
returns a reference to a grow-only map
Method to encode objects before they are written to the database
returns a reference to a multi-value register
Takes an array of objects and reads the value of all objects in one batch operation. Returns a promise to an array of values in the same order.
Hint: To read a single object, use the read method on that object.
Reads several objects at once. The objects are stored in an object. Returns a new object with the read values stored under the same field in the object.
let objA = connection.counter("batch-object-read counter a")
let objB = connection.register<string>("batch-object-read register b")
let vals = await connection.readObjectsBatch({
a: objA,
b: objB
});
// could return: {a: 1, b: "hi"}
Hint: To read a single object, use the read method on that object.
returns a reference to a last-writer-wins register
returns a reference to a remove-resets map
returns a reference to an add-wins set object
Sets the timout for requests
returns a reference to a remove-wins set object
Starts a new transaction
Sends a single update operation or an array of update operations to Antidote. If an array of updates is given, all updates in the array are executed atomically.
Generated using TypeDoc
A connection to AntidoteDB with methods for reading, updating and starting transactions. Use the connect function to obtain a
Connection.The Connection can then be used as a CrdtFactory to create references to database objects.
The readBatch and update methods can be used to perform reads and updates.
Example:
let antidote = antidoteClient.connect(8087, "localhost") // create a reference to a set object: let userSet = antidote.set("users") // read the value of the set let val = await userSet.read() // update the set: await antidote.update(userSet.add("Hans"))The bucket can be configured via the property
defaultBucket, it defaults to "default-bucket".Javascript objects stored in sets and registers are encoded using MessagePack (http://msgpack.org) by default. You can override the jsToBinary and binaryToJs methods to customize this behavior.