API Docs for: 2.2.2
Show:

FetchSet.Builder Class

Defined in: lib/commands/crdt/fetchset.js:131
Module: CRDT

A builder for constructing FetchSet instances.

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

var fetch = new FetchSet.Builder()
                 .withBucketType('myBucketType')
                 .withBucket('myBucket')
                 .withKey('myKey')
                 .withCallback(myCallback)
                 .build();

Constructor

FetchSet.Builder

()

Defined in lib/commands/crdt/fetchset.js:131

Methods

build

() FetchSet

Defined in lib/commands/crdt/fetchset.js:150

Construct a SetchSet instance.

Returns:

FetchSet:

withBasicQuorum

(
  • useBasicQuorum
)
chainable

Defined in lib/commands/crdt/fetchset.js:241

Set the basic_quorum value. The parameter controls whether a read request should return early in some fail cases. E.g. If a quorum of nodes has already returned notfound/error, don't wait around for the rest.

Parameters:

  • useBasicQuorum Boolean

    the basic_quorum value.

withBucket

(
  • bucket
)
chainable

Defined in lib/commands/crdt/fetchset.js:191

Set the bucket.

Parameters:

  • bucket String

    the bucket in Riak

withBucketType

(
  • bucketType
)
chainable

Defined in lib/commands/crdt/fetchset.js:184

Set the bucket type.

Parameters:

  • bucketType String

    the bucket type in riak

withCallback

(
  • callback.err
  • callback.response
  • callback.response.context
  • callback.response.values
  • callback.response.isNotFound
)
chainable

Defined in lib/commands/crdt/fetchset.js:173

Set the callback to be executed when the operation completes.

Parameters:

  • callback.err String

    An error message. Will be null if no error.

  • callback.response Object

    The response from Riak.

  • callback.response.context Buffer

    An opaque context to be used in any subsequent modification of the set.

  • callback.response.values String | Buffer

    An array holding the values in the set. String by default, Buffers if setsAsBuffers was used.

  • callback.response.isNotFound Boolean

    True if there was no set in Riak.

withKey

(
  • key
)
chainable

Defined in lib/commands/crdt/fetchset.js:198

Set the key.

Parameters:

  • key String

    the key in riak.

withNotFoundOk

(
  • notFoundOk
)
chainable

Defined in lib/commands/crdt/fetchset.js:231

Set the not_found_ok value. If true a vnode returning notfound for a key increments the r tally. False is higher consistency, true is higher availability. If not asSet the bucket default is used.

Parameters:

  • notFoundOk Boolean

    the not_found_ok value.

withPr

(
  • pr
)
chainable

Defined in lib/commands/crdt/fetchset.js:213

Set the PR value. If not set the bucket default is used.

Parameters:

  • pr Number

    the PR value.

withR

(
  • r
)
chainable

Defined in lib/commands/crdt/fetchset.js:205

Set the R value. If not set the bucket default is used.

Parameters:

  • r Number

    the R value.

withSetsAsBuffers

(
  • setsAsBuffers
)
chainable

Defined in lib/commands/crdt/fetchset.js:221

Return sets as arrays of Buffers rather than strings. By default the contents of sets are converted to strings. Setting this to true will cause this not to occur and the raw bytes returned as Buffer objects.

Parameters:

  • setsAsBuffers Boolean

    true to not convert set contents to strings.

withTimeout

(
  • timeout
)
chainable

Defined in lib/commands/crdt/fetchset.js:252

Set a timeout for this operation.

Parameters:

  • timeout Number

    a timeout in milliseconds.