編集

次の方法で共有


.alter table column-docstrings command

Applies to: ✅ Microsoft FabricAzure Data Explorer

Sets the DocString property of one or more columns of the specified table. Columns not explicitly set will have this property removed.

Permissions

You must have at least Table Admin permissions to run this command.

Syntax

.alter table TableName column-docstrings ( Col1 : DocString1 [, Col2 : DocString2]... )

Learn more about syntax conventions.

Parameters

Name Type Required Description
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.
TableName string ✔️ The name of the table on which the operation is performed.
Col string ✔️ The column on which the operation is performed.

Example

.alter table Table1 column-docstrings (Column1:"DocString1", Column2:"DocString2")