Explore the data catalog

The hdxdescribe command explores the Hydrolix data catalog in Splunk. Use it to list the available projects and tables in a Hydrolix cluster, or to inspect the schema of a specific table before writing queries.

Syntax

| hdxdescribe [cluster="<cluster_name>"] [table="<project_name>.<table_name>"] [project="<project_name>"]

Parameters

Parameter	Required	Description
cluster	No	The name of the Hydrolix cluster to query. Defaults to the configured default cluster.
table	No	The fully-qualified table name in project.table format. Returns the schema for that table. Mutually exclusive with project.
project	No	A Hydrolix project name. Lists all tables within that project. Mutually exclusive with table.

Note

table and project can't be used together in the same command.

Return values

Without a table argument, hdxdescribe returns one row per project. When project is specified, the result is scoped to that project but the schema is the same:

Field	Description
project	The name of the Hydrolix project.
tables	The list of table names within that project, returned as a multivalue.

With a table argument, hdxdescribe returns one row per column:

Field	Description
column_name	The name of the column.
column_type	The ClickHouse data type of the column (for example, DateTime, String, UInt64).

Example commands

| hdxdescribe

| hdxdescribe project="hydro"

| hdxdescribe cluster="cluster-1" project="hydro"

| hdxdescribe table="hydro.logs"