.alter function docstring

Alters the DocString value of an existing function.

DocString is free text that you can attach to a table/function/column describing the entity. This string is presented in various UX settings next to the entity names.

.alter function FunctionName docstring Documentation

Note

• Requires database admin permission
• The database user who originally created the function is allowed to modify the function.
• If the function doesn't exist, an error is returned. For more information on how to create a new function, see .create function.

Output parameter	Type	Description
Name	String	The name of the function
Parameters	String	The parameters required by the function
Body	String	(Zero or more) let statements followed by a valid CSL expression that is evaluated when the function is invoked
Folder	String	A folder used for UI functions categorization. This parameter doesn't change the way the function is invoked
DocString	String	A description of the function for UI purposes

Example

.alter function MyFunction1 docstring "Updated docstring"

Name	Parameters	Body	Folder	DocString
MyFunction2	(myLimit: long)	{StormEvents | limit myLimit}	MyFolder	Updated docstring