This interface describes the events emitted by NoSQLClient

Hierarchy

  • NoSQLClientEvents

Events

  • NoSQLClient consumedCapacity event.

    Emitted by NoSQLClient method calls that return ConsumedCapacity as part of their result. These methods include all data manipulation and query methods. This event may be used to calculate relevant statistsics.

    Parameters

    Returns void

  • NoSQLClient error event.

    Emitted when any NoSQLClient method results in error. This event is not emitted when automatic retries are performed, only when the error is final.

    Also mote that this event will not be emitted if it has no listeners, so it is not necessary to subscribe to it.

    Parameters

    • err: NoSQLError

      Error of type NoSQLError or one of its subclasses

    • op: Operation

      Object describing operation that caused the error, see Operation

    Returns void

  • NoSQLClient retryable event.

    Emitted when error from NoSQLClient operation will result in automatic retry of operation. It will be emitted on each subsequent retry.

    See

    RetryConfig for explanation of retries

    Parameters

    • err: NoSQLError

      Error of type NoSQLError or one of its subclasses that caused the retry

    • op: Operation

      Object describing operation that caused the error, see Operation

    • numRetries: number

      Number of retries performed so far for this operation, not counting the original API invokation or the retry about to be performed

    Returns void

  • NoSQLClient tableState event.

    Emitted by NoSQLClient method calls that return table state as part of their result, such as getTable, tableDDL and setTableLimits and also while table is polled waiting for DDL operation completion using forCompletion. Can be used to perform actions on a table reaching certain state. Note that this event may be emitted mutliple times even while the table state did not change.

    Parameters

    Returns void

Generated using TypeDoc