Extension Validation Schema Generator


Extension Basics

Title
Validation Schema Generator
Name
ckanext-validation-schema-generator
Type
Public extension
Description
The `ckanext-validation-schema-generator` extension for CKAN provides functionality to automatically generate table schemas for resources, specifically targeting tabular data formats.
CKAN versions

~2.9.5

Show details

These CKAN Versions are exactely matched:

Download-Url (zip)
https://github.com/qld-gov-au/ckanext-validation-schema-generator.git#egg=ckanext-validation-schema-generator
Last commit
3 months ago (2025-09-26 02:01:48)
Url to repo
https://github.com/qld-gov-au/ckanext-validation-schema-generator
Category
Data Management & Quality


Background Infos

Description (long)
Show details

ckanext-validation-schema-generator

This extension helps to generate table schema for a resource based on its content. Support tabular data. You must define a field for datasets and resources to store a table schema data. Check config options below.

Requirements

This extension has been written to work with python 2 and CKAN 2.9.5. Relies on datastore.

Compatibility with core CKAN versions:

CKAN version Compatible?
2.6 and earlier not tested
2.7 not tested
2.8 not tested
2.9.5+ yes

Suggested values:

  • “yes”
  • “not tested” - I can’t think of a reason why it wouldn’t work
  • “not yet” - there is an intention to get it working
  • “no”

Installation

TODO: Add any additional install steps to the list below. For example installing any non-Python dependencies or adding any required config settings.

To install ckanext-validation-schema-generator:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate

  2. Clone the source and install it on the virtualenv

    git clone https://github.com//ckanext-validation-schema-generator.git cd ckanext-validation-schema-generator pip install -e . pip install -r requirements.txt

  3. Add validation-schema-generator to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

  4. Restart CKAN. For example if you’ve deployed CKAN with Apache on Ubuntu:

    sudo service apache2 reload

Config settings

# The maximum time for the schema generation before it is aborted.
# Give an amount in seconds. Default is 60 minutes
# (optional, default: 3600).
ckanext.validation_schema_generator.job_timeout = 3600

# If the resource is remote or private, we could pass an API key inside headers
# This option defines should we pass API key or not
# (
Version
2.0.1
Version release date
2025-09-26
Contact name
(not set)
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

TODO: Add any additional install steps to the list below. For example installing any non-Python dependencies or adding any required config settings.

To install ckanext-validation-schema-generator:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate

  2. Clone the source and install it on the virtualenv

    git clone https://github.com//ckanext-validation-schema-generator.git cd ckanext-validation-schema-generator pip install -e .

Plugins to configure (ckan.ini)
validation_schema_generator
CKAN Settings (ckan.ini) 
# ckanext.validation_schema_generator.job_timeout = 3600
# ckanext.validation_schema_generator.pass_api_key = True
# ckanext.validation_schema_generator.api_key =

    # Field name for dataset schema field
# ckanext.validation_schema_generator.resource_schema_field_name = schema
# ckanext.validation_schema_generator.package_schema_field_name = default_data_schema
# ckanext.validation_schema_generator.allow_edit_generated_schema = False
DB migration to be executed
(not set)
<< back to Extensions