featurebyte.Catalog.activate

activate(

name: str

) -> Catalog

Description

Activates and returns a Catalog object with the provided name. Exactly one catalog is active at any time. Only assets that belong to the active catalog are accessible.

By employing a catalog, team members can effortlessly add, search, retrieve, and reuse the necessary tables, entities, features, and feature lists while obtaining comprehensive information about their properties. This information includes their type, creation date, related versions, readiness, status, and other descriptive details.

Parameters

• name: str
  Name of catalog to activate.
  
  

Returns

• Catalog
  
  

Raises

• RecordRetrievalException
  If the catalog with the provided name does not exist.
  
  

Examples

>>> catalog = Catalog.activate("grocery")
>>> catalog.list_tables()[["name", "type"]]
                name             type
0     GROCERYPRODUCT  dimension_table
1    GROCERYCUSTOMER        scd_table
2       INVOICEITEMS       item_table
3     GROCERYINVOICE      event_table