API Docs for: 0.9.0
Show:

RiakConnectionAdapter Class

Extends ConnectionAdapter
Defined in: lib/connectionAdapter/riakConnectionAdapter.js:7

Riak accessor class

Constructor

RiakConnectionAdapter

(
  • [options]
)

Defined in lib/connectionAdapter/riakConnectionAdapter.js:7

Parameters:

  • [options] Object optional
    • [schema='http'] Object optional
    • [host='localhost'] Object optional
    • [port=8098] Object optional

Methods

_getUrlWithPath

(
  • path
)
String private

Defined in lib/connectionAdapter/riakConnectionAdapter.js:39

Gets the complete url for a path specified

Parameters:

Returns:

String:

_request

(
  • options
)
Promise private

Inherited from ConnectionAdapter: lib/connectionAdapter/connectionAdapter.js:46

Makes a request and returns a promise

Parameters:

  • options Object
    • url String

      Url of host

    • method String

      Method of request

    • [headers] Object optional

      Request headers

    • [body] String | Buffer optional

      Body of request

Returns:

Promise:

With {object} Response

getBucketKeys

(
  • bucket
  • [filterFn]
)
Promise

Inherited from ConnectionAdapter but overwritten in lib/connectionAdapter/riakConnectionAdapter.js:89

Gets all bucket keys

Parameters:

Returns:

Promise:

With {string[]} Bucket keys

getBuckets

(
  • [filterFn]
)
Promise

Inherited from ConnectionAdapter but overwritten in lib/connectionAdapter/riakConnectionAdapter.js:51

Gets all bucket names

Parameters:

Returns:

Promise:

With {string[]} List of buckets

getObject

(
  • bucket
  • key
)
Promise

Inherited from ConnectionAdapter but overwritten in lib/connectionAdapter/riakConnectionAdapter.js:129

Gets an object

Parameters:

Returns:

Promise:

With {Buffer}

getObjectAsJSON

(
  • bucket
  • key
)
Promise

Inherited from ConnectionAdapter but overwritten in lib/connectionAdapter/riakConnectionAdapter.js:148

Gets an object as JSON

Parameters:

Returns:

Promise:

With {*}

getPromise

() Promise

Inherited from ConnectionAdapter: lib/connectionAdapter/connectionAdapter.js:72

Gets the source-adapter promise

Returns:

Promise:

hasBucket

(
  • bucket
  • [filterFn]
)
Promise

Inherited from ConnectionAdapter but overwritten in lib/connectionAdapter/riakConnectionAdapter.js:75

Does the instance have a specific bucket?

Parameters:

Returns:

Promise:

With {boolean} Bucket exists?

hasBucketKey

(
  • bucket
  • key
  • [filterFn]
)
Promise

Inherited from ConnectionAdapter but overwritten in lib/connectionAdapter/riakConnectionAdapter.js:114

Does the instance have a specific key in a bucket?

Parameters:

Returns:

Promise:

With {boolean} Bucket key exists?

initialize

()

Inherited from ConnectionAdapter but overwritten in lib/connectionAdapter/riakConnectionAdapter.js:25

Initializes the source-adapter

removeAllObjects

(
  • bucket
)
Promise

Inherited from ConnectionAdapter but overwritten in lib/connectionAdapter/riakConnectionAdapter.js:218

Removes all object of a bucket

Parameters:

Returns:

Promise:

removeObject

(
  • bucket
  • key
)
Promise

Inherited from ConnectionAdapter but overwritten in lib/connectionAdapter/riakConnectionAdapter.js:201

Removes an object

Parameters:

Returns:

Promise:

setObject

(
  • bucket
  • key
  • data
  • [mimeType='application/octet-stream']
)
Promise

Inherited from ConnectionAdapter but overwritten in lib/connectionAdapter/riakConnectionAdapter.js:163

Sets an object

Parameters:

Returns:

Promise:

setObjectFromJSON

(
  • bucket
  • key
  • data
)
Promise

Inherited from ConnectionAdapter but overwritten in lib/connectionAdapter/riakConnectionAdapter.js:187

Sets an object from JSON

Parameters:

Returns:

Promise:

setPromise

(
  • promise
)

Inherited from ConnectionAdapter: lib/connectionAdapter/connectionAdapter.js:82

Sets the promise

Parameters:

  • promise Promise

Properties

TYPE

String

Inherited from ConnectionAdapter but overwritten in lib/connectionAdapter/riakConnectionAdapter.js:244

Type of class