.alter table docstring command
Applies to: ✅ Azure Data Explorer
Alters the docstring value of an existing table.
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.
Note
If the table doesn't exist, an error is returned. To create a new table, see .create table
Permissions
You must have at least Table Admin permissions to run this command.
Syntax
.alter table TableName docstring Documentation
Learn more about syntax conventions.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| TableName | string |
✔️ | The name of the table to alter. |
| Documentation | string |
✔️ | Free text to describe the table. |
Example
.alter table LyricsAsTable docstring "This is the theme to Garry's show"