CKAN v2.7.0 Release Notes

Release Date: 2017-08-02 // over 6 years ago
  • General notes:

    • Starting from this version, CKAN requires at least Postgres 9.3
    • Starting from this version, CKAN requires a Redis database. Please refer to the new ckan.redis.url <http://docs.ckan.org/en/ckan-2.7.0/maintaining/configuration.html#ckan-redis-url>_ configuration option.
    • This version requires a requirements upgrade on source installations
    • This version requires a database upgrade
    • This version requires a Solr schema upgrade
    • There are several old features being officially deprecated starting from this version. Check the Deprecations section to be prepared.

    Major changes:

    • New datatables_view resource view plugin for tabular data (#3444)
    • IDataStoreBackend plugins for replacing the default DataStore Postgres backend (#3437)
    • datastore_search new result formats and performance improvements (#3523)
    • PL/PGSQL triggers for DataStore tables (#3428)
    • DataStore dump CLI commands (#3384)
    • Wrap/override actions defined in other plugins (#3494)
    • DataStore table data dictionary stored as postgres comments (#3414)
    • Common session object for Flask and Pylons (#3208)
    • Rename deleted datasets when they conflict with new ones (#3370)
    • DataStore dump more formats: CSV, TSV, XML, JSON; BOM option (#3390)
    • Common requests code for Flask and Pylons so you can use Flask views via the new IBlueprint interface (#3212)
    • Generate complete datastore dump files (#3344)
    • A new system for asynchronous background jobs (#3165)
    • Chaining of action functions (#3494)

    Minor changes:

    • Renamed example theme plugin (#3576)
    • Localization support for groups (#3559)
    • Create new resource views when format changes (#3515)
    • Email field validation (#3568)
    • datastore_run_triggers sysadmin-only action to apply triggers to existing data (#3565)
    • Docs updated for Ubuntu 16.04 (#3544)
    • Upgrade leaflet to 0.7.7 (#3534)
    • Datapusher CLI always-answer-yes option (#3524)
    • Added docs for all plugin interfaces (#3519)
    • DataStore dumps nested columns as JSON (#3487)
    • Faster/optional datastore_search total calculation (#3467)
    • Faster group_activity_query (#3466)
    • Faster query performance (#3430)
    • Marked remaining JS strings translatable (#3423)
    • Upgrade font-awesome to 4.0.3 (#3400)
    • group/organization_show include_dataset_count option (#3385)
    • image_formats config option for image viewer (#3380)
    • click may now be used for CLI interfaces: use load_config instead of CkanCommand (#3384)
    • package_search option to return only names/ids (#3427)
    • user_list all_fields option (#3353)
    • Error controller may now be overridden (#3340)
    • Plural translations in JS (#3211)
    • Support JS translations in extensions (#3272)
    • Requirements upgraded (#3305)
    • Dockerfile updates (#3295)
    • Fix activity test to use utcnow (#3644)
    • Changed required permission from 'update' to 'manage_group' (#3631)
    • Catch invalid sort param exception (#3630)
    • Choose direction of recreated package relationship depending on its type (#3626)
    • Fix render_datetime for dates before year 1900 (#3611)
    • Fix KeyError in 'package_create' (#3027)
    • Allow slug preview to work with autocomplete fields (#2501)
    • Fix filter results button not working for organization/group (#3620)
    • Allow underscores in URL slug preview on create dataset (#3612)
    • Fallback to po file translations on h.get_translated() (#3577)
    • Fix Fanstatic URL on non-root installs (#3618)
    • Fixed escaping issues with helpers.mail_to and datapusher logs
    • Autocomplete fields are more responsive - 300ms timeout instead of 1s (#3693)
    • Fixed dataset count display for groups (#3711)
    • Restrict access to form pages (#3684)
    • Render_datetime can handle dates before year 1900 (#2228)

    API changes:

    • organization_list_for_user (and the h.organizations_available() helper) now return all organizations a user belongs to regardless of capacity (Admin, Editor or Member), not just the ones where she is an administrator (#2457)
    • organization_list_for_user (and the h.organizations_available() helper) now default to not include package_count. Pass include_dataset_count=True if you need the package_count values.
    • resource['size'] will change from string to long integer (#3205)
    • Font Awesome has been upgraded from version 3.2.1 to 4.0.3 .Please refer to https://github.com/FortAwesome/Font-Awesome/wiki/Upgrading-from-3.2.1-to-4 to upgrade your code accordingly if you are using custom themes.

    🗄 Deprecations:

    • The API versions 1 and 2 (also known as the REST API, ie /api/rest/* will removed in favour of the version 3 (action API, /api/action/*), which was introduced in CKAN 2.0. The REST API will be removed on CKAN 2.8.
    • The default theme included in CKAN core will switch to use Bootstrap 3 instead of Bootstrap 2 in CKAN 2.8. The current Bootstrap 2 based templates will still be included in the next CKAN versions, so existing themes will still work. Bootstrap 2 templates will be eventually removed though, so instances are encouraged to update their themes using the available documentation (https://getbootstrap.com/migration/)
    • The activity stream related actions ending with *_list (eg package_activity_list) and *_html (eg package_activity_list_html) will be removed in CKAN 2.8 in favour of more efficient alternatives and are now deprecated.
    • The legacy revisions controller (ie /revisions/*) will be completely removed in CKAN 2.8.
    • The old Celery based background jobs will be removed in CKAN 2.8 in favour of the new RQ based jobs (http://docs.ckan.org/en/latest/maintaining/background-tasks.html). Extensions can still of course use Celery but they will need to handle the management themselves.