.show function(s)
Lists all the stored functions in the currently-selected database. To return only one specific function, see .show function.
.show functions
.show functions
Requires database user permission.
| 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 upon function invocation. |
| 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. |
Output example
| Name | Parameters | Body | Folder | DocString |
|---|---|---|---|---|
| MyFunction1 | () | {StormEvents | limit 100} | MyFolder | Simple demo function |
| MyFunction2 | (myLimit: long) | {StormEvents | limit myLimit} | MyFolder | Demo function with parameter |
| MyFunction3 | () | { StormEvents(100) } | MyFolder | Function calling other function |
.show function
.show function MyFunc1
Lists the details of one specific stored function. For a list of all functions, see .show functions.
Syntax
.show function FunctionName
Output
| 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 upon function invocation. |
| Folder | String | A folder used for UI functions categorization. This parameter doesn't change the way function is invoked |
| DocString | String | A description of the function for UI purposes. |
Note
- If the function does not exist, an error is returned.
- Requires database user permission.
Example
.show function MyFunction1
| Name | Parameters | Body | Folder | DocString |
|---|---|---|---|---|
| MyFunction1 | () | {StormEvents | limit 100} | MyFolder | Simple demo function |
Feedback
Submit and view feedback for