Skip to content

manifest_generatable.md

Latest commit

 

History

History
69 lines (48 loc) · 1.77 KB

manifest_generatable.md

File metadata and controls

69 lines (48 loc) · 1.77 KB

ManifestGeneratable Mixin

The ManifestGeneratable mixin provides manifest TSV file generation and reading capabilities for container entities (Projects and Folders).

Overview

This mixin enables:

  • Generating manifest TSV files after syncing from Synapse
  • Uploading files from manifest TSV files
  • Validating manifest files before upload

Usage

The mixin is automatically available on Project and Folder classes:

from synapseclient.models import Project, Folder

# Project and Folder both have manifest capabilities
project = Project(id="syn123")
folder = Folder(id="syn456")

API Reference

::: synapseclient.models.mixins.manifest.ManifestGeneratable options: show_root_heading: true show_source: false members: - generate_manifest - generate_manifest_async - from_manifest - from_manifest_async - validate_manifest - validate_manifest_async - get_manifest_data - get_manifest_data_async

Constants

MANIFEST_FILENAME

The default filename for generated manifests: SYNAPSE_METADATA_MANIFEST.tsv

from synapseclient.models import MANIFEST_FILENAME

print(MANIFEST_FILENAME)  # "SYNAPSE_METADATA_MANIFEST.tsv"

DEFAULT_GENERATED_MANIFEST_KEYS

The default columns included in generated manifest files:

from synapseclient.models import DEFAULT_GENERATED_MANIFEST_KEYS

print(DEFAULT_GENERATED_MANIFEST_KEYS)
# ['path', 'parent', 'name', 'id', 'synapseStore', 'contentType',
#  'used', 'executed', 'activityName', 'activityDescription']

See Also