swh.storage.cassandra.storage module

class swh.storage.cassandra.storage.CassandraStorage(hosts, keyspace, objstorage, port=9042, journal_writer=None, allow_overwrite=False, consistency_level='ONE', directory_entries_insert_algo='one-by-one')

Bases: object

A backend of swh-storage backed by Cassandra

Parameters

• hosts – Seed Cassandra nodes, to start connecting to the cluster

• keyspace – Name of the Cassandra database to use

• objstorage – Passed as argument to ObjStorage

• port – Cassandra port

• journal_writer – Passed as argument to JournalWriter

• allow_overwrite – Whether *_add functions will check if an object already exists in the database before sending it in an INSERT. False is the default as it is more efficient when there is a moderately high probability the object is already known, but True can be useful to overwrite existing objects (eg. when applying a schema update), or when the database is known to be mostly empty. Note that a False value does not guarantee there won’t be any overwrite.

• consistency_level – The default read/write consistency to use

• directory_entries_insert_algo – Must be one of: * one-by-one: naive, one INSERT per directory entry, serialized * concurrent: one INSERT per directory entry, concurrent * batch: using UNLOGGED BATCH to insert many entries in a few statements

check_config(*, check_write: bool) → bool

content_add(content: List[swh.model.model.Content]) → Dict[str, int]

content_update(contents: List[Dict[str, Any]], keys: List[str] = []) → None

content_add_metadata(content: List[swh.model.model.Content]) → Dict[str, int]

content_get_data(content: bytes) → Optional[bytes]

content_get_partition(partition_id: int, nb_partitions: int, page_token: Optional[str] = None, limit: int = 1000) → swh.core.api.classes.PagedResult[swh.model.model.Content, str]

content_get(contents: List[bytes], algo: str = 'sha1') → List[Optional[swh.model.model.Content]]

content_find(content: Dict[str, Any]) → List[swh.model.model.Content]

content_missing(contents: List[Dict[str, Any]], key_hash: str = 'sha1') → Iterable[bytes]

content_missing_per_sha1(contents: List[bytes]) → Iterable[bytes]

content_missing_per_sha1_git(contents: List[bytes]) → Iterable[bytes]

content_get_random() → bytes

skipped_content_add(content: List[swh.model.model.SkippedContent]) → Dict[str, int]

skipped_content_missing(contents: List[Dict[str, Any]]) → Iterable[Dict[str, Any]]

directory_add(directories: List[swh.model.model.Directory]) → Dict[str, int]

directory_missing(directories: List[bytes]) → Iterable[bytes]

directory_entry_get_by_path(directory: bytes, paths: List[bytes]) → Optional[Dict[str, Any]]

directory_ls(directory: bytes, recursive: bool = False) → Iterable[Dict[str, Any]]

directory_get_entries(directory_id: bytes, page_token: Optional[bytes] = None, limit: int = 1000) → Optional[swh.core.api.classes.PagedResult[swh.model.model.DirectoryEntry, str]]

directory_get_random() → bytes

revision_add(revisions: List[swh.model.model.Revision]) → Dict[str, int]

revision_missing(revisions: List[bytes]) → Iterable[bytes]

revision_get(revision_ids: List[bytes]) → List[Optional[swh.model.model.Revision]]

revision_log(revisions: List[bytes], limit: Optional[int] = None) → Iterable[Optional[Dict[str, Any]]]

revision_shortlog(revisions: List[bytes], limit: Optional[int] = None) → Iterable[Optional[Tuple[bytes, Tuple[bytes, ...]]]]

revision_get_random() → bytes

release_add(releases: List[swh.model.model.Release]) → Dict[str, int]

release_missing(releases: List[bytes]) → Iterable[bytes]

release_get(releases: List[bytes]) → List[Optional[swh.model.model.Release]]

release_get_random() → bytes

snapshot_add(snapshots: List[swh.model.model.Snapshot]) → Dict[str, int]

snapshot_missing(snapshots: List[bytes]) → Iterable[bytes]

snapshot_get(snapshot_id: bytes) → Optional[Dict[str, Any]]

snapshot_count_branches(snapshot_id: bytes, branch_name_exclude_prefix: Optional[bytes] = None) → Optional[Dict[Optional[str], int]]

snapshot_get_branches(snapshot_id: bytes, branches_from: bytes = b'', branches_count: int = 1000, target_types: Optional[List[str]] = None, branch_name_include_substring: Optional[bytes] = None, branch_name_exclude_prefix: Optional[bytes] = None) → Optional[swh.storage.interface.PartialBranches]

snapshot_get_random() → bytes

object_find_by_sha1_git(ids: List[bytes]) → Dict[bytes, List[Dict]]

origin_get(origins: List[str]) → Iterable[Optional[swh.model.model.Origin]]

origin_get_one(origin_url: str) → Optional[swh.model.model.Origin]

Given an origin url, return the origin if it exists, None otherwise

origin_get_by_sha1(sha1s: List[bytes]) → List[Optional[Dict[str, Any]]]

origin_list(page_token: Optional[str] = None, limit: int = 100) → swh.core.api.classes.PagedResult[swh.model.model.Origin, str]

origin_search(url_pattern: str, page_token: Optional[str] = None, limit: int = 50, regexp: bool = False, with_visit: bool = False, visit_types: Optional[List[str]] = None) → swh.core.api.classes.PagedResult[swh.model.model.Origin, str]

origin_count(url_pattern: str, regexp: bool = False, with_visit: bool = False) → int

origin_add(origins: List[swh.model.model.Origin]) → Dict[str, int]

origin_visit_add(visits: List[swh.model.model.OriginVisit]) → Iterable[swh.model.model.OriginVisit]

origin_visit_status_add(visit_statuses: List[swh.model.model.OriginVisitStatus]) → Dict[str, int]

origin_visit_get(origin: str, page_token: Optional[str] = None, order: swh.storage.interface.ListOrder = ListOrder.ASC, limit: int = 10) → swh.core.api.classes.PagedResult[swh.model.model.OriginVisit, str]

origin_visit_status_get(origin: str, visit: int, page_token: Optional[str] = None, order: swh.storage.interface.ListOrder = ListOrder.ASC, limit: int = 10) → swh.core.api.classes.PagedResult[swh.model.model.OriginVisitStatus, str]

origin_visit_find_by_date(origin: str, visit_date: datetime.datetime) → Optional[swh.model.model.OriginVisit]

origin_visit_get_by(origin: str, visit: int) → Optional[swh.model.model.OriginVisit]

origin_visit_get_latest(origin: str, type: Optional[str] = None, allowed_statuses: Optional[List[str]] = None, require_snapshot: bool = False) → Optional[swh.model.model.OriginVisit]

origin_visit_status_get_latest(origin_url: str, visit: int, allowed_statuses: Optional[List[str]] = None, require_snapshot: bool = False) → Optional[swh.model.model.OriginVisitStatus]

origin_visit_status_get_random(type: str) → Optional[swh.model.model.OriginVisitStatus]

stat_counters()

refresh_stat_counters()

raw_extrinsic_metadata_add(metadata: List[swh.model.model.RawExtrinsicMetadata]) → Dict[str, int]

raw_extrinsic_metadata_get(target: swh.model.swhids.ExtendedSWHID, authority: swh.model.model.MetadataAuthority, after: Optional[datetime.datetime] = None, page_token: Optional[bytes] = None, limit: int = 1000) → swh.core.api.classes.PagedResult[swh.model.model.RawExtrinsicMetadata, str]

raw_extrinsic_metadata_get_by_ids(ids: List[bytes]) → List[swh.model.model.RawExtrinsicMetadata]

raw_extrinsic_metadata_get_authorities(target: swh.model.swhids.ExtendedSWHID) → List[swh.model.model.MetadataAuthority]

metadata_fetcher_add(fetchers: List[swh.model.model.MetadataFetcher]) → Dict[str, int]

metadata_fetcher_get(name: str, version: str) → Optional[swh.model.model.MetadataFetcher]

metadata_authority_add(authorities: List[swh.model.model.MetadataAuthority]) → Dict[str, int]

metadata_authority_get(type: swh.model.model.MetadataAuthorityType, url: str) → Optional[swh.model.model.MetadataAuthority]

extid_add(ids: List[swh.model.model.ExtID]) → Dict[str, int]

extid_get_from_extid(id_type: str, ids: List[bytes], version: Optional[int] = None) → List[swh.model.model.ExtID]

extid_get_from_target(target_type: swh.model.swhids.ObjectType, ids: List[bytes], extid_type: Optional[str] = None, extid_version: Optional[int] = None) → List[swh.model.model.ExtID]

clear_buffers(object_types: Sequence[str] = ()) → None

Do nothing

flush(object_types: Sequence[str] = ()) → Dict[str, int]