Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
P
picodata
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Container Registry
Model registry
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
core
picodata
Commits
760cbb3b
Commit
760cbb3b
authored
1 year ago
by
Yaroslav Dynnikov
Browse files
Options
Downloads
Patches
Plain Diff
doc: new table naming for lua help
parent
fc751cd0
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!575
doc: advance lua help
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
src/luamod.lua
+11
-1
11 additions, 1 deletion
src/luamod.lua
src/luamod.rs
+19
-19
19 additions, 19 deletions
src/luamod.rs
with
30 additions
and
20 deletions
src/luamod.lua
+
11
−
1
View file @
760cbb3b
...
...
@@ -4,7 +4,7 @@ setmetatable(M, help)
local
intro
=
[[
pico.help([topic])
==================
=
==================
Show built-in Picodata reference for the given topic.
...
...
@@ -12,6 +12,16 @@ Full Picodata documentation:
https://docs.picodata.io/picodata/
Params:
1. topic (optional string)
Returns:
(string)
or
(nil) if topic not found
Example:
tarantool> pico.help("help")
...
...
This diff is collapsed.
Click to expand it.
src/luamod.rs
+
19
−
19
View file @
760cbb3b
...
...
@@ -361,10 +361,10 @@ pub(crate) fn setup(args: &args::Run) {
///////////////////////////////////////////////////////////////////////////
luamod_set_help_only
(
&
l
,
"Vclock"
,
"
table
Vclock"
,
indoc!
{
"
Vclock
======
table
Vclock
======
======
Vclock is a mapping of replica id (number) to its LSN (number).
...
...
@@ -378,7 +378,7 @@ pub(crate) fn setup(args: &args::Run) {
Enabling replication makes all replicas in a replica set to exchange
their records, each with it's own LSN. Together, LSNs from different
replicas form a vector clock
(
vclock
)
. Vclock defines the database
replicas form a vector clock
—
vclock. Vclock defines the database
state of an instance.
The zero vclock component is special, it's used for tracking local
...
...
@@ -401,7 +401,7 @@ pub(crate) fn setup(args: &args::Run) {
Returns:
(table Vclock), see pico.help('Vclock')
(table Vclock), see pico.help('
table
Vclock')
Example:
...
...
@@ -428,12 +428,12 @@ pub(crate) fn setup(args: &args::Run) {
Params:
1. target (table Vclock), see pico.help('Vclock')
2. timeout
-
number
1. target (table Vclock), see pico.help('
table
Vclock')
2. timeout
(
number
), in seconds
Returns:
(table Vclock)
, see pico.help('Vclock')
(table Vclock)
or
(nil, string) in case of an error
"
},
...
...
@@ -822,7 +822,7 @@ pub(crate) fn setup(args: &args::Run) {
2. predicate (optional table)
- index (optional number), default: current applied index
- term (optional number), default: current term
- ranges (optional table {CasRange,...}), see pico.help('CasRange'),
- ranges (optional table {
table
CasRange,...}), see pico.help('
table
CasRange'),
default: {} (empty table)
See also:
...
...
@@ -915,18 +915,18 @@ pub(crate) fn setup(args: &args::Run) {
);
luamod_set_help_only
(
&
l
,
"CasRange"
,
"
table
CasRange"
,
indoc!
{
"
CasRange
========
table
CasRange
========
======
A
Lua table describing a range to be used as a
compare-and-swap
predicate, see pico.help('cas')
CasRange is a
Lua table describing a range to be used as a
compare-and-swap
predicate, see pico.help('cas')
Fields:
- space (string)
- key_min (table CasBound), see pico.help('CasBound')
- key_min (table CasBound), see pico.help('
table
CasBound')
- key_max (table CasBound)
Example:
...
...
@@ -951,13 +951,13 @@ pub(crate) fn setup(args: &args::Run) {
);
luamod_set_help_only
(
&
l
,
"CasBound"
,
"
table
CasBound"
,
indoc!
{
"
CasBound
========
table
CasBound
========
======
A Lua table representing a range bound (either min or max) used in
CasRange, see pico.help('CasRange')
CasRange, see pico.help('
table
CasRange')
Fields:
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment