DESCRIBE CONTEXT - Kinetica Docs

Outputs the configuration of an existing SQL-GPT context.

DESCRIBE CONTEXT Syntax

DESC[RIBE] CONTEXT < [<schema name>.]<context name> | * >

Parameters

Name of the schema containing the SQL-GPT context to describe

Name of the existing SQL-GPT context for which the configuration will be output; use * instead of schema/context name to output the configuration of all contexts

Response

The response to DESCRIBE CONTEXT is a seven-column result set:

Output Column	Description
`CONTEXT_NAME`	Name of the SQL-GPT context
`OBJECT_TYPE`	Type of the context entity being described within the context
`OBJECT_NAME`	For a table entity type, the name of the table
`OBJECT_DESCRIPTION`	For a table entity type, the table comment
`OBJECT_RULES`	For a table entity type, rules associated with the table
`OBJECT_COMMENTS`	For a table entity type, the table’s column comments
`OBJECT_SAMPLES`	For a samples entity type, the list of question/answer pairs

Examples

To show the configuration for a SQL-GPT context, example.atc_ctx:

DESCRIBE CONTEXT Example

DESC CONTEXT example.atc_ctx

To show the configuration for all SQL-GPT contexts:

DESCRIBE CONTEXT (All Contexts) Example

DESC CONTEXT *

​Parameters

​Response

​Examples

Parameters

Response

Examples