Extension State Snapshots


Extension Basics

Title
State Snapshots
Name
ckanext-snap
Type
Public extension
Description
Save and restore state of packages, resources, groups, etc.
CKAN versions

~2.9, ~2.10, ~2.11

Show details
Download-Url (zip)
Download-Url commit date
2024-12-01
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

Extension that provides snapshot functionality for CKAN entities, allowing you to save and restore the state of packages, resources, groups, and other objects at specific points in time. This is useful for versioning, rollback capabilities, audit trails, and preserving historical states of data. Snapshots are created using the snap_snapshot_create API action with target_id and target_type parameters. The extension supports CKAN 2.10, 2.11, and master branches (not compatible with 2.9). Comprehensive documentation available at https://datashades.github.io/ckanext-snap/ with full user guide. Dependencies include typing_extensions and pyyaml. Python 3.9+ required with support up to Python 3.14.

Version
0.0.1
Version release date
2024-12-01
Contact name
Sergey Motornyuk
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Installation: pip install ckanext-snap. Add ‘snap’ to ckan.plugins in your CKAN configuration. Create Snapshot: Use API action snap_snapshot_create with parameters target_id= and target_type=package. Example: ckanapi action snap_snapshot_create target_id= target_type=package. Supported Entities: Packages, resources, groups, and other CKAN objects. Use Cases: Versioning of datasets, rollback to previous states, audit trails, historical data preservation, backup before bulk operations. Full Documentation: https://datashades.github.io/ckanext-snap/ provides comprehensive user guide with detailed examples and API reference. Development: git clone https://github.com/DataShades/ckanext-snap.git, cd ckanext-snap, pip install -e ‘.[dev]’. Testing: pytest. Dependencies: typing_extensions, pyyaml. Python 3.9-3.14 supported. NOT compatible with CKAN 2.9 - requires CKAN 2.10+.

Plugins to configure (ckan.ini)
snap
CKAN Settings (ckan.ini)
# Keine spezifischen Umgebungsvariablen in Dokumentation erwähnt
DB migration to be executed
(not set)
<< back to Extensions