register

xorq.api.register(source, table_name=None, **kwargs)

Register a data source as a table in the current backend.

Parameters

Name Type Description Default
source str | Path | pa.Table | pa.RecordBatch | pa.Dataset | pd.DataFrame The data source to register. Can be a file path, URL, or in-memory data structure. required
table_name str | None Optional name for the registered table. If not provided, a name will be inferred. None
**kwargs Any Additional keyword arguments passed to the backend’s register method.

Returns

Name Type Description
Table A table expression representing the registered data source.