lakefs.models module

Module containing all of lakeFS data models

class lakefs.models.Change(**kwargs)[source]

Bases: LenientNamedTuple

NamedTuple representing a diff change between two refs in lakeFS

path: str
path_type: Literal['common_prefix', 'object']
size_bytes: Optional[int]
type: Literal['added', 'removed', 'changed', 'conflict', 'prefix_changed']
class lakefs.models.Commit(**kwargs)[source]

Bases: LenientNamedTuple

NamedTuple representing a lakeFS commit’s properties

committer: str
creation_date: int
id: str
message: str
meta_range_id: str
metadata: Optional[dict[str, str]] = None
parents: List[str]
class lakefs.models.CommonPrefix(**kwargs)[source]

Bases: LenientNamedTuple

Represents a common prefix in lakeFS

path: str
class lakefs.models.ImportStatus(**kwargs)[source]

Bases: LenientNamedTuple

NamedTuple representing an ongoing import’s status in lakeFS

commit: Optional[Commit]
completed: bool
error: Optional[_Error]
ingested_objects: Optional[int]
metarange_id: Optional[str]
update_time: datetime
class lakefs.models.ObjectInfo(**kwargs)[source]

Bases: LenientNamedTuple

Represent a lakeFS object’s stats

checksum: str
content_type: Optional[str] = None
metadata: Optional[dict[str, str]] = None
mtime: int
path: str
physical_address: str
physical_address_expiry: Optional[int] = None
size_bytes: Optional[int] = None
class lakefs.models.RepositoryProperties(**kwargs)[source]

Bases: LenientNamedTuple

Represent a lakeFS repository’s properties

creation_date: int
default_branch: str
id: str
storage_namespace: str
class lakefs.models.ServerStorageConfiguration(**kwargs)[source]

Bases: LenientNamedTuple

Represent a lakeFS server’s storage configuration

blockstore_id: str
blockstore_namespace_example: str
blockstore_namespace_validity_regex: str
blockstore_type: str
default_namespace_prefix: Optional[str] = None
import_support: bool
import_validity_regex: str
pre_sign_support: bool
pre_sign_support_ui: bool