Catalog
rerun.catalog
class CatalogClient
Client for a remote Rerun catalog server.
Note: the datafusion package is required to use this client. Initialization will fail with an error if the package
is not installed.
ctx: datafusion.SessionContext
property
Returns a DataFusion session context for querying the catalog.
def all_entries()
Returns a list of all entries in the catalog.
def create_dataset(name)
Creates a new dataset with the given name.
def dataset_entries()
Returns a list of all dataset entries in the catalog.
def dataset_names()
Returns a list of all dataset names in the catalog.
def datasets()
Returns a DataFrame containing all dataset entries in the catalog.
def entries()
Returns a DataFrame containing all entries in the catalog.
def entry_names()
Returns a list of all entry names in the catalog.
def get_dataset(*, id=None, name=None)
Returns a dataset by its ID or name.
Note: This is currently an alias for get_dataset_entry. In the future, it will return a data-oriented dataset
object instead.
def get_dataset_entry(*, id=None, name=None)
Returns a dataset by its ID or name.
def get_table(*, id=None, name=None)
Returns a table by its ID or name.
def get_table_entry(*, id=None, name=None)
Returns a table by its ID or name.
def register_table(name, url)
Registers a foreign Lance table (identified by its URL) as a new table entry with the given name.
| PARAMETER | DESCRIPTION |
|---|---|
name
|
The name of the table entry to create. It must be unique within all entries in the catalog. An exception will be raised if an entry with the same name already exists.
TYPE:
|
url
|
The URL of the Lance table to register.
TYPE:
|
def table_entries()
Returns a list of all dataset entries in the catalog.
def table_names()
Returns a list of all table names in the catalog.
def tables()
Returns a DataFrame containing all table entries in the catalog.