Document key validation and comparison key_def module functions
#4111
Comments
AArdeev
added a commit
that referenced
this issue
May 26, 2025
…t the ```key_def``` object rules Since 3.1.0, new functions are added to ```key_def``` module. ```validate_key(key)``` - validates input key against the rules ```validate_full_key(key)``` - validates input key's all fields against the rules ```compare_keys(key_a, key_b)``` - Compares two keys against each other and the rules ```validate_tuple(tuple)``` - validates the tuple against the rules Fixes #4111
AArdeev
added a commit
that referenced
this issue
May 27, 2025
* Adds description of new ```key_def``` functions comparing data against the ```key_def``` object rules * Since 3.1.0, new functions are added to ```key_def``` module. * ```validate_key(key)``` - validates input key against the rules * ```validate_full_key(key)``` - validates input key's all fields against the rules * ```compare_keys(key_a, key_b)``` - Compares two keys against each other and the rules * ```validate_tuple(tuple)``` - validates the tuple against the rules * Fixes #4111
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Related dev. issue(s): tarantool/tarantool#9863
Product: Tarantool
Since: 3.1
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/key_def/
SME: @ locker
Details
The following new functions were introduced to the
key_defLua module:key_def:validate_key(key): validates a key against a key definitionobject. Raises an exception if the key doesn't match. Returns nothing
on success. See also
box_key_def_validate_keyC API function.key_def:validate_full_key(key): validates a full key against a keydefinition object. Raises an exception if the key doesn't match.
Returns nothing on success. See also
box_key_def_validate_full_keyC API function.
key_def:validate_tuple(tuple): validates a tuple against a keydefinition object. Raises an exception if the tuple doesn't match.
Returns nothing on success. See also
box_key_def_validate_tupleC API function.
key_def:compare_keys(key_a, key_b): compares two keys according toa key definition object. Raises an exception if any of the given key
doesn't match the key definition. On success, returns a value <0 if
key_aparts are less thankey_bparts, 0 if equal, >0 if greater.Requested by @ locker in tarantool/tarantool@7e5881e.
The text was updated successfully, but these errors were encountered: