Skip to content

QueryGenerationTable

Structure Class

QueryGenerationTable dataclass

Bases: _SerdeShape

Contains information about a table for the query engine to consider.

Attributes

columns class-attribute instance-attribute
columns: list[QueryGenerationColumn] | None = ...

An array of objects, each of which defines information about a column in the table.

description class-attribute instance-attribute
description: str | None = ...

A description of the table that helps the query engine understand the contents of the table.

inclusion class-attribute instance-attribute
inclusion: str | None = ...

Specifies whether to include or exclude the table during query generation. If you specify EXCLUDE, the table will be ignored. If you specify INCLUDE, all other tables will be ignored.

name instance-attribute
name: str

The name of the table for which the other fields in this object apply.