HG Data Warehouse Catalog

Browse the HG Insights data warehouse schema to plan an hg_data_query — returns table names, descriptions, approximate row counts, and per-column definitions (name, type, description), plus table relationships for joins.

Use this when:

• Discovering which tables and columns exist before writing SQL for hg_data_query (this is the required first step).
• Confirming a column's exact name, data type, or join key before referencing it in a query.
• Inspecting one specific table's schema — pass table_name to filter to a single table.

Do NOT use this when:

• You want to RUN a query and get rows back — call hg_data_query instead (this tool returns schema metadata only, never data).
• You need the product/technology taxonomy (categories, vendors, product IDs) — call get_product_category or get_vendor_information; those describe HG's product catalog, NOT warehouse table schemas.

Response: tables[]{name, description, approximate_row_count, columns[]{name, type, description}} and relationships[] between tables. Omit table_name to list every table; pass it to filter to one (unknown name errors and points you back to the unfiltered call).

Credits

Free — No credits consumed. See the full credit table for how AI Credits work.

Parameters

Name	Type	Default	Description
table_name	string	-	Optional exact table name (lowercase, underscores; e.g. "company_spend") to return just that table's schema. Omit to list every table. An unrecognized name errors — call with no table_name first to see valid names.

Required Integrations

This tool is only available when your organization has the following integration configured in the Phoenix Integrations settings:

• HG Insights (v2) (hginsights_v2)

Use Cases

• List every table in the HG data warehouse before deciding what to query
• Find the exact column names and types on the company_spend table to build a SQL SELECT
• Confirm which columns join contracts to duns before writing a join in hg_data_query
• Inspect a single table's schema by passing its table_name
• Discover table relationships to plan a multi-table hg_data_query

Example Usage

List all warehouse tables and columns

{
  "tool": "hg_catalog",
  "arguments": {}
}

Inspect one table's schema

{
  "tool": "hg_catalog",
  "arguments": {
    "table_name": "company_spend"
  }
}

Response Format

Field	Type	Description
tables	array	Available tables in the data warehouse.
tables[].name	string	Table name.
tables[].description	string	Table description.
tables[].approximate_row_count	number	Approximate number of rows.
tables[].columns	array	Columns in this table.
tables[].columns[].name	string	Column name.
tables[].columns[].type	string	Column data type.
tables[].columns[].description	string	Column description.

Related Tools

hg_data_query, get_product_category, get_vendor_information