Update docs to cover modifying functions. #8106
Conversation
dnwpark
force-pushed
the
docs-function-dml
branch
from
bc310ba to
7fc908e
Compare
docs/datamodel/functions.rst
Outdated
| Unlike other functions, the arguments of modifying functions **must** have a | ||
| :ref:`cardinality <_ref_reference_cardinality>` of ``One``. |
There was a problem hiding this comment.
Practical question: if some property that you're trying to insert or update is multi, does that mean you'll have to pass it as an array and unpack it? Maybe we should show this as an example?
There was a problem hiding this comment.
I've added a more general section on passing in sets as arguments as well.
docs/datamodel/computeds.rst
Outdated
| Volatile and modifying functions are not allowed in computed properties | ||
| defined in schema. This means that, for example, your schema-defined computed | ||
| property cannot call :eql:func:`datetime_current`, but it *can* call |
There was a problem hiding this comment.
Maybe we can add a link to the corresponding docs for modyfing functions so that it's clear what we refer to?
There was a problem hiding this comment.
Linked the volatility reference page and changed phrase to refer to expressions in general.
| } | ||
| ); | ||
|
|
||
| then the following queries are valid: |
There was a problem hiding this comment.
| then the following queries are valid: | |
| Then the following queries are valid: |
There was a problem hiding this comment.
Not entirely sure that's customary, since it's technically the continuation of the previous sentence.
Co-authored-by: Aleksandra <[email protected]>
dnwpark
force-pushed
the
docs-function-dml
branch
from
b44ce89 to
e246a6d
Compare
dnwpark
force-pushed
the
docs-function-dml
branch
from
d72ed80 to
6fe34ef
Compare
No description provided.