postgres.schema.wrds_get_tables

postgres.schema.wrds_get_tables(schema, *, wrds_id=None, views=False)

Get a list of relations in a WRDS schema.

Parameters

Name Type Description Default
schema str Name of the WRDS schema to inspect. required
wrds_id str WRDS user ID used to access the WRDS PostgreSQL service. If omitted, resolve from WRDS_ID / WRDS_USER and related .env configuration. None
views bool If True, include views in addition to base tables. False

Returns

Name Type Description
list[str] Sorted relation names in the requested WRDS schema.

Examples

>>> wrds_get_tables("crsp")
>>> wrds_get_tables("comp", views=True)