Extension Bulk


Extension Basics

Title
Bulk
Name
ckanext-bulk
Type
Public extension
Description
Bulk operations for CKAN entities
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

Perform bulk operations over CKAN entities including datasets, resources, organizations, and groups. Features include IBulk interface for custom entity managers, search with filters and global AND/OR operators, bulk update operations, bulk delete operations, CSV export for search results and operation logs (Redis-cached for 1 hour), customizable field selection via get_fields(), extensible entity manager system (DatasetEntityManager, GroupEntityManager, ResourceEntityManager, OrganizationEntityManager), override default managers or create custom ones, prepare_csv_data() hook for export customization, and Redis storage for temporary export data.

Version
0.4.1
Version release date
2024-12-01
Contact name
DataShades / Oleksandr Cherniavskyi
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Installation: pip install ckanext-bulk, add ‘bulk’ to ckan.plugins. Dependencies: typing_extensions. Requires CKAN >=2.10 (not compatible with 2.9). IBulk interface methods: register_entity_manager() to add/override managers, prepare_csv_data(data, export_type, entity_type) for CSV export customization. Entity manager requirements: extend base managers or create custom, implement get_fields() for available fields, search_entities_by_filters(filters, global_operator) for search logic, update_entity() for updates, delete_entity() for deletion. Default entity types: dataset, resource, organization, group. Export types: ‘result’ (search results), ‘logs’ (operation logs). CSV data expires after 1 hour in Redis. Custom entity example: class CustomDatasetEntityManager(DatasetEntityManager): entity_type=’dataset’, override get_fields(), search_entities_by_filters(). IMPORTANT: Load your plugin before ‘bulk’ to override prepare_csv_data(). Use cases: Batch dataset updates, bulk metadata changes, multi-entity deletion, search result exports, operation logging and audit.

Plugins to configure (ckan.ini)
bulk
CKAN Settings (ckan.ini)
(not set)
DB migration to be executed
(not set)
<< back to Extensions