API.md

API

• Bucket Operations
  • client.getBuckets(params, [callback])
  • client.getKeys(params, [callback])
  • client.getBucket(params, [callback])
  • client.setBucket(params, [callback])
  • client.resetBucket(params, [callback])
• Object/Key Operations
  • client.get(params, [callback])
  • client.put(params, [callback])
  • client.del(params, [callback])
• Query Operations
  • client.mapred(params, [callback])
  • client.getIndex(params, [callback])
  • client.search(params, [callback])
• Server Operations
  • client.ping([callback])
  • client.getServerInfo([callback])
• Bucket Type Operations
  • client.getBucketType(params, [callback])
  • client.setBucketType(params, [callback])
• Data Type Operations
  • client.getCrdt(params, [callback])
  • client.putCrdt(params, [callback])
• Yokozuna Operations
  • client.getSearchIndex(params, [callback])
  • client.putSearchIndex(params, [callback])
  • client.delSearchIndex(params, [callback])
  • client.getSearchSchema(params, [callback])
  • client.putSearchSchema(params, [callback])

Bucket Operations

client.getBuckets([callback])

API Reference

NOTE: Not recommended for use on production systems

List all existing buckets.

Input: None

Response: If buckets exist, RpbListBucketsResp, otherwise the empty object {}.

client.getKeys(params, [callback])

API Reference

NOTE: Not recommended for use on production systems

List all keys within a bucket. When used as a stream, this method will emit multiple data events.

Input: RpbListKeysReq

Response: If the bucket contains keys, RpbListKeysResp, otherwise the empty object {}.

client.getBucket(params, [callback])

API Reference

Get a single bucket's properties.

Input: RpbGetBucketReq

Response: RpbGetBucketResp

client.setBucket(params, [callback])

API Reference

Set properties for a single bucket.

Input: RpbSetBucketReq

Response: The empty object {}

client.resetBucket(params, [callback])

API Reference

Input: RpbResetBucketReq

Response: The empty object {}

Object/Key Operations

client.get(params, [callback])

API Reference

Input: RpbGetReq

Response: RpbGetResp

client.put(params, [callback])

API Reference

Input: RpbPutReq

Response: RpbPutResp

client.del(params, [callback])

API Reference

Input: RpbDelReq

Response: The empty object {}

Query Operations

client.mapred(params, [callback])

API Reference

Input: RpbMapRedReq

Response: RpbMapRedResp

client.getIndex(params, [callback])

API Reference

Input: RpbIndexReq

Response: RpbIndexResp

client.search(params, [callback])

API Reference

Input: RpbSearchQueryReq

Response: RpbSearchQueryResp

Server Operations

client.ping(callback)

API Reference

Send a ping to the riak node.

Input: None

Response: The empty object {}.

client.getServerInfo(callback)

API Reference

Ask the riak node for general server information.

Input: None

Response: RpbGetServerInfoResp

Bucket Type Operations

client.getBucketType(params, [callback])

API Reference

Input: RpbGetBucketTypeReq

Response: RpbGetBucketTypeResp

client.setBucketType(params, [callback])

API Reference

Input: RpbSetBucketTypeReq

Response: The empty object {}

Data Type Operations

client.getCrdt(params, [callback])

API Reference

Input: DtFetchReq

Response: DtFetchResp

client.putCrdt(params, [callback])

API Reference

Input: DtUpdateReq

Response: DtUpdateResp

Yokozuna Operations

client.getSearchIndex(params, [callback])

API Reference

Input: RpbYokozunaIndexGetReq

Response: RpbYokozunaIndexGetResp

client.putSearchIndex(params, [callback])

API Reference

Input: RpbYokozunaIndexPutReq

Response: The empty object {}

client.delSearchIndex(params, [callback])

API Reference

Input: RpbYokozunaIndexDeleteReq

Response: The empty object {}

client.getSearchSchema(params, [callback])

API Reference

Input: RpbYokozunaSchemaGetReq

Response: RpbYokozunaSchemaGetResp

client.putSearchSchema(params, [callback])

API Reference

Input: RpbYokozunaSchemaPutReq

Response: The empty object {}