API Docs for: 2.2.2
Show:

ListKeys Class

Extends CommandBase
Defined in: lib/commands/ts/listkeys.js:14
Module: TS

Command used to list keys in a table.

As a convenience, a builder class is provided;

var listKeys = new ListKeys.Builder()
             .withTable('myTable')
             .withCallback(myCallback)
             .build();

See ListKeys.Builder

Constructor

ListKeys

(
  • options
  • callback
)

Defined in lib/commands/ts/listkeys.js:14

Parameters:

  • options Object

    The options for this command

    • [bucketType=default] String optional

      The bucket type in riak. If not supplied 'default' is used.

    • bucket String

      The bucket in riak.

    • [stream=true] Boolean optional

      Whether to stream or accumulate the result before calling callback.

    • [timeout] Number optional

      Set a timeout for this operation.

  • callback Function

    The callback to be executed when the operation completes.

    • err String

      An error message. Will be null if no error.

    • response Object

      the keys returned from Riak.

      • done Boolean
        True if you have received all the keys.
      • bucketType String
        The bucketType the keys are from.
      • bucket String
        The bucket the keys are from.
      • keys String
        The array of keys.
    • data Object

      additional error data. Will be null if no error.

Methods

constructPbRequest

() Object protected

Inherited from CommandBase: lib/commands/commandbase.js:128

Construct and return the Riak protocol buffer message for this command. Subclasses must override this method.

Returns:

Object: a protocol buffer message builder

getCallback

() Function private

Inherited from CommandBase: lib/commands/commandbase.js:68

Fires the user's callback with the arguments passed in.

Returns:

Function: the user supplied callback

getExpectedResponseCode

() Number private

Inherited from CommandBase: lib/commands/commandbase.js:78

Returns the expected response code for this command.

Returns:

Number: the expected response code for this command.

getPbReqBuilder

() Object private

Inherited from CommandBase: lib/commands/commandbase.js:111

Returns and instance of the protocol buffer message builder for this command. This is determined via the pbRequestName passed to the constructor.

Returns:

Object: the builder for the protocol buffer message to be sent for this command

getRiakMessage

() Object private

Inherited from CommandBase: lib/commands/commandbase.js:88

Returns the encoded protobuf and message header.

Returns:

Object: object containing the header and encoded protobuf

onError

(
  • msg
  • data
)
protected

Inherited from CommandBase: lib/commands/commandbase.js:164

Called by RiakNode if an error occurs executing the command and all retries are exhausted.

Parameters:

  • msg String
    an error message
  • data Object
    additional error data

onRiakError

(
  • rpbErrorResp
)
protected

Inherited from CommandBase: lib/commands/commandbase.js:151

Called by RiakNode when a RpbErrorResp is received and all retries are exhausted. Commands may override this method.

Parameters:

  • rpbErrorResp Object
    the RpbErrorResp protocol buffer

onSuccess

(
  • pbResponseMessage
)
Boolean protected

Inherited from CommandBase: lib/commands/commandbase.js:139

Called by RiakNode when a response is received. Subclasses must override this method.

Parameters:

  • pbResponseMessage Object
    the protocol buffer received from riak

Returns:

Boolean: true if not streaming or the last response has been received, false otherwise.