API Docs for: 2.2.2
Show:

DeleteValue.Builder Class

Defined in: lib/commands/kv/deletevalue.js:118
Module: KV

A builder for constructing DeleteValue instances.

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

var deleteValue = new DeleteValue.Builder()
     .withBucket('myBucket')
     .withKey('myKey')
     .withVClock(vclock)
     .withCallback(callback)
     .build();

Constructor

DeleteValue.Builder

()

Defined in lib/commands/kv/deletevalue.js:118

Methods

build

() DeleteValue

Defined in lib/commands/kv/deletevalue.js:272

Construct a DeleteValue command.

Returns:

DeleteValue:

an instance of DeleteValue

withBucket

(
  • bucket
)
chainable

Defined in lib/commands/kv/deletevalue.js:140

Set the bucket.

Parameters:

  • bucket String

    the bucket in Riak

withBucketType

(
  • bucketType
)
chainable

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

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

Parameters:

  • bucketType String

    the bucket type in riak

withCallback

(
  • callback
)
chainable

Defined in lib/commands/kv/deletevalue.js:260

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 on no error.

    • response Boolean

      the response from Riak. Will be true unless there was an error.

withDw

(
  • dw
)
chainable

Defined in lib/commands/kv/deletevalue.js:205

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/kv/deletevalue.js:161

Set the key.

Parameters:

  • key String

    the key in riak.

withPr

(
  • pr
)
chainable

Defined in lib/commands/kv/deletevalue.js:182

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

Parameters:

  • pr Number

    the PR value.

withPw

(
  • pw
)
chainable

Defined in lib/commands/kv/deletevalue.js:217

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.

withR

(
  • r
)
chainable

Defined in lib/commands/kv/deletevalue.js:171

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

Parameters:

  • r Number

    the R value.

withRw

(
  • rw
)
chainable

Defined in lib/commands/kv/deletevalue.js:229

Set the RW value. Quorum for both operations (get and put) involved in deleting an object .

Parameters:

  • rw Number

    the RW value.

withTimeout

(
  • timeout
)
chainable

Defined in lib/commands/kv/deletevalue.js:250

Set a timeout for this operation.

Parameters:

  • timeout Number

    a timeout in milliseconds.

withVClock

(
  • vclock
)

Defined in lib/commands/kv/deletevalue.js:240

Set the vector clock. If not set siblings may be created depending on bucket properties.

Parameters:

  • vclock Buffer

    a vector clock returned from a previous fetch

withW

(
  • w
)
chainable

Defined in lib/commands/kv/deletevalue.js:193

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.