Class: ClusterManager

ClusterManager

Class for performing management operations against a cluster.


<private> new ClusterManager(cluster, username, password)

Parameters:
Name Type Description
cluster
username
password
Since:
  • 2.0.0 (stability: committed)

Methods


createBucket(name, opts, callback)

Creates a new bucket on this cluster. Note that the callback is invoked after the bucket is created, but it may not be immediately accessible due to server spin-up time.

Parameters:
Name Type Description
name
opts
callback
Since:
  • 2.0.0 (stability: committed)

getUser(domain, userid, callback)

Retrieves a specific RBAC built-in user.

Parameters:
Name Type Description
domain
userid
callback
Since:
  • 2.3.5 (stability: committed)

getUsers(domain, callback)

Retrieves a list of RBAC built-in users on this cluster.

Parameters:
Name Type Description
domain
callback
Since:
  • 2.3.5 (stability: committed)

listBuckets(callback)

Retrieves a list of buckets present on this cluster.

Parameters:
Name Type Description
callback
Since:
  • 2.0.0 (stability: committed)

removeBucket(name, callback)

Removes a bucket from the cluster.

Parameters:
Name Type Description
name
callback
Since:
  • 2.0.0 (stability: committed)

removeUser(domain, userid, callback)

Removes an RBAC built-in user from the cluster.

Parameters:
Name Type Description
domain
userid
callback
Since:
  • 2.3.5 (stability: committed)

searchIndexManager()

Returns a SearchIndexManager for performing FTS index management on this cluster.

Since:
  • 2.4.0 (stability: uncommitted)

upsertUser(domain, userid, settings, callback)

Upserts a new RBAC user to the cluster.

Parameters:
Name Type Description
domain
userid
settings
callback
Since:
  • 2.3.5 (stability: committed)