These CKAN Versions are exactely matched:

• 2.10.0
• 2.10.1
• 2.10.2
• 2.10.3
• 2.10.4
• 2.10.5
• 2.10.6
• 2.10.7
• 2.10.8
• 2.10.9
• 2.11.0
• 2.11.1
• 2.11.2
• 2.11.3
• 2.11.4
• 2.12.0
• 2.9.0
• 2.9.0a
• 2.9.1
• 2.9.10
• 2.9.11
• 2.9.13
• 2.9.2
• 2.9.3
• 2.9.4
• 2.9.5
• 2.9.6
• 2.9.7
• 2.9.8
• 2.9.9

ckanext-graphql

The extension is still in development and not yet ready for production use.

Requirement: CKAN >= 2.7

This extension aims to provide a GraphQL endpoint to query the CKAN. In the future, it might be considered an alternative to the CKAN Action API.

Installation

1. Install the extension on your virtualenv:

   (pyenv) $ pip install -e git+https://github.com/metaodi/ckanext-graphql.git#egg=ckanext-graphql
   

2. Install the extension requirements:

   (pyenv) $ pip install -r ckanext-graphql/requirements.txt
   

3. Enable the required plugins in your ini file:

   ckan.plugins = graphql
   

Once the graphql plugin is loaded, a new endpoint /graphql is available on your CKAN instance.

By default, it serves GraphiQL, an in-browser IDE to create GraphQL queries.

The endpoint /graphql can be directly called with GraphQL-queries.

Example queries

Query all packages incl. groups and organization:

{
  packages {
    name
    ckanId
    organization {
      name
    }
    groups {
      edges {
        group: node {
          name
        }
      }
    }
  }
}

Search for groups or packages that contain the term bau:

{
  search(q: "bau") {
    __typename
    ... on Group {
      name
    }
    ... on Package {
      name
    }
  }
}

TODO

• [x] Support all/more models
• [x] Add support for Relay
• [x] Add travis build
• [ ] Merge PackageExtra in Package
• [x] Add possibility to search for packages or groups (see example)
• [ ] Add possibility for mutations
• [ ] Check if data should be read from Solr
• [ ] Add inte