box.error()
box.error
throws an object that has the cdata type and contain the following
fields:
- “type” (string) error’s C++ class,
- “code” (number) error’s number,
- “message” (string) error’s message,
- “file” (string) Tarantool source file,
- “line” (number) line number in the Tarantool source file,
- “errno” (number) C standard error number; this field is added only if the error is a system error (for example, due to a failure in a socket or file i/o).
-
box.
error
{reason = string[, code = number]} When called with a Lua-table argument, the code and reason have any user-desired values. The result will be those values.
Parameters: - reason (string) – description of an error, defined by user
- code (integer) – numeric code for this error, defined by user
-
box.
error
() When called without arguments,
box.error()
re-throws whatever the last error was.
-
box.
error
(code, errtext[, errtext ...]) Emulate a request error, with text based on one of the pre-defined Tarantool errors defined in the file errcode.h in the source tree. Lua constants which correspond to those Tarantool errors are defined as members of
box.error
, for examplebox.error.NO_SUCH_USER == 45
.Parameters: - code (number) – number of a pre-defined error
- errtext(s) (string) – part of the message which will accompany the error
For example:
the
NO_SUCH_USER
message is “User '%s' is not found
” – it includes one “%s
” component which will be replaced with errtext. Thus a call tobox.error(box.error.NO_SUCH_USER, 'joe')
orbox.error(45, 'joe')
will result in an error with the accompanying message “User 'joe' is not found
”.Except: whatever is specified in errcode-number. Example:
tarantool> box.error{code = 555, reason = 'Arbitrary message'} --- - error: Arbitrary message ... tarantool> box.error() --- - error: Arbitrary message ... tarantool> box.error(box.error.FUNCTION_ACCESS_DENIED, 'A', 'B', 'C') --- - error: A access denied for user 'B' to function 'C' ...