list_tables#

dscat.queries.list_tables(cat, dataset, version, all_versions, role, grep)[source]#

List tables in scope, one aggregated row per logical table.

SSC’s per-role CSVs are folded into a single row whose roles lists the roles and whose n_rows sums across them.

Parameters:

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

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

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

  • all_versions (bool) – Cover every version instead of only the latest.

  • role (str or None) – Keep only this SSC family role.

  • grep (str or None) – Keep only tables whose name or title contains this substring.

Returns:

One row per table with dataset, version, table_name, display_title, roles, n_rows, n_cols, and n_files.

Return type:

collections.abc.Sequence of sqlalchemy.engine.RowMapping