API Docs for: 2.2.2
Show:

Describe Class

Extends Query
Module: TS

Command used to get a timeseries table's description.

As a convenience, a builder class is provided:

 var storeValue = new Describe.Builder()
     .withTable('GeoCheckin')
     .withCallback(callback)
     .build();

See Describe.Builder

Constructor

Describe

(
  • options
  • callback
)

Parameters:

  • options Object

    The options for this command.

    • table String

      The timeseries table in Riak.

  • callback Function

    The allback to be executed when the operation completes.

    • err String

      An error message. Will be null if no error.

    • response Object

      Object containing timeseries table metadata.

      • columns Object
        Timeseries table metadata columns.
      • rows Object
        Timeseries table metadata rows.
    • data Object

      additional error data. Will be null if no error.

Methods

constructPbRequest

() Object protected
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
Fires the user's callback with the arguments passed in.

Returns:

Function: the user supplied callback

getExpectedResponseCode

() Number private
Returns the expected response code for this command.

Returns:

Number: the expected response code for this command.

getPbReqBuilder

() Object private
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
Returns the encoded protobuf and message header.

Returns:

Object: object containing the header and encoded protobuf

onError

(
  • msg
  • data
)
protected
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
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
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.