Store

class pado.io.store.StoreType(value)

An enumeration.

class pado.io.store.Store(version, store_type)

to_urlpath(df, urlpath, *, identifier=None, storage_options=None, **user_metadata)

store a pandas dataframe with an identifier and user metadata

from_urlpath(urlpath, *, storage_options=None)

load dataframe and info from urlpath

pado.io.store.get_store_type(urlpath, *, storage_options=None)

return the store type from an urlpath

pado.io.store.get_store_metadata(urlpath, *, storage_options=None)

return the store metadata from an urlpath

class pado.io.store.StoreVersionTuple(store: int, provider: int)

describing storage implementation

store: int

Alias for field number 0

provider: int

Alias for field number 1

class pado.io.store.DataVersionTuple(identifier: str, version: int)

describing stored data

identifier: str

Alias for field number 0

version: int

Alias for field number 1

class pado.io.store.StoreInfo(store_type: StoreType, store_version: StoreVersionTuple | None, data_version: DataVersionTuple | None)

version information for storage and data

store_type: StoreType

Alias for field number 0

store_version: StoreVersionTuple | None

Alias for field number 1

data_version: DataVersionTuple | None

Alias for field number 2

is_explicit()

provides all version information explicitly

to_string()

provide a short version-like string

class pado.io.store.StoreMigrationInfo(store_info: StoreInfo, target_store_version: int | None = None, target_provider_version: int | None = None, target_data_version: int | None = None)

upgrade migration information for stores

store_info: StoreInfo

Alias for field number 0

target_store_version: int | None

Alias for field number 1

target_provider_version: int | None

Alias for field number 2

target_data_version: int | None

Alias for field number 3

can_migrate(store_info)

return the new store info if migration is possible or None otherwise

Return type:

StoreInfo | None

classmethod create(store_type, data_identifier, origin, target)

convenience constructor

Return type:

StoreMigrationInfo

pado.io.store.register_store_migration(info, func)

register an upgrade migration function for a pado data provider

Return type:

None

pado.io.store.get_migration_registry()

return the upgrade migration registry

Return type:

Mapping[StoreMigrationInfo, Callable[[DataFrame, str, Dict[str, Any]], Tuple[DataFrame, str, Dict[str, Any]]]]

pado.io.store.find_migration_path(store_info, migrations)

return a store/data migration path

pado.io.store.get_store_info(urlpath, *, storage_options=None)

return the store information for a pado store

pado.io.store.migrate_store(urlpath, *, storage_options=None, dry_run=True)

try migrating a store to a newer version

pado.io.store.get_dataset_store_infos(ds)

gather store information for all stores in dataset