DescribeTableResponse

The `DescribeTableResponse` entity.

Definition

TypeScript

interface DescribeTableResponse {
  name: string;
  columns: Array<{
    name: string;
    type: string;
    notNull: boolean;
    pk: boolean;
    defaultValue: string | null;
  }>;
  rowCount: number;
}

Fields

Field	Type	Notes
`name`	`string`	`required` — Table name.
`columns`	`Array<{ name: string; type: string; notNull: boolean; pk: boolean; defaultValue: string \| null; }>`	`required` — Ordered list of columns in the table.
`rowCount`	`number`	`required` — Current row count of the table.