Skip to content

Adds description of `lua_call option specifics #5149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 5, 2025
Merged

Adds description of `lua_call option specifics #5149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f3742c0
Adds description of ```lua_call`` option specifics
AArdeev May 30, 2025
81b0d76
Fixes yaml syntax
AArdeev May 30, 2025
1b17014
Updates by comments
AArdeev Jun 3, 2025
3deee06
Updates by comments
AArdeev Jun 4, 2025
076b849
fix typo
AArdeev Jun 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/code_snippets/snippets/config/instances.enabled/lua_call/config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
credentials:
users:
alice:
privileges:
- permissions: [execute]
lua_call: [my_func, my_func2]
12 changes: 11 additions & 1 deletion doc/reference/configuration/configuration_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1447,11 +1447,21 @@ credentials.users.*
.. confval:: <user_or_role_name>.privileges.lua_call

A list of global user-defined Lua functions that this user or a user with this role can call.
To allow calling all such functions, specify the ``all`` value.
To allow calling a specific function, specify its name as the value.
To allow calling all global Lua functions except built-in ones functions, specify the ``all`` value.

This option should be configured together with the ``execute``
:ref:`permission <configuration_reference_credentials_privileges_permissions>`.

Since version :doc:`3.3.0 </release/3.3.0>`, the ``lua_call`` option allows granting users privileges to call specified lua function on
the instance in runtime (thus it doesn't require an ability to write to the database).

Example to grant custom functions to the 'alice' user:

.. literalinclude:: /code_snippets/snippets/config/instances.enabled/lua_call/config.yaml
:language: yaml
:dedent:

.. _configuration_reference_credentials_privileges_sql:

.. confval:: <user_or_role_name>.privileges.sql
Expand Down