1berry/haproxy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

DOC: lua: prefer Patref:{set,add}() over legacy methods for acl and maps

Browse Source 
Patref:set() can achieve the same thing as core.set_map()
Patref:add() can achieve the same thing as core.add_acl()
Patref:del() can achieve the same thing as core.del_map() and
core.del_acl()

As a bonus, Patref:{set,add} are more efficient than their core
legacy equivalent, because they don't require systematic pattern
reference lookup for each individual operation.

Let's mention that in the doc to encourage Patref methods adoption.
This commit is contained in:
Aurelien DARRAGON 2024-11-28 17:39:00 +01:00
parent 7ff9a1c341
commit e5acb03137
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/lua-api/index.rst
View File

@ -360,6 +360,8 @@ Core class
.. js:function:: core.add_acl(name, key)
**LEGACY**
**context**: init, task, action, sample-fetch, converter
Add the ACL *key* in the ACLs list referenced by *name*.
@ -367,8 +369,14 @@ Core class
:param string name: the name that reference the ACL entries.
:param string key: the key which will be added.
.. Note::
This function is not optimal due to systematic Map reference lookup.
It is recommended to use :js:func:`Patref.add()` instead.
.. js:function:: core.del_acl(name, key)
**LEGACY**
**context**: init, task, action, sample-fetch, converter
Delete the ACL entry referenced by the key *key* in the list of ACLs
@ -377,8 +385,14 @@ Core class
:param string name: the name that reference the ACL entries.
:param string key: the key which will be deleted.
.. Note::
This function is not optimal due to systematic Map reference lookup.
It is recommended to use :js:func:`Patref.del()` instead.
.. js:function:: core.del_map(name, key)
**LEGACY**
**context**: init, task, action, sample-fetch, converter
Delete the map entry indexed with the specified key in the list of maps
@ -387,6 +401,10 @@ Core class
:param string name: the name that reference the map entries.
:param string key: the key which will be deleted.
.. Note::
This function is not optimal due to systematic Map reference lookup.
It is recommended to use :js:func:`Patref.del()` instead.
.. js:function:: core.get_info()
**context**: body, init, task, action, sample-fetch, converter
@ -840,6 +858,8 @@ Core class
.. js:function:: core.set_map(name, key, value)
**LEGACY**
**context**: init, task, action, sample-fetch, converter
Set the value *value* associated to the key *key* in the map referenced by
@ -849,6 +869,10 @@ Core class
:param string key: the key to set or replace
:param string value: the associated value
.. Note::
This function is not optimal due to systematic Map reference lookup.
It is recommended to use :js:func:`Patref.set()` instead.
.. js:function:: core.sleep(int seconds)
**context**: task, action