Zen

Source string Source string

153/10000 · 153
English Actions
Custom error
The following ``box.error()`` overloads are available for raising a custom error:
:ref:`box.error({ reason = string[, code = number, type = string] }) <box_error-error-table>` accepts a Lua table containing the error reason, code, and type.
:ref:`box.error(type, reason[, args]) <box_error-error-array>` accepts the error type, its reason, and optional arguments passed to a reason's string.
The same overloads are available for :ref:`box.error.new() <box_error-new>`.
box.error({ reason = string[, ...] })
In the example below, ``box.error()`` accepts a Lua table with the specified error code and reason:
box.error { code = 500,
reason = 'Custom server error' }
--[[
---
- error: Custom server error
...
--]]
The next example shows how to specify a custom error type:
box.error { code = 500,
reason = 'Internal server error',
type = 'CustomInternalError' }
--[[
---
- error: Internal server error
...
--]]
When a custom type is specified, it is returned in the :ref:`error_object.type <box_error-type>` attribute. When it is not specified, ``error_object.type`` returns one of the built-in errors, such as ``ClientError`` or ``OutOfMemory``.
box.error(type, reason[, ...])
This example shows how to raise an error with the type and reason specified in the ``box.error()`` arguments:
box.error('CustomConnectionError', 'cannot connect to the given port')
--[[
---
- error: cannot connect to the given port
...
--]]
You can also use a format string to compose an error reason:
box.error('CustomConnectionError', '%s cannot connect to the port %u', 'client', 8080)
--[[
---
- error: client cannot connect to the port 8080
...
--]]
Tarantool error
The :ref:`box.error(code[, ...]) <box_error-error-predefined>` overload raises a predefined :ref:`Tarantool error <error_codes>` specified by its identifier. The error code defines the error message format and the number of required arguments. In the example below, no arguments are passed for the ``box.error.READONLY`` error code:
box.error(box.error.READONLY)
--[[
---
- error: Can't modify data on a read-only instance
...
--]]
For the ``box.error.NO_SUCH_USER`` error code, you need to pass one argument:
box.error(box.error.NO_SUCH_USER, 'John')
--[[
---
- error: User 'John' is not found
...
--]]
``box.error.CREATE_SPACE`` requires two arguments:
box.error(box.error.CREATE_SPACE, 'my_space', 'the space already exists')
--[[
---
- error: 'Failed to create space ''my_space'': the space already exists'
...
--]]
Getting the last error
To get the last raised error, call :ref:`box.error.last() <box_error-last>`:
box.error.last()
--[[
---
- error: Internal server error
...
--]]
Obtaining error details
To get error details, call the :ref:`error_object.unpack() <box_error-unpack>`. Error details may include an error code, type, message, and trace.
box.error.last():unpack()
--[[
---
- code: 500
base_type: CustomError
type: CustomInternalError
custom_type: CustomInternalError
message: Internal server error
trace:
- file: '[string "custom_error = box.error.new({ code = 500,..."]'
line: 1
...
--]]
Setting the last error
You can set the last error explicitly by calling :ref:`box.error.set() <box_error-set>`:

Loading…

User avatar None

New source string

testing_project / Documentation: reference/reference_lua/box_error — English

box.error('CustomConnectionError', '%s cannot connect to the port %u', 'client', 8080)
--[[
---
- error: client cannot connect to the port 8080
...
--]]
a year ago
Browse all string changes

Things to check

Ellipsis

The string uses three dots (...) instead of an ellipsis character (…)

Reset

Multiple unnamed variables

There are multiple unnamed variables in the string, making it impossible for translators to reorder them

Reset

Glossary

English English
No related strings found in the glossary.

String information

Flags
python-format, read-only
String age
a year ago
Last updated
a year ago
Source string age
a year ago
Translation file
string 29