RESTSource type: rest#
- class lumen.sources.base.RESTSource(*, url, cache_data, cache_dir, cache_metadata, cache_per_query, cache_schema, cache_with_dask, metadata_func, root, shared, name)#
RESTSource allows querying REST endpoints conforming to the Lumen REST specification.
The url must offer two endpoints, the /data endpoint must return data in a records format while the /schema endpoint must return a valid Lumen JSON schema.
Parameters#
type: str
default: ''
URL of the REST endpoint to monitor.
Methods#
- RESTSource.clear_cache(*events: Event)#
Clears any cached data.
- RESTSource.get(table: str, **query) DataFrame#
Return a table; optionally filtered by the given query.
- Parameters:
table (str) – The name of the table to query
query (dict) – A dictionary containing all the query parameters
- Returns:
A DataFrame containing the queried table.
- Return type:
DataFrame
- RESTSource.get_metadata(table: str | list[str] | None) dict#
Returns metadata for one, multiple or all tables provided by the source.
The metadata for a table is structured as:
- {
“description”: …, “columns”: {
- <COLUMN>: {
“description”: …, “data_type”: …,
}
}, **other_metadata
}
If a list of tables or no table is provided the metadata is nested one additional level:
- {
- “table_name”: {
- {
“description”: …, “columns”: {
<COLUMN>: { “description”: …, “data_type”: …, }
}, **other_metadata
}
}
}
- Parameters:
table (str | list[str] | None) – The name of the table to return the schema for. If None returns schema for all available tables.
- Returns:
metadata – Dictionary of metadata indexed by table (if no table was was provided or individual table metdata.
- Return type:
dict
- RESTSource.get_schema(table: str | None = None, limit: int | None = None, shuffle: bool = False) dict[str, dict[str, Any]] | dict[str, Any]#
Returns JSON schema describing the tables returned by the Source.
- Parameters:
table (str | None) – The name of the table to return the schema for. If None returns schema for all available tables.
limit (int | None) – Limits the number of rows considered for the schema calculation
- Returns:
JSON schema(s) for one or all the tables.
- Return type:
dict
- RESTSource.get_tables() list[str]#
Returns the list of tables available on this source.
- Returns:
The list of available tables on this source.
- Return type:
list
- RESTSource.to_spec(context: dict[str, Any] | None = None) dict[str, Any]#
Exports the full specification to reconstruct this component.
- Return type:
Resolved and instantiated Component object