.alter-merge table column-docstrings command
Applies to: ✅ Azure Data Explorer
Sets the DocString property for one or more columns of a specified table. Columns not explicitly defined will keep any previous definition for this property, if it exists.
Permissions
You must have at least Table Admin permissions to run this command.
Syntax
.alter-merge table TableName column-docstrings ( Col1 : DocString1 [, Col2 : DocString2]... )
Learn more about syntax conventions.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| TableName | string |
✔️ | The name of the table on which the operation is performed. |
| Col | string |
✔️ | The column on which the operation is performed. |
| DocString | string |
✔️ | Free text that you can attach to a table/function/column to describe the entity. This string is presented in various UX settings next to the entity names. |
Example
.alter-merge table Table1 column-docstrings (Column1:"DocString1", Column2:"DocString2")