How To Provide Long Description For ADX Table

Question

How can a longer description be provided and viewed, as well as possibly other information, about a table in Azure Data Explorer (ADX)?

For example,

Here_Is_An_ADX_Table

could have a description:
This table contains a row for each analysis, which is performed on a daily basis based on the BRG data resampled per the XRF rate.

Sometimes more information describing a table is necessary, and is too long to include in the table's title.

Answer 1

Hi VillarrealAndreaL,

You can use the option docstring when creating or altering a table, for example:

.create table Telemetry (DeviceID: string, Timestamp: datetime, WaterTemperature: decimal, AirHumidity: decimal)  with (docstring = "Table description")  

More information: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/management/alter-table-docstring-command