module Aerospike::ResultCode

Constants

BATCH_DISABLED

Batch functionality has been disabled by configuring the batch-index-thread=0.

BATCH_FAILED

One or more keys failed in a batch.

BATCH_MAX_REQUESTS

Batch max requests has been exceeded.

BATCH_QUEUES_FULL

All batch queues are full.

BIN_EXISTS_ERROR

Bin already exists on a create-only operation.

BIN_NAME_TOO_LONG

Sent too-long bin name (>15, should be impossible in this client) or exceeded namespace’s bin name quota.

BIN_NOT_FOUND

Bin not found on update-only operation.

BIN_TYPE_ERROR

Operation is not supported with configured bin type (single-bin or multi-bin).

CLUSTER_KEY_MISMATCH

Expected cluster ID was not received.

CLUSTER_NAME_MISMATCH_ERROR

Cluster Name does not match the ClientPolicy.ClusterName value.

COMMAND_REJECTED

Asynchronous max concurrent database commands have been exceeded and therefore rejected.

COMMON_ERROR

A common, none-aerospike error. Checked the wrapped error for detail.

DEVICE_OVERLOAD

Specified bin name does not exist in record.

ELEMENT_EXISTS

Returned by Map put and put_items operations when policy is CREATE_ONLY but key already exists

ELEMENT_NOT_FOUND

Returned by Map put and put_items operations when policy is REPLACE but key was not found

ENTERPRISE_ONLY

Enterprise-only feature not supported by the community edition

EXPIRED_PASSWORD

Password is invalid.

EXPIRED_SESSION

Expired session token.

FAIL_FORBIDDEN

Operation not allowed at this time.

FILTERED_OUT

The transaction was not performed because the predexp was false.

FORBIDDEN_PASSWORD

Password is invalid.

GENERATION_ERROR

On modifying a record with unexpected generation.

ILLEGAL_STATE
INDEX_FOUND

Secondary index already exists.

INDEX_GENERIC

Generic secondary index error.

INDEX_MAXCOUNT

Maximum number of indicies exceeded.

INDEX_NAME_MAXLEN

Index name maximum length exceeded.

INDEX_NOTFOUND

Requested secondary index does not exist.

INDEX_NOTREADABLE

Secondary index not available.

INDEX_OOM

Secondary index memory space exceeded.

INVALID_CLUSTER_PARTITION_MAP

Cluster has an invalid partition map, usually due to bad configuration.

INVALID_COMMAND

Administration command is invalid.

INVALID_CREDENTIAL

Security credential is invalid.

INVALID_FIELD

Administration field is invalid.

INVALID_GEOJSON

GeoJSON is malformed or not supported.

INVALID_NAMESPACE

Invalid namespace.

INVALID_NODE_ERROR

Chosen node is not currently active.

INVALID_PASSWORD

Password is invalid.

INVALID_PRIVILEGE

Privilege is invalid.

INVALID_ROLE

Role name is invalid.

INVALID_USER

User name is invalid.

INVALID_WHITELIST

Specified IP allowlist is invalid.

KEY_BUSY

Too many concurrent operations on the same record.

KEY_EXISTS_ERROR

On create-only (write unique) operations on a record that already exists.

KEY_MISMATCH

Key type mismatch.

KEY_NOT_FOUND_ERROR

On retrieving, touching or replacing a record that doesn’t exist.

LDAP_AUTHENTICATION

Error authenticating LDAP user.

LDAP_NOT_ENABLED

LDAP feature not enabled on server.

LDAP_QUERY

Error querying LDAP server.

LDAP_SETUP

Error in LDAP setup.

LDAP_TLS_SETUP

Error in LDAP TLS setup.

LOST_CONFLICT

Write command loses conflict to XDR.

MAX_ERROR_RATE

Max errors limit reached.

MAX_RETRIES_EXCEEDED

Max retries limit reached.

NETWORK_ERROR

A network error. Checked the wrapped error for detail.

NOT_AUTHENTICATED

User must be authentication before performing database operations.

NOT_WHITELISTED

Client IP address is not on the IP allowlist.

NO_AVAILABLE_CONNECTIONS_TO_NODE

There were no connections available to the node in the pool, and the pool was limited

NO_RESPONSE

No response was received from the server.

NO_XDS

XDS product is not available.

OK

Operation was successful.

OP_NOT_APPLICABLE

The operation cannot be applied to the current bin value on the server.

PARAMETER_ERROR

Bad parameter(s) were passed in database operation call.

PARSE_ERROR

Client parse error.

PARTITION_UNAVAILABLE

Partition is unavailable.

QUERY_ABORTED

Secondary index query aborted.

QUERY_DUPLICATE

Internal error.

QUERY_END

There are no more records left for query.

QUERY_GENERIC

Generic query error.

QUERY_NET_IO

Network error. Query is aborted.

QUERY_QUEUEFULL

Secondary index queue full.

QUERY_TERMINATED

Query was terminated by user.

QUERY_TIMEOUT

Secondary index query timed out on server.

RACK_NOT_DEFINED

Requested Rack for node/namespace was not defined in the cluster.

RECORDSET_CLOSED

Recordset has already been closed or cancelled

RECORD_TOO_BIG

Record size exceeds limit.

ROLE_ALREADY_EXISTS

Role Already exists

ROLE_VIOLATION

User does not posses the required role to perform the database operation.

SCAN_ABORT

Scan aborted by server.

SCAN_TERMINATED

Scan was terminated by user.

SECURITY_NOT_ENABLED

Security functionality not enabled by connected server.

SECURITY_NOT_SUPPORTED

Security functionality not supported by connected server.

SECURITY_SCHEME_NOT_SUPPORTED

Security scheme not supported.

SERIALIZE_ERROR

Client serialization error.

SERVER_ERROR

Unknown server failure.

SERVER_MEM_ERROR

Server has run out of memory.

SERVER_NOT_AVAILABLE

Server is not accepting requests.

TIMEOUT

Client or server has timed out.

TYPE_NOT_SUPPORTED

Value type not supported by Aerospike server

UDF_BAD_RESPONSE

A user defined function returned an error code.

UNSUPPORTED_FEATURE

Unsupported Server Feature (e.g. Scan + UDF)

USER_ALREADY_EXISTS

User was previously created.

XDR_KEY_BUSY

Write can’t complete until XDR finishes shipping.

Attributes

code[R]

Public Class Methods

message(code) click to toggle source
# File lib/aerospike/result_code.rb, line 305
def self.message(code)
  case code
  when BATCH_FAILED
      "one or more keys failed in a batch"

  when NO_RESPONSE
      "no response was received from the server"

  when NETWORK_ERROR
      "network error. Checked the wrapped error for detail"

  when COMMON_ERROR
      "common, none-aerospike error. Checked the wrapped error for detail"

  when MAX_RETRIES_EXCEEDED
      "Max retries exceeded"

  when MAX_ERROR_RATE
      "Max errors limit reached for node"

  when RACK_NOT_DEFINED
      "Requested Rack for node/namespace was not defined in the cluster."

  when INVALID_CLUSTER_PARTITION_MAP
      "Cluster has an invalid partition map, usually due to bad configuration."

  when SERVER_NOT_AVAILABLE
      "Server is not accepting requests."

  when CLUSTER_NAME_MISMATCH_ERROR
      "Cluster Name does not match the ClientPolicy.ClusterName value"

  when RECORDSET_CLOSED
      "Recordset has already been closed or cancelled."

  when NO_AVAILABLE_CONNECTIONS_TO_NODE
      "No available connections to the node. Connection Pool was empty, and limited to certain number of connections."

  when TYPE_NOT_SUPPORTED
      "Type cannot be converted to Value Type."

  when COMMAND_REJECTED
    "Command rejected"

  when QUERY_TERMINATED
    "Query terminated"

  when SCAN_TERMINATED
    "Scan terminated"

  when INVALID_NODE_ERROR
    "Invalid node"

  when PARSE_ERROR
    "Parse error"

  when SERIALIZE_ERROR
    "Serialize error"

  when OK
    "ok"

  when SERVER_ERROR
    "Server error"

  when KEY_NOT_FOUND_ERROR
    "Key not found"

  when GENERATION_ERROR
    "Generation error"

  when PARAMETER_ERROR
    "Parameter error"

  when KEY_EXISTS_ERROR
    "Key already exists"

  when BIN_EXISTS_ERROR
    "Bin already exists on a create-only operation"

  when CLUSTER_KEY_MISMATCH
    "Cluster key mismatch"

  when SERVER_MEM_ERROR
    "Server memory error"

  when TIMEOUT
    "Timeout"

  when NO_XDS
    "XDS not available"

  when PARTITION_UNAVAILABLE
      "Partition not available"

  when BIN_TYPE_ERROR
    "Bin type error"

  when RECORD_TOO_BIG
    "Record too big"

  when KEY_BUSY
    "Hot key"

  when SCAN_ABORT
    "Scan aborted"

  when UNSUPPORTED_FEATURE
    "Unsupported Server Feature"

  when BIN_NOT_FOUND
    "Bin not found on update-only operation"

  when DEVICE_OVERLOAD
    "Device overload"

  when KEY_MISMATCH
    "Key mismatch"

  when INVALID_NAMESPACE
    "Invalid namespace"

  when BIN_NAME_TOO_LONG
    "Sent too-long bin name or exceeded namespace's bin name quota."

  when FAIL_FORBIDDEN
    "Operation not allowed at this time"

  when ELEMENT_NOT_FOUND
    "Element not found"

  when ELEMENT_EXISTS
    "Element already exists"

  when ENTERPRISE_ONLY
    "Enterprise-only feature not supported by community edition"

  when OP_NOT_APPLICABLE
    "The operation cannot be applied to the current bin value on the server."

  when FILTERED_OUT
    "The transaction was not performed because the predexp was false."

  when LOST_CONFLICT
    "Write command loses conflict to XDR."

  # Write can't complete until XDR finishes shipping.
  when XDR_KEY_BUSY
    "XDR key busy"

  when QUERY_END
    "Query end"

  when SECURITY_NOT_SUPPORTED
    "Security not supported"

  when SECURITY_NOT_ENABLED
    "Security not enabled"

  when SECURITY_SCHEME_NOT_SUPPORTED
    "Security scheme not supported"

  when INVALID_COMMAND
    "Invalid command"

  when INVALID_FIELD
    "Invalid field"

  when ILLEGAL_STATE
    "Illegal state"

  when INVALID_USER
    "Invalid user"

  when USER_ALREADY_EXISTS
    "User already exists"

  when INVALID_PASSWORD
    "Invalid password"

  when EXPIRED_PASSWORD
    "Expired password"

  when FORBIDDEN_PASSWORD
    "Forbidden password"

  when INVALID_CREDENTIAL
    "Invalid credential"

  when EXPIRED_SESSION
    "Expired session token"

  when INVALID_ROLE
    "Invalid role"

  when ROLE_ALREADY_EXISTS
    "Role already exists"

  when INVALID_PRIVILEGE
    "Invalid privilege"

  when INVALID_WHITELIST
    "Specified IP allowlist is invalid"

  when NOT_AUTHENTICATED
    "Not authenticated"

  when ROLE_VIOLATION
    "Role violation"

  when NOT_WHITELISTED
    "Client IP address is not on the IP allowlist"

  when LDAP_NOT_ENABLED
    "LDAP feature not enabled on server"

  when LDAP_SETUP
    "Error in LDAP setup"

  when LDAP_TLS_SETUP
    "Error in LDAP TLS setup"

  when LDAP_AUTHENTICATION
    "Error authenticating LDAP user"

  when LDAP_QUERY
    "Error querying LDAP server"

  when UDF_BAD_RESPONSE
    "UDF d error"

  when BATCH_DISABLED
    "Batch functionality has been disabled by configuring the batch-index-thread=0"

  when BATCH_MAX_REQUESTS
    "Batch max requests has been exceeded"

  when BATCH_QUEUES_FULL
    "All batch queues are full"

  when INVALID_GEOJSON
    "GeoJSON is malformed or not supported"

  when INDEX_FOUND
    "Index already exists"

  when INDEX_NOTFOUND
    "Index not found"

  when INDEX_OOM
    "Index out of memory"

  when INDEX_NOTREADABLE
    "Index not readable"

  when INDEX_GENERIC
    "Index error - check server logs"

  when INDEX_NAME_MAXLEN
    "Index name max length exceeded"

  when INDEX_MAXCOUNT
    "Index count exceeds max"

  when QUERY_ABORTED
    "Query aborted"

  when QUERY_QUEUEFULL
    "Query queue full"

  when QUERY_TIMEOUT
    "Query timeout"

  when QUERY_GENERIC
    "Query error"

  when QUERY_NET_IO
    "Network error. Query is aborted"

  when QUERY_DUPLICATE
    "Internal query error"

  else
    "ResultCode #{code} unknown in the client. Please file a github issue."
  end # case
end