describe

dscat.queries.describe(cat, table_name, dataset, version, limit, offset)

Return a table’s rows, a page of its features, and the total feature count.

Parameters:

• cat (dscat.index.Catalogue) – Open catalogue to read from.

• table_name (str) – Logical table to describe.

• dataset (str or None) – Restrict to one dataset.

• version (str or None) – Pin a version (needs dataset); the default scope is the latest.

• limit (int) – Maximum number of feature rows to return.

• offset (int) – Number of feature rows to skip, for paging.

Returns:

(tables, features, total): the matching table rows, one page of feature rows, and the total feature count for the table.

Return type:

tuple