API Docs for: 2.2.2
Show:

ListKeys.Builder Class

Defined in: lib/commands/ts/listkeys.js:88
Module: TS

A builder for constructing ListKeys instances.

Rather than having to manually construct the options and instantiating a ListKeys directly, this builder may be used.

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

Constructor

ListKeys.Builder

()

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

Methods

build

() ListKeys

Provided by the KV module.

Defined in lib/commands/kv/listkeys.js:176

Construct a ListKeys instance.

Returns:

ListKeys:

build

() ListKeys

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

Construct a ListKeys instance.

Returns:

ListKeys:

withBucket

(
  • bucket
)
chainable

Provided by the KV module.

Defined in lib/commands/kv/listkeys.js:115

Set the bucket.

Parameters:

  • bucket String

    the bucket in Riak

withBucketType

(
  • bucketType
)
chainable

Provided by the KV module.

Defined in lib/commands/kv/listkeys.js:125

Set the bucket type. If not supplied, 'default' is used.

Parameters:

  • bucketType String

    the bucket type in riak

withCallback

(
  • callback
)
chainable

Provided by the KV module.

Defined in lib/commands/kv/listkeys.js:150

Set the callback to be executed when the operation completes.

Parameters:

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

withCallback

(
  • callback
)
chainable

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

Set the callback to be executed when the operation completes.

Parameters:

  • 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.
      • table String
        The table the keys are from.
      • keys String
        The array of keys.

withStreaming

(
  • [stream=true]
)
chainable

Provided by the KV module.

Defined in lib/commands/kv/listkeys.js:136

Stream the results. Setting this to true will cause you callback to be called as the results are returned from Riak. Set to false the result set will be buffered and delevered via a single call to your callback. Note that on large result sets this is very memory intensive.

Parameters:

  • [stream=true] Boolean optional

    Set whether or not to stream the results

withStreaming

(
  • [stream=true]
)
chainable

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

Stream the results. Setting this to true will cause you callback to be called as the results are returned from Riak TS. Set to false the result set will be buffered and delevered via a single call to your callback. Note that on large result sets this is very memory intensive.

Parameters:

  • [stream=true] Boolean optional

    Set whether or not to stream the results

withTable

(
  • table
)
chainable

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

Set the table.

Parameters:

  • table String

    The table in Riak TS

withTimeout

(
  • timeout
)
chainable

Provided by the KV module.

Defined in lib/commands/kv/listkeys.js:166

Set a timeout for this operation.

Parameters:

  • timeout Number

    a timeout in milliseconds.

withTimeout

(
  • timeout
)
chainable

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

Set a timeout for this operation.

Parameters:

  • timeout Number

    a timeout in milliseconds.