Redis Programmability Documentation by MeirShpilraien · Pull Request #1725 · redis/redis-doc

MeirShpilraien · 2021-12-30T09:27:55Z

The PR add Redis Programability documentation:

Documentation to all FUNCTION commands (notice that FUNCTION INFO is not documented because its about to be dropped on Redis Function Libraries redis#10004):
- FUNCTION LOAD (current named FUNCTION CREATE but will be renamed after this will be merged)
- FUNCTION DELETE
- FUNCTION DUMP
- FUNCTION FLUSH
- FUNCTION KILL
- FUNCTION LIST
- FUNCTION RESTORE
- FUNCTION FLUSH
Introduction to Redis Functions page
Rearrangement of EVAL command page
- All the information on EVAL command page was moved and split between 2 pages:
  - Introduction to Eval scripts
  - Lua API for Redis Scripts
New Redis programibality page

The PR also require changes on redis-io that was made here

The PR add Redis Programability documentation: * Documentation to all FUNCTION commands (notice that FUNCTION INFO is not documented because its about to be dropped): * FUNCTION LOAD (current named FUNCTION CREATE but will be renamed after [this](redis/redis#10004) will be merged) * FUNCTION DELETE * FUNCTION DUMP * FUNCTION FLUSH * FUNCTION KILL * FUNCTION LIST * FUNCTION RESTORE * FUNCTION FLUSH * Introduction to Redis Functions page * Rearrangement of `EVAL` command page * All the information on `EVAL` command page was moved and split between 2 pages: * Introduction to Eval scripts * Lua API for Redis Scripts * New Redis programibality page The PR also require changes on redis-io that was made [here](redis/redis-io#261)

MeirShpilraien · 2021-12-30T10:49:10Z

Forced pus to apply the formatter.

MeirShpilraien · 2021-12-30T11:35:59Z

Revert formatter changes according to @oranagra instructions.

…ences).

zuiderkwast

That's a lot of changes! 😅

Most of my comments are on typos/spellning/grammar. (That's what catches my attention more than the big picture...)

Regarding the overall structure: The background of Functions describing why Eval scripts are not enough should maybe not be such large part of the beginning of the Functions document? Or at least it can be placed under a sub-heading like "Why Functions?" and not be first on that page?

That background is very biased against Eval and for Functions. On the evalintro page (previously the eval command docs) a similar description is biased towards eval and against a hypothetical server-defined script functionality (written before functions existed).

Maybe it's better to put the comparison of Eval vs Functions on the programability page? Without bias to either of them, just facts?

commands/eval.md

topics/lua.md

topics/programability.md

itamarhaber · 2022-01-18T18:40:10Z

@zuiderkwast sorry for not stopping you - I was reviewing this and it took me a while to complete. Please feel free to give the updated a look.

zuiderkwast · 2022-01-18T19:22:36Z

@itamarhaber I'm assuming you have already fixed the grammar/spelling/typos I commented on, so I'll mark them all as resolved. Feel free to go though my comments and unresolve them if you find that any of them are still relevant.

oranagra

i didn't read the LDB section, i assume it's mostly copy paste from somewhere.
i didn't go over all the deleted text that was in eval.md to make sure it survived the transition (i.e. that all the valuable info there still exists somewhere).
i only skimmed though the lua-api.md file (reviewed it's top part, but not all the gory details, which i assume are mostly copy-paste)

commands/function-create.md

commands/function-stats.md

commands/function-list.md

topics/functions-intro.md

topics/lua-api.md

oranagra · 2022-01-18T20:57:02Z

@itamarhaber I'm assuming you have already fixed the grammar/spelling/typos I commented on, so I'll mark them all as resolved. Feel free to go though my comments and unresolve them if you find that any of them are still relevant.

while reviewing it myself (in the files tab on github), i saw quite a few of @zuiderkwast's wording comment still showing. i think this means that they where probably commented on lines that @itamarhaber didn't change in his edit.

that said, i mostly care now about the right content that tells the story correctly and doesn't miss any important detail, and less about wording 😄

itamarhaber · 2022-01-18T21:56:25Z

@oranagra all of @zuiderkwast's comments were marked as outdated for me, and I took care when resolving them one by one to make sure I edited them (even if not according to the comment's suggestion).

Let future readers proof-read this /wink wink, nudge nudge @banker & @elena-kolevska

oranagra · 2022-01-18T22:18:49Z

i suggest holding back the call for additional reviewer until after some of my comments are addressed.

commands/evalsha_ro.md

commands/fcall_ro.md

commands/function-create.md

* lua-api.md * Splitted `redis.register_function` to positional argument and named arguments * Added redis.REDIS_VERSION API documentaion * Added redis.REDIS_VERSION_NUM API documentaion * functions-into.md * Added section about functions flags with example and flags documentation.

…md as its not relevant to functions.

topics/functions-intro.md

topics/lua-api.md

topics/functions-intro.md

topics/lua-api.md

oranagra · 2022-01-23T12:54:09Z

topics/lua-api.md

-For more information about function flags refer to [Function Flags](functions-intro#function-flags)
+#### <a name="script_flags"></a> Script Flags
+
+The following is a list of supported script flags:


i think we should mention the default.
i.e. on functions, all these flags are off by default.
on eval... when shebang is used, it's the same, but if it's not used, it's a different story (maybe refer to another section)
@yoav-steinberg FYI

Co-authored-by: Oran Agra <oran@redislabs.com>

zuiderkwast · 2022-01-25T07:39:15Z

commands/function-stats.md

+  Otherwise, this is a map with the following keys:
+  * **name:** the name of the function.
+  * **command:** the command and arguments used for invoking the function.
+  * **duration_ms:** the function's runtime duration in milliseconds.
+2. `engines`: this is an array of simple strings.


Blanks needed for correct rendering of the list IIRC.

Suggested change

Otherwise, this is a map with the following keys:

* **name:** the name of the function.

* **command:** the command and arguments used for invoking the function.

* **duration_ms:** the function's runtime duration in milliseconds.

2. `engines`: this is an array of simple strings.

Otherwise, this is a map with the following keys:

* **name:** the name of the function.

* **command:** the command and arguments used for invoking the function.

* **duration_ms:** the function's runtime duration in milliseconds.

2. `engines`: this is an array of simple strings.

zuiderkwast · 2022-01-25T07:42:47Z

topics/lua-api.md

+By default, Redis assumes that all functions read and write data.
+This results in the following behavior:
+
+1. Functions can read and write data.
+1. Functions can run in cluster mode.
+1. Execution against a stale replica is denied to avoid inconsistent reads.
+1. Execution under low memory is denied to avoid exceeding the configured threshold.


Add that it's denied in a read-only replica?

zuiderkwast · 2022-01-25T07:43:25Z

topics/lua-api.md

+    Lastly, when data persistence is at risk due to a disk error, execution is blocked as well.
+
+    Using this flag allows executing the function:
+    1. With `FCALL_RO` against masters and read-only replicas.


Suggested change

1. With `FCALL_RO` against masters and read-only replicas.

1. With `FCALL_RO` against masters and read-only replicas.

topics/lua-api.md

topics/functions-intro.md

topics/lua-api.md

enjoy-binbin · 2022-01-28T03:11:17Z

remember not to forget those new INFO fields, i mention it in #1748

…y_docs

MeirShpilraien requested a review from itamarhaber December 30, 2021 09:30

meir added 2 commits December 30, 2021 11:55

spellcheck fixes

c7319be

spellcheck fixes

d746a36

MeirShpilraien force-pushed the redis_programibility_docs branch from d746a36 to 55026a2 Compare December 30, 2021 10:48

MeirShpilraien force-pushed the redis_programibility_docs branch from 55026a2 to d746a36 Compare December 30, 2021 11:34

Review fixes: break lines only on sentence end (or comma on long sent…

808fc5e

…ences).

oranagra added the to-be-merged should probably be merged soon label Jan 2, 2022

zuiderkwast self-requested a review January 11, 2022 13:05

zuiderkwast reviewed Jan 12, 2022

View reviewed changes

itamarhaber added 2 commits January 18, 2022 20:31

Applies edits.

b1a4168

Removes function-info.md

7fb1179

oranagra reviewed Jan 18, 2022

View reviewed changes

Typos

d4c1e88

itamarhaber changed the title ~~Redis Programability Documentation~~ Redis Programmability Documentation Jan 18, 2022

zuiderkwast reviewed Jan 19, 2022

View reviewed changes

commands/evalsha_ro.md Outdated Show resolved Hide resolved

commands/fcall_ro.md Outdated Show resolved Hide resolved

commands/function-create.md Outdated Show resolved Hide resolved

meir added 3 commits January 22, 2022 17:39

link fixes

0c8adc4

Moved Execution under low memory conditions section into eval-into.…

6c13ee9

…md as its not relevant to functions.

oranagra reviewed Jan 22, 2022

View reviewed changes

review fixes

580afbe

oranagra reviewed Jan 23, 2022

View reviewed changes

Apply suggestions from code review

670b178

Co-authored-by: Oran Agra <oran@redislabs.com>

Applies comments from review and edits.

3e36c52

zuiderkwast reviewed Jan 25, 2022

View reviewed changes

oranagra reviewed Jan 25, 2022

View reviewed changes

topics/lua-api.md Outdated Show resolved Hide resolved

topics/functions-intro.md Outdated Show resolved Hide resolved

topics/lua-api.md Outdated Show resolved Hide resolved

enjoy-binbin mentioned this pull request Jan 25, 2022

Redis INFO fields #1748

Closed

meir added 2 commits January 25, 2022 12:32

update function-stats page

3cca0f8

updated function-stats page

e9c409f

oranagra and others added 5 commits January 30, 2022 12:43

oran's comments

57888c6

Merge remote-tracking branch 'origin/master' into redis_programibilit…

9066ba4

…y_docs

fix typoes and bad links

31ffa12

Minor fixes/some editing for clarity.

3abd2e0

--cluster call, only on masters

6436dc0

oranagra merged commit 80a55ab into redis:master Jan 30, 2022

manast mentioned this pull request Feb 14, 2022

[QUESTION] Why must all keys be explicitly provided for standalone deployments in LUA scripts? redis/redis#10296

Closed

	1. With `FCALL_RO` against masters and read-only replicas.

	1. With `FCALL_RO` against masters and read-only replicas.

Conversation

MeirShpilraien commented Dec 30, 2021

Uh oh!

MeirShpilraien commented Dec 30, 2021

Uh oh!

MeirShpilraien commented Dec 30, 2021

Uh oh!

zuiderkwast left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

itamarhaber commented Jan 18, 2022

Uh oh!

zuiderkwast commented Jan 18, 2022

Uh oh!

oranagra left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

oranagra commented Jan 18, 2022

Uh oh!

itamarhaber commented Jan 18, 2022

Uh oh!

oranagra commented Jan 18, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

oranagra Jan 23, 2022

Choose a reason for hiding this comment

Uh oh!

zuiderkwast Jan 25, 2022

Choose a reason for hiding this comment

Uh oh!

zuiderkwast Jan 25, 2022

Choose a reason for hiding this comment

Uh oh!

zuiderkwast Jan 25, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

enjoy-binbin commented Jan 28, 2022

Uh oh!

Reviewers

Assignees

Labels