Associated with Create schema, stream, and window statements to label the columns defined by the statement.
@column column-name text
column-name: The name of a column in the associated schema, stream, or window.
text: Text to display in association with the specified column.
One or more @column documentation tags can be associated with any of the following statements to label the columns defined by the statement:
Create Schema Statement.
Create Stream Statement.
Create Window Statement.
In all cases the documentation tags must precede the statement whose columns are being labeled and should only contain references to columns defined within the statements. If a Create Stream Statement or Create Window Statement does not have any associated @column tags, but the schema used by the stream or window is tagged, the @column documentation tags associated with the schema are inherited by the window or stream.
The following example labels the Symbol and Price columns of the TradeSchema schema:
--!@column Symbol Stock Symbol --!@column Price Current Price CREATE SCHEMA TradeSchema (Symbol STRING, Price FLOAT);