Module error

Module error¶

enum box_error_code¶

enumerator ER_UNKNOWN¶

enumerator ER_ILLEGAL_PARAMS¶

enumerator ER_MEMORY_ISSUE¶

enumerator ER_TUPLE_FOUND¶

enumerator ER_TUPLE_NOT_FOUND¶

enumerator ER_UNSUPPORTED¶

enumerator ER_NONMASTER¶

enumerator ER_READONLY¶

enumerator ER_INJECTION¶

enumerator ER_CREATE_SPACE¶

enumerator ER_SPACE_EXISTS¶

enumerator ER_DROP_SPACE¶

enumerator ER_ALTER_SPACE¶

enumerator ER_INDEX_TYPE¶

enumerator ER_MODIFY_INDEX¶

enumerator ER_LAST_DROP¶

enumerator ER_TUPLE_FORMAT_LIMIT¶

enumerator ER_DROP_PRIMARY_KEY¶

enumerator ER_KEY_PART_TYPE¶

enumerator ER_EXACT_MATCH¶

enumerator ER_INVALID_MSGPACK¶

enumerator ER_PROC_RET¶

enumerator ER_TUPLE_NOT_ARRAY¶

enumerator ER_FIELD_TYPE¶

enumerator ER_FIELD_TYPE_MISMATCH¶

enumerator ER_SPLICE¶

enumerator ER_UPDATE_ARG_TYPE¶

enumerator ER_TUPLE_IS_TOO_LONG¶

enumerator ER_UNKNOWN_UPDATE_OP¶

enumerator ER_UPDATE_FIELD¶

enumerator ER_FIBER_STACK¶

enumerator ER_KEY_PART_COUNT¶

enumerator ER_PROC_LUA¶

enumerator ER_NO_SUCH_PROC¶

enumerator ER_NO_SUCH_TRIGGER¶

enumerator ER_NO_SUCH_INDEX¶

enumerator ER_NO_SUCH_SPACE¶

enumerator ER_NO_SUCH_FIELD¶

enumerator ER_EXACT_FIELD_COUNT¶

enumerator ER_INDEX_FIELD_COUNT¶

enumerator ER_WAL_IO¶

enumerator ER_MORE_THAN_ONE_TUPLE¶

enumerator ER_ACCESS_DENIED¶

enumerator ER_CREATE_USER¶

enumerator ER_DROP_USER¶

enumerator ER_NO_SUCH_USER¶

enumerator ER_USER_EXISTS¶

enumerator ER_PASSWORD_MISMATCH¶

enumerator ER_UNKNOWN_REQUEST_TYPE¶

enumerator ER_UNKNOWN_SCHEMA_OBJECT¶

enumerator ER_CREATE_FUNCTION¶

enumerator ER_NO_SUCH_FUNCTION¶

enumerator ER_FUNCTION_EXISTS¶

enumerator ER_FUNCTION_ACCESS_DENIED¶

enumerator ER_FUNCTION_MAX¶

enumerator ER_SPACE_ACCESS_DENIED¶

enumerator ER_USER_MAX¶

enumerator ER_NO_SUCH_ENGINE¶

enumerator ER_RELOAD_CFG¶

enumerator ER_CFG¶

enumerator ER_UNUSED60¶

enumerator ER_UNUSED61¶

enumerator ER_UNKNOWN_REPLICA¶

enumerator ER_REPLICASET_UUID_MISMATCH¶

enumerator ER_INVALID_UUID¶

enumerator ER_REPLICASET_UUID_IS_RO¶

enumerator ER_INSTANCE_UUID_MISMATCH¶

enumerator ER_REPLICA_ID_IS_RESERVED¶

enumerator ER_INVALID_ORDER¶

enumerator ER_MISSING_REQUEST_FIELD¶

enumerator ER_IDENTIFIER¶

enumerator ER_DROP_FUNCTION¶

enumerator ER_ITERATOR_TYPE¶

enumerator ER_REPLICA_MAX¶

enumerator ER_INVALID_XLOG¶

enumerator ER_INVALID_XLOG_NAME¶

enumerator ER_INVALID_XLOG_ORDER¶

enumerator ER_NO_CONNECTION¶

enumerator ER_TIMEOUT¶

enumerator ER_ACTIVE_TRANSACTION¶

enumerator ER_NO_ACTIVE_TRANSACTION¶

enumerator ER_CROSS_ENGINE_TRANSACTION¶

enumerator ER_NO_SUCH_ROLE¶

enumerator ER_ROLE_EXISTS¶

enumerator ER_CREATE_ROLE¶

enumerator ER_INDEX_EXISTS¶

enumerator ER_TUPLE_REF_OVERFLOW¶

enumerator ER_ROLE_LOOP¶

enumerator ER_GRANT¶

enumerator ER_PRIV_GRANTED¶

enumerator ER_ROLE_GRANTED¶

enumerator ER_PRIV_NOT_GRANTED¶

enumerator ER_ROLE_NOT_GRANTED¶

enumerator ER_MISSING_SNAPSHOT¶

enumerator ER_CANT_UPDATE_PRIMARY_KEY¶

enumerator ER_UPDATE_INTEGER_OVERFLOW¶

enumerator ER_GUEST_USER_PASSWORD¶

enumerator ER_TRANSACTION_CONFLICT¶

enumerator ER_UNSUPPORTED_ROLE_PRIV¶

enumerator ER_LOAD_FUNCTION¶

enumerator ER_FUNCTION_LANGUAGE¶

enumerator ER_RTREE_RECT¶

enumerator ER_PROC_C¶

enumerator ER_UNKNOWN_RTREE_INDEX_DISTANCE_TYPE¶

enumerator ER_PROTOCOL¶

enumerator ER_UPSERT_UNIQUE_SECONDARY_KEY¶

enumerator ER_WRONG_INDEX_RECORD¶

enumerator ER_WRONG_INDEX_PARTS¶

enumerator ER_WRONG_INDEX_OPTIONS¶

enumerator ER_WRONG_SCHEMA_VERSION¶

enumerator ER_MEMTX_MAX_TUPLE_SIZE¶

enumerator ER_WRONG_SPACE_OPTIONS¶

enumerator ER_UNSUPPORTED_INDEX_FEATURE¶

enumerator ER_VIEW_IS_RO¶

enumerator ER_UNUSED114¶

enumerator ER_SYSTEM¶

enumerator ER_LOADING¶

enumerator ER_CONNECTION_TO_SELF¶

enumerator ER_KEY_PART_IS_TOO_LONG¶

enumerator ER_COMPRESSION¶

enumerator ER_CHECKPOINT_IN_PROGRESS¶

enumerator ER_SUB_STMT_MAX¶

enumerator ER_COMMIT_IN_SUB_STMT¶

enumerator ER_ROLLBACK_IN_SUB_STMT¶

enumerator ER_DECOMPRESSION¶

enumerator ER_INVALID_XLOG_TYPE¶

enumerator ER_ALREADY_RUNNING¶

enumerator ER_INDEX_FIELD_COUNT_LIMIT¶

enumerator ER_LOCAL_INSTANCE_ID_IS_READ_ONLY¶

enumerator ER_BACKUP_IN_PROGRESS¶

enumerator ER_READ_VIEW_ABORTED¶

enumerator ER_INVALID_INDEX_FILE¶

enumerator ER_INVALID_RUN_FILE¶

enumerator ER_INVALID_VYLOG_FILE¶

enumerator ER_CHECKPOINT_ROLLBACK¶

enumerator ER_VY_QUOTA_TIMEOUT¶

enumerator ER_PARTIAL_KEY¶

enumerator ER_TRUNCATE_SYSTEM_SPACE¶

enumerator box_error_code_MAX¶

box_error_t¶: Error - contains information about error.

const char * box_error_type(const box_error_t *error)¶

Return the error type, e.g. “ClientError”, “SocketError”, etc.

Parameters:	error (box_error_t*) – error
Returns:	not-null string

uint32_t box_error_code(const box_error_t *error)¶

Return IPROTO error code

Parameters:	error (box_error_t*) – error
Returns:	enum box_error_code

const char * box_error_message(const box_error_t *error)¶

Return the error message

Parameters:	error (box_error_t*) – error
Returns:	not-null string

box_error_t * box_error_last(void)¶

Get the information about the last API call error.

The Tarantool error handling works most like libc’s errno. All API calls return -1 or NULL in the event of error. An internal pointer to box_error_t type is set by API functions to indicate what went wrong. This value is only significant if API call failed (returned -1 or NULL).

Successful function can also touch the last error in some cases. You don’t have to clear the last error before calling API functions. The returned object is valid only until next call to any API function.

You must set the last error using box_error_set() in your stored C procedures if you want to return a custom error message. You can re-throw the last API error to IPROTO client by keeping the current value and returning -1 to Tarantool from your stored procedure.

Returns:	last error

void box_error_clear(void)¶: Clear the last error.

int box_error_set(const char *file, unsigned line, uint32_t code, const char *format, ...)¶

Set the last error.

Parameters:	*char file** (const) – line (unsigned) – code (uint32_t) – IPROTO error code *char format** (const) – ... – format arguments

Version:

Module error

Module error¶