Differential D3757 Diff 13225 swh/storage/cassandra/model.py

Changeset View

Standalone View

swh/storage/cassandra/model.py

This file was added.

				# Copyright (C) 2020 The Software Heritage developers
				# See the AUTHORS file at the top-level directory of this distribution
				# License: GNU General Public License version 3, or any later version
				# See top-level LICENSE file for more information

				"""Classes representing tables in the Cassandra database.

				They are very close to classes found in swh.model.model, but most of
				them are subtly different:

				* Large objects are split into other classes (eg. RevisionRow has no
				'parents' field, because parents are stored in a different table,
				represented by RevisionParentRow)
				* They have a "cols" field, which returns the list of column names
				of the table
				* They only use types that map directly to Cassandra's schema (ie. no enums)

				Therefore, this model doesn't reuse swh.model.model, except for types
				that can be mapped to UDTs (Person and TimestampWithTimezone).
				"""

				import dataclasses
				import datetime
				from typing import Any, Dict, List, Optional, Type, TypeVar

				from swh.model.model import Person, TimestampWithTimezone


				T = TypeVar("T", bound="BaseRow")


				class BaseRow:
				@classmethod
				def from_dict(cls: Type[T], d: Dict[str, Any]) -> T:
				return cls(**d) # type: ignore

				@classmethod
				def cols(cls) -> List[str]:
				return [field.name for field in dataclasses.fields(cls)]

				def to_dict(self) -> Dict[str, Any]:
				return dataclasses.asdict(self)


				@dataclasses.dataclass
				class ContentRow(BaseRow):
				sha1: bytes
				sha1_git: bytes
				sha256: bytes
				blake2s256: bytes
				length: int
				ctime: datetime.datetime
				status: str


				@dataclasses.dataclass
				class SkippedContentRow(BaseRow):
				sha1: Optional[bytes]
				sha1_git: Optional[bytes]
				sha256: Optional[bytes]
				blake2s256: Optional[bytes]
				length: Optional[int]
				ctime: Optional[datetime.datetime]
				status: str
				reason: str
				origin: str


				@dataclasses.dataclass
				class DirectoryRow(BaseRow):
				id: bytes


				@dataclasses.dataclass
				class DirectoryEntryRow(BaseRow):
				directory_id: bytes
				name: bytes
				target: bytes
				perms: int
				type: str


				@dataclasses.dataclass
				class RevisionRow(BaseRow):
				id: bytes
				date: Optional[TimestampWithTimezone]
				committer_date: Optional[TimestampWithTimezone]
				type: str
				directory: bytes
				message: bytes
				author: Person
				committer: Person
				synthetic: bool
				metadata: str
				extra_headers: dict


				@dataclasses.dataclass
				class RevisionParentRow(BaseRow):
				id: bytes
				parent_rank: int
				parent_id: bytes


				@dataclasses.dataclass
				class ReleaseRow(BaseRow):
				id: bytes
				target_type: str
				target: bytes
				date: TimestampWithTimezone
				name: bytes
				message: bytes
				author: Person
				synthetic: bool


				@dataclasses.dataclass
				class SnapshotRow(BaseRow):
				id: bytes


				@dataclasses.dataclass
				class SnapshotBranchRow(BaseRow):
				snapshot_id: bytes
				name: bytes
				target_type: Optional[str]
				target: Optional[bytes]


				@dataclasses.dataclass
				class OriginVisitRow(BaseRow):
				origin: str
				visit: int
				date: datetime.datetime
				type: str


				@dataclasses.dataclass
				class OriginVisitStatusRow(BaseRow):
				origin: str
				visit: int
				date: datetime.datetime
				status: str
				metadata: str
				snapshot: bytes


				@dataclasses.dataclass
				class OriginRow(BaseRow):
				sha1: bytes
				url: str
				next_visit_id: int


				@dataclasses.dataclass
				class MetadataAuthorityRow(BaseRow):
				url: str
				type: str
				metadata: str


				@dataclasses.dataclass
				class MetadataFetcherRow(BaseRow):
				name: str
				version: str
				metadata: str


				@dataclasses.dataclass
				class RawExtrinsicMetadataRow(BaseRow):
				type: str
				id: str

				authority_type: str
				authority_url: str
				discovery_date: datetime.datetime
				fetcher_name: str
				fetcher_version: str

				format: str
				metadata: bytes

				origin: Optional[str]
				visit: Optional[int]
				snapshot: Optional[str]
				release: Optional[str]
				revision: Optional[str]
				path: Optional[bytes]
				directory: Optional[str]


				@dataclasses.dataclass
				class ObjectCountRow(BaseRow):
				partition_key: int
				object_type: str
				count: int