DESCRIBE CORTEX SEARCH SERVICE¶

Describes the properties of a Cortex Search service.

DESCRIBE can be abbreviated to DESC.

Syntax¶

{ DESC | DESCRIBE } CORTEX SEARCH SERVICE <name>;

Copy

Parameters¶

name

Specifies the identifier for the Cortex Search service.

If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.

For more information, see Identifier requirements.

Output¶

The command output provides the Cortex Search service properties and metadata in the following columns:

Column	Data Type	Description
`created_on`	TIMESTAMP_LTZ	Creation time of the Cortex Search Service.
`name`	TEXT	Name of the service.
`schema_name`	TEXT	The schema in which the service resides.
`database_name`	TEXT	The database in which the service resides.
`warehouse`	TEXT	The warehouse used for service refreshes.
`target_lag`	TEXT	The maximum amount of time that the service’s content should lag behind updates to the base tables.
`comment`	TEXT	Any comments associated with the service.
`definition`	TEXT	SQL query used to create the service.
`search_column`	TEXT	Name of the search column.
`attribute_columns`	TEXT	Comma-separated list of attribute columns in the service.
`columns`	TEXT	Comma-separated list of columns in the service.
`service_query_url`	TEXT	URL for querying the service.
`data_timestamp`	TIMESTAMP_LTZ	Time at which the source data was checked for changes resulting in the currently serving index.
`source_data_num_rows`	NUMBER	Current number of rows in the materialized source data.
`indexing_state`	TEXT	Indexing state of the service; one of SUSPENDED or RUNNING.
`indexing_error`	TEXT	Error encountered in the last indexing pipeline, if one exists.
`serving_state`	TEXT	Serving state of the Cortex Search Service; one of SUSPENDED or RUNNING.

Examples¶

The following example describes the Cortex Search service named mysvc:

DESCRIBE CORTEX SEARCH SERVICE mysvc;

Copy