Snowflake · Schema

CortexSearchService

A Snowflake cortex search service object.

Data LakesData SharingData WarehousingDatabaseSQL

Properties

Name Type Description
name string Specifies the name for the cortex search service, must be unique for the schema in which the cortex search service is created
search_column string Specifies the name of the search column for the cortex search service.
columns array Specifies all columns included in the cortex search service and that can be returned in search queries.
attribute_columns array Specifies the attribute columns, which can be referenced in filters in search queries to the cortex search service.
warehouse string Specifies the name of the warehouse that provides the compute resources for refreshing the cortex search service
definition string Specifies the definition (source query) used to create the cortex search service
comment string Specifies a comment for the cortex search service
created_on string Date and time when the cortex search service was created.
database_name string Database in which the cortex search service is stored
schema_name string Schema in which the cortex search service is stored
source_data_num_rows integer Number of rows in the materialized source data feeding into the cortex search service.
data_timestamp string Date and time as of which data existent in base tables is now serving.
indexing_error string Error encountered during the latest indexing pipeline of the cortex search service, if any.
serving_data_bytes integer Size of the serving index, in bytes.
View JSON Schema on GitHub

JSON Schema

cortex-search-service-cortex-search-service-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CortexSearchService",
  "type": "object",
  "description": "A Snowflake cortex search service object.",
  "properties": {
    "name": {
      "type": "string",
      "description": "Specifies the name for the cortex search service, must be unique for the schema in which the cortex search service is created"
    },
    "search_column": {
      "type": "string",
      "description": "Specifies the name of the search column for the cortex search service."
    },
    "columns": {
      "type": "array",
      "description": "Specifies all columns included in the cortex search service and that can be returned in search queries."
    },
    "attribute_columns": {
      "type": "array",
      "description": "Specifies the attribute columns, which can be referenced in filters in search queries to the cortex search service."
    },
    "warehouse": {
      "type": "string",
      "description": "Specifies the name of the warehouse that provides the compute resources for refreshing the cortex search service"
    },
    "definition": {
      "type": "string",
      "description": "Specifies the definition (source query) used to create the cortex search service"
    },
    "comment": {
      "type": "string",
      "description": "Specifies a comment for the cortex search service"
    },
    "created_on": {
      "type": "string",
      "description": "Date and time when the cortex search service was created."
    },
    "database_name": {
      "type": "string",
      "description": "Database in which the cortex search service is stored"
    },
    "schema_name": {
      "type": "string",
      "description": "Schema in which the cortex search service is stored"
    },
    "source_data_num_rows": {
      "type": "integer",
      "description": "Number of rows in the materialized source data feeding into the cortex search service."
    },
    "data_timestamp": {
      "type": "string",
      "description": "Date and time as of which data existent in base tables is now serving."
    },
    "indexing_error": {
      "type": "string",
      "description": "Error encountered during the latest indexing pipeline of the cortex search service, if any."
    },
    "serving_data_bytes": {
      "type": "integer",
      "description": "Size of the serving index, in bytes."
    }
  }
}