API Docs for: 2.2.2
Show:

UpdateMap.Builder Class

Defined in: lib/commands/crdt/updatemap.js:270
Module: CRDT

A builder for constructing UpdateMap instances.

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

var update = new UpdateMap.Builder()
          .withBucketType('counters')
          .withBucket('myBucket')
          .withKey('counter_1')
          .withMapOperation(mapOp)
          .withCallback(callback)
          .build();

See UpdateMap.MapOperation

Constructor

UpdateMap.Builder

()

Defined in lib/commands/crdt/updatemap.js:270

Methods

build

() UpdateMap

Defined in lib/commands/crdt/updatemap.js:429

Construct an UpdateMap instance.

Returns:

UpdateMap:

withBucket

(
  • bucket
)
chainable

Defined in lib/commands/crdt/updatemap.js:293

Set the bucket.

Parameters:

  • bucket String

    the bucket in Riak

withBucketType

(
  • bucketType
)
chainable

Defined in lib/commands/crdt/updatemap.js:303

Set the bucket type.

Parameters:

  • bucketType String

    the bucket type in riak

withCallback

(
  • callback
)
chainable

Defined in lib/commands/crdt/updatemap.js:345

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 response from Riak. Will be null if returnBody is not set.

      • generatedKey String
        If no key was supplied, Riak will generate and return one here.
      • context Buffer
        An opaque context to be used in any subsequent modification of the map.
      • map Object
        The map in Riak, converted to a JS object.

withContext

(
  • context
)
chainable

Defined in lib/commands/crdt/updatemap.js:334

The context returned from a previous fetch of this map. Note: this is required when performing any removes.

Parameters:

  • context Buffer

    the contect from a previous fetch.

withDw

(
  • dw
)
chainable

Defined in lib/commands/crdt/updatemap.js:372

Set the DW value. How many replicas to commit to durable storage before returning a successful response. If not set the bucket default is used.

Parameters:

  • dw Number

    the DW value.

withKey

(
  • key
)
chainable

Defined in lib/commands/crdt/updatemap.js:313

Set the key. If not set, riak will generate and return a key.

Parameters:

  • key String

    the key in riak.

withMapOperation

(
  • mapOp
)
chainable

Defined in lib/commands/crdt/updatemap.js:324

Set the modifications to make to this map.

Parameters:

  • mapOp MapOperation

    the modifications

withPw

(
  • pw
)
chainable

Defined in lib/commands/crdt/updatemap.js:384

Set the PW value. How many primary nodes must be up when the write is attempted. If not set the bucket default is used.

Parameters:

  • pw Number

    the PW value.

withReturnBody

(
  • returnBody
)
chainable

Defined in lib/commands/crdt/updatemap.js:396

Return the counter after updating.

Parameters:

  • returnBody Boolean

    true to return the counter.

withSetsAsBuffers

(
  • setsAsBuffers
)
chainable

Defined in lib/commands/crdt/updatemap.js:406

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. Note this is only used with the returnBody option.

Parameters:

  • setsAsBuffers Boolean

    true to not convert set contents to strings.

withTimeout

(
  • timeout
)
chainable

Defined in lib/commands/crdt/updatemap.js:419

Set a timeout for this operation.

Parameters:

  • timeout Number

    a timeout in milliseconds.

withW

(
  • w
)
chainable

Defined in lib/commands/crdt/updatemap.js:360

Set the W value. How many replicas to write to before returning a successful response. If not set the bucket default is used.

Parameters:

  • w Number

    the W value.