Table of Contents
| API Call | object.bucket_select(bucket) | ||
| Asynchronous | no | ||
| Description | Select bucket | ||
| Returns | Boolean (
Boolean (true/false)
) | ||
| Arguments | |||
bucket | Bucket name used for storing objects. | ||
| API Call | object.complete_onlineupdate() | ||
| Asynchronous | no | ||
| Description | Stop onlineupdate | ||
| Returns | Boolean (
Boolean (true/false)
) | ||
| Arguments | |||
| None | |||
| API Call | object.delete_vbucket(vbucket) | ||
| Asynchronous | no | ||
| Description | Delete vbucket | ||
| Returns | Boolean (
Boolean (true/false)
) | ||
| Arguments | |||
String vbucket | Name of the vBucket to be used for storage. | ||
| API Call | object.get_vbucket_state(vbucket) | ||
| Asynchronous | no | ||
| Description | Get vbucket state | ||
| Returns | string (
vBucket state
) | ||
| Arguments | |||
String vbucket | Name of the vBucket to be used for storage. | ||
| API Call | object.version() | ||
| Asynchronous | no | ||
| Description | Returns the versions of all servers in the server pool | ||
| Returns | array; supported values: | ||
array | Array of the version number for each memcached server in cluster | ||
| Arguments | |||
| None | |||
| API Call | object.noop() | ||
| Asynchronous | no | ||
| Description | Send a noop command | ||
| Returns | Boolean (
Boolean (true/false)
) | ||
| Arguments | |||
| None | |||
| API Call | object.sasl_auth_plain(sasl-user, sasl-password [, sasl-for-user ]) | ||
| Asynchronous | no | ||
| Description | Perform plain sasl auth | ||
| Returns | Boolean (
Boolean (true/false)
) | ||
| Arguments | |||
String sasl-user | SASL authentication user | ||
String sasl-password | SASL authentication password | ||
String sasl-for-user | SASL token for user | ||
| API Call | object.sasl_auth_start(sasl-mechanism, sasl-data) | ||
| Asynchronous | no | ||
| Description | Start a sasl auth session | ||
| Returns | Boolean (
Boolean (true/false)
) | ||
| Arguments | |||
String sasl-mechanism | SASL authentication mechanism type | ||
String sasl-data | SASL token | ||
| API Call | object.sasl_mechanisms() | ||
| Asynchronous | no | ||
| Description | Get the supported SASL methods | ||
| Returns | array (
List of objects or key/value pairs
) | ||
| Arguments | |||
| None | |||
| API Call | object.set_flush_param(flush-param-key, flush-param-value) | ||
| Asynchronous | no | ||
| Description | Set flush parameter | ||
| Returns | Boolean (
Boolean (true/false)
) | ||
| Arguments | |||
String flush-param-key | Flush parameter key | ||
String flush-param-value | Flush parameter value | ||
| API Call | object.set_tap_param(tap-key, tap-value) | ||
| Asynchronous | no | ||
| Description | Set tap parameter | ||
| Returns | Boolean (
Boolean (true/false)
) | ||
| Arguments | |||
String tap-key | TAP parameter key | ||
String tap-value | TAP parameter value | ||
| API Call | object.set_vbucket_state(vbucket, vbucket-state) | ||
| Asynchronous | no | ||
| Description | Set vbucket state | ||
| Returns | Boolean (
Boolean (true/false)
) | ||
| Arguments | |||
String vbucket | Name of the vBucket to be used for storage. | ||
String vbucket-state | State of the vBucket to be used for storage. | ||
| API Call | object.start_onlineupdate() | ||
| Asynchronous | no | ||
| Description | Start onlineupdate | ||
| Returns | Boolean (
Boolean (true/false)
) | ||
| Arguments | |||
| None | |||
| API Call | object.start_persistence() | ||
| Asynchronous | no | ||
| Description | Start persistence | ||
| Returns | Boolean (
Boolean (true/false)
) | ||
| Arguments | |||
| None | |||
| API Call | object.start_replication() | ||
| Asynchronous | no | ||
| Description | Start replication | ||
| Returns | Boolean (
Boolean (true/false)
) | ||
| Arguments | |||
| None | |||