Skip to content

saver module

Classes for scheduling data saves.

CSVDataSaver class

CSVDataSaver(
    data,
    save_kwargs=None,
    init_save_kwargs=None,
    **kwargs
)

Subclass of DataSaver for saving data with Data.to_csv.

Superclasses

Inherited members

init_save_data method

CSVDataSaver.init_save_data(
    **to_csv_kwargs
)

Save initial data.

save_data method

CSVDataSaver.save_data(
    **to_csv_kwargs
)

Save data.

By default, appends new data without header.

DataSaver class

DataSaver(
    data,
    save_kwargs=None,
    init_save_kwargs=None,
    **kwargs
)

Base class for scheduling data saves.

Subclasses DataUpdater.

Args

data : Data
Data instance.
save_kwargs : dict
Default keyword arguments for DataSaver.init_save_data and DataSaver.save_data.
init_save_kwargs : dict
Default keyword arguments overriding save_kwargs for DataSaver.init_save_data.
**kwargs
Keyword arguments passed to the constructor of DataUpdater.

Superclasses

Inherited members

Subclasses

init_save_data method

DataSaver.init_save_data(
    **kwargs
)

Save initial data.

This is an abstract method - override it to define custom logic.

init_save_kwargs class property

Keyword arguments passed to DataSaver.init_save_data.

save_data method

DataSaver.save_data(
    **kwargs
)

Save data.

This is an abstract method - override it to define custom logic.

save_kwargs class property

Keyword arguments passed to DataSaver.save_data.

update method

DataSaver.update(
    save_kwargs=None,
    **kwargs
)

Update and save data using DataSaver.save_data.

Override to do pre- and postprocessing.

To stop this method from running again, raise CancelledError.

update_every method

DataSaver.update_every(
    *args,
    save_kwargs=None,
    init_save=False,
    init_save_kwargs=None,
    **kwargs
)

Overrides DataUpdater to save initial data prior to updating.

DuckDBDataSaver class

DuckDBDataSaver(
    data,
    save_kwargs=None,
    init_save_kwargs=None,
    **kwargs
)

Subclass of DataSaver for saving data with Data.to_duckdb.

Superclasses

Inherited members

init_save_data method

DuckDBDataSaver.init_save_data(
    **to_duckdb_kwargs
)

Save initial data.

save_data method

DuckDBDataSaver.save_data(
    **to_duckdb_kwargs
)

Save data.

By default, appends new data without header.

HDFDataSaver class

HDFDataSaver(
    data,
    save_kwargs=None,
    init_save_kwargs=None,
    **kwargs
)

Subclass of DataSaver for saving data with Data.to_hdf.

Superclasses

Inherited members

init_save_data method

HDFDataSaver.init_save_data(
    **to_hdf_kwargs
)

Save initial data.

save_data method

HDFDataSaver.save_data(
    **to_hdf_kwargs
)

Save data.

By default, appends new data in a table format.

SQLDataSaver class

SQLDataSaver(
    data,
    save_kwargs=None,
    init_save_kwargs=None,
    **kwargs
)

Subclass of DataSaver for saving data with Data.to_sql.

Superclasses

Inherited members

init_save_data method

SQLDataSaver.init_save_data(
    **to_sql_kwargs
)

Save initial data.

save_data method

SQLDataSaver.save_data(
    **to_sql_kwargs
)

Save data.

By default, appends new data without header.