awswrangler.catalog.search_tables¶
- awswrangler.catalog.search_tables(text: str, catalog_id: Optional[str] = None, boto3_session: Optional[Session] = None) Iterator[Dict[str, Any]] ¶
Get Pandas DataFrame of tables filtered by a search string.
Note
Search feature is not supported for Governed tables.
- Parameters
text (str, optional) – Select only tables with the given string in table’s properties.
catalog_id (str, optional) – The ID of the Data Catalog from which to retrieve Databases. If none is provided, the AWS account ID is used by default.
boto3_session (boto3.Session(), optional) – Boto3 Session. The default boto3 session will be used if boto3_session receive None.
- Returns
Iterator of tables.
- Return type
Iterator[Dict[str, Any]]
Examples
>>> import awswrangler as wr >>> df_tables = wr.catalog.search_tables(text='my_property')