Custom error types | Tarantool

Custom error types

Custom error types

From above you know that errors can be created in two ways: with and with box.error().

Both methods can take arguments either as a list (code, reason, <reason string args>):

box.error(9, 'my_space', 'reason') -- error: 'Failed to create space my_space: reason'

…or as a table ({code = code, reason = reason, ...}):

box.error({code = 9, reason = 'Failed to create space my_space: reason'})

It is also possible to specify your own type of errors instead of pre-defined ones. Put a string with your type in the type field if you pass arguments as a table, or instead of the code parameter if you use listing:

box.error('MyErrorType', 'Message')
box.error({type = 'MyErrorType', code = 1024, reason = 'Message'})

Or a no-throw version:'MyErrorType', 'Message'){type = 'MyErrorType', code = 1024, reason = 'Message'})

When a custom type is specified, it is reported in the err.type attribute. When it is not specified, err.type reports one of built-in errors such as 'ClientError', 'OurOfMemory', etc.

The maximum name length for a custom type is 63 bytes. Everything longer than this limit is truncated.

The original error type can be checked using the err.base_type member, although normally it should not be used. For user-defined types, the base type is 'CustomError'.


tarantool> e ={type = 'MyErrorType', code = 1024, reason = 'Message'})

tarantool> e:unpack()
- code: 1024
- file: '[string "e ={type = ''MyErrorType'', code..."]'
    line: 1
type: MyErrorType
custom_type: MyErrorType
message: Message
base_type: CustomError

You can also use a format string to compose an error message for the 'CustomError' type.

box.error('MyCustomType', 'The error reason: %s', 'some error reason')