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>;
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 |
---|---|---|
|
TIMESTAMP_LTZ |
Creation time of the Cortex Search Service. |
|
TEXT |
Name of the service. |
|
TEXT |
The schema in which the service resides. |
|
TEXT |
The database in which the service resides. |
|
TEXT |
The warehouse used for service refreshes. |
|
TEXT |
The maximum amount of time that the service’s content should lag behind updates to the base tables. |
|
TEXT |
Any comments associated with the service. |
|
TEXT |
SQL query used to create the service. |
|
TEXT |
Name of the search column. |
|
TEXT |
Comma-separated list of attribute columns in the service. |
|
TEXT |
Comma-separated list of columns in the service. |
|
TEXT |
URL for querying the service. |
|
TIMESTAMP_LTZ |
Time at which the source data was checked for changes resulting in the currently serving index. |
|
NUMBER |
Current number of rows in the materialized source data. |
|
TEXT |
Indexing state of the service; one of SUSPENDED or RUNNING. |
|
TEXT |
Error encountered in the last indexing pipeline, if one exists. |
Examples¶
The following example describes the Cortex Search service named mysvc
:
DESCRIBE CORTEX SEARCH SERVICE mysvc;