Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AntidoteSession

An AntidoteSession is an interface to Antidote, which can be used to read and update values.

There are two possible sessions:

  • The Connection for reads and updates which are not part of interactive transactions.
  • Transaction for performing reads and updates within an interactive transaction.

Hierarchy

Index

Methods

counter

fatCounter

flag_dw

flag_ew

gmap

multiValueRegister

readBatch

  • 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.

    Parameters

    Returns Promise<any[]>

readObjectsBatch

  • readObjectsBatch<T>(objects: object): Promise<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.

    Type parameters

    • T

    Parameters

    • objects: object

    Returns Promise<object>

register

rrmap

set

set_removeWins

  • set_removeWins<T>(key: string): CrdtSet<T>

update

  • update(updates: ApbUpdateOp[] | ApbUpdateOp): Promise<any>
  • 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.

    Parameters

    • updates: ApbUpdateOp[] | ApbUpdateOp

    Returns Promise<any>

Generated using TypeDoc