synology_apm_repo.sdk.catalog.version module¶
Version: one db/copy_target_version row (+ _meta when
present), the queries that list or look one up, its meta-directory
resolution, and open_target_db() for the Device and FS providers.
version_spec is AES-256-CTR ciphertext whenever the repository has a
vault key (FORMAT-SPEC.md: copy_target_version.version_spec
encryption); parse_version_spec decrypts and
parses it.
- class synology_apm_repo.sdk.catalog.version.VersionMeta(target_meta_path, meta_filenames, status)¶
Bases:
objectA version’s
_metasidecar, when present: its directory, the filenames it holds, and its own status code.
- class synology_apm_repo.sdk.catalog.version.Version(version_id, version_uid, workload_id, connection_config_id, target_type, target_id, saas_stream_uuid, saas_snapshot_uuid, saas_version_id, deleted, display_name, meta)¶
Bases:
objectOne browsable
db/copy_target_versionrow (+_metawhen present).- Variables:
target_type (str) – The raw column value, normally a
TargetTypevalue.deleted (bool) – The row’s
deletedflag.display_name (str) – The backup time in local time (
"YYYY-MM-DD HH:MM:SS"), orversion_uidwhen it can’t be read.meta (synology_apm_repo.sdk.catalog.version.VersionMeta | None) – The
copy_target_version_metarow, orNonewhen none landed.
- version_uid: VersionUid¶
- workload_id: WorkloadId¶
- connection_config_id: ConnectionConfigId¶
- saas_stream_uuid: StreamUuid¶
- saas_snapshot_uuid: SnapshotUuid¶
- saas_version_id: SaasVersionId¶
- meta: VersionMeta | None¶
- synology_apm_repo.sdk.catalog.version.resolve_meta_filename(meta, name, *, ref=None)¶
Return
name(e.g."target.db") after confirming it is inmeta.meta_filenames, the meta directory’s authoritative file list (FORMAT-SPEC.md: dedup data mapping chain).- Raises:
NotFoundError –
namewas never registered for this version.
- synology_apm_repo.sdk.catalog.version.resolve_copy_meta_dir(version, repo_root)¶
The
copy_meta_file/<dir>underrepo_rootholding a device or FSversion’s meta files (target.db, …), named by the last component ofcopy_target_version_meta.target_meta_path.- Raises:
NotFoundError –
versionhas no meta row, or itstarget_meta_pathis malformed.
- async synology_apm_repo.sdk.catalog.version.open_target_db(repo, version, meta_dir)¶
Open
<meta_dir>/target.db(aHlT-enveloped or not, with any-wal/-shmsidecar; FORMAT-SPEC.md: Landing directory layout), checked againstmeta_filenames.version.metamust be set, asresolve_copy_meta_diralready required.- Raises:
NotFoundError –
target.dbis not inmeta_filenames.DataCorruptError – The file or a sidecar claims an
aHlT/zstd frame that doesn’t decode (or not to its declared size), or isaHlT-enveloped and the repository has no vault key.ResourceLimitExceededError – Its temporary copy, or a sidecar’s, doesn’t fit in free disk space with the reserve left free.
- async synology_apm_repo.sdk.catalog.version.target_version_id(target_db, meta_dir)¶
target.db’s ownversion_table.version_id.- Raises:
NotFoundError –
version_tablehas no row.
- async synology_apm_repo.sdk.catalog.version.versions(repo, workload, *, include_deleted=False)¶
workload’s browsable versions, newest backup first (the timedisplay_nameshows); one without a readable time sorts last, ties byversion_iddescending.- Raises:
DataCorruptError – A
copy_target_version_metarow’smeta_filenamesis not a JSON array.
- async synology_apm_repo.sdk.catalog.version.version_by_uid(repo, version_uid)¶
The version with
version_uid, deleted or not, decrypting only its row.Noneif it doesn’t exist or isn’t browsable.- Raises:
DataCorruptError – As
versions.
- async synology_apm_repo.sdk.catalog.version.version_file_ids(repo, version)¶
Every
fidthis version registered incopy_target_file(a PC/PS version’s disk fragments); empty when the repository has nocopy_target_versiondatabase.
- async synology_apm_repo.sdk.catalog.version.version_additional_meta(repo, version)¶
version_spec.status.additional_meta(SaaS connector bookkeeping, e.g. its object-name index), parsed;Nonewhenever it can’t be read, including when a level of it is not of its expected JSON type.
- class synology_apm_repo.sdk.catalog.version.ParsedVersionStatus(status=None, start_time=None, end_time=None)¶
Bases:
objectThe
version_spec.statusfields this module reads, named as the JSON keys.
- synology_apm_repo.sdk.catalog.version.parse_version_spec(version_spec_raw, version_uid, vault_key)¶
One
copy_target_version.version_specvalue, decrypted whenevervault_keyis given (the column has no marker to probe) and JSON-parsed;Noneon any failure.