Add default values docs #4371
Merged
Add default values docs #4371
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Gumix
approved these changes
Jul 19, 2024
andreyaksenov
approved these changes
Jul 22, 2024
| -------------- | ||
|
|
||
| *Default values* are assigned to tuple fields automatically if these fields are | ||
| skipped during the tuple insert or update. |
There was a problem hiding this comment.
insert or update
Maybe, add a link to https://www.tarantool.io/en/doc/latest/concepts/data_model/operations/?
|
|
||
| To change the default values, call ``space_object.format()`` again. | ||
|
|
||
| To use a default value for a field, skip it or assign `nil`: |
There was a problem hiding this comment.
I'd place this snippet right after the books:format definition. And then we can tell about more specific things.
| books:format({ | ||
| { name = 'id', type = 'unsigned' }, | ||
| { name = 'isbn', type = 'string' }, | ||
| { name = 'title', type = 'string', default = 'No title specified' }, |
There was a problem hiding this comment.
Just an idea: as we talk about default functions here, we can remove the default parameter for title to simplify the example a bit.
Co-authored-by: Andrey Aksenov <38073144+andreyaksenov@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #3520 #3617
Add default values documentation:
defaultanddefault_funcdefault_valuesDeployment: https://docs.d.tarantool.io/en/doc/gh-3520-default-values-funcs/concepts/data_model/value_store/#default-values