.show functions command
Applies to: ✅ Azure Data Explorer
Lists all the stored functions in the currently-selected database. To return only one specific function, see .show function.
Permissions
You must have at least Database User, Database Viewer, or Database Monitor to run these commands. For more information, see role-based access control.
.show functions
Syntax
.show functions
Learn more about syntax conventions.
Returns
| 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 | take 100} | MyFolder | Simple demo function |
| MyFunction2 | (myLimit: long) | {StormEvents | take myLimit} | MyFolder | Demo function with parameter |
| MyFunction3 | () | { StormEvents(100) } | MyFolder | Function calling other function |
.show function
Syntax
Lists the details of one specific stored function. For a list of all functions, see .show functions.
.show function FunctionName [with (PropertyName = PropertyValue [, ...])]
Learn more about syntax conventions.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| FunctionName | string |
✔️ | The name of stored function. |
| PropertyName/PropertyValue | string |
Indicate additional information to use when showing function details. All properties are optional. See Supported properties. |
Supported properties
| Property name | Property values | Description | Default |
|---|---|---|---|
ShowObfuscatedStrings |
true or false |
If true, obfuscated strings in function's body are shown. To use this option, you must either be a database admin or entity creator. If you don't have these permissions, the obfuscated strings are not shown. |
Defaults to false. |
Builtin |
true or false |
If true and used by the cluster admin, shows built in function(s). |
Defaults to false. |
IncludeHiddenFunctions |
true or false |
If true, show hidden function(s). |
Defaults to false. |
Returns
| 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.
Example
.show function MyFunction1 with(ShowObfuscatedStrings = true)
| Name | Parameters | Body | Folder | DocString |
|---|---|---|---|---|
| MyFunction1 | () | {StormEvents | take 100} | MyFolder | Simple demo function |