Skip to content

Commit

Permalink
[#2226,doc][s]: correct link in templates to data api help to new doc…
Browse files Browse the repository at this point in the history
… location and tidy up storage docs.
  • Loading branch information
rufuspollock committed Mar 15, 2012
1 parent 8404bca commit f2b5a5d
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 26 deletions.
2 changes: 1 addition & 1 deletion ckan/templates/_snippet/data-api-help.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ <h3>
<div class="modal-body">
<p><strong>Access resource data via a web API with powerful query
support</strong>. Further information in the <a
href="http://docs.ckan.org/en/latest/datastore.html" target="_blank">main
href="http://docs.ckan.org/en/latest/storage/datastore.html" target="_blank">main
CKAN Data API and DataStore documentation</a>.</p>

<div class="accordion-group">
Expand Down
19 changes: 10 additions & 9 deletions doc/storage/datastore.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
=========
DataStore
=========
==========================
DataStore and the Data API
==========================

The CKAN DataStore provides a database for structured storage of data together
with a powerful Web API, all seamlessly integrated into the CKAN interface and
Expand All @@ -20,7 +20,7 @@ Relationship to FileStore
=========================

The DataStore is distinct but complementary to the FileStore (see
:doc:`file-upload`). In contrast to the the FileStore which provides 'blob'
:doc:`filestore`). In contrast to the the FileStore which provides 'blob'
storage of whole files with no way to access or query parts of that file, the
DataStore is like a database in which individual data elements are accessible
and queryable. To illustrate this distinction consider storing a spreadsheet
Expand Down Expand Up @@ -56,7 +56,7 @@ For more on searching see: http://www.elasticsearch.org/guide/reference/api/sear


Installation and Configuration
=============================
==============================

The DataStore uses ElasticSearch_ as the persistence and query layer with CKAN
wrapping this with a thin authorization and authentication layer.
Expand Down Expand Up @@ -89,19 +89,20 @@ You must add to your Nginx CKAN site entry the following::
instance (if it is not localhost and default port).

3. Enable datastore features in CKAN
-----------------------------------
------------------------------------

In your config file set::

ckan.datastore.enabled = 1

.. _datastorer:

DataStorer: Automatically Add Data to the DataStore
=================================================
===================================================

Often, when you upload data you will want it to be automatically added to the
Often, one wants data that is added to CKAN (whether it is linked to or uploaded to the :doc:`FileStore <filestore>`) to be automatically added to the
DataStore. This requires some processing, to extract the data from your files
and to add it to the DataStore in the format it understands.
and to add it to the DataStore in the format the DataStore can handle.

This task of automatically parsing and then adding data to the datastore is
performed by a DataStorer, a queue process that runs asynchronously and can be
Expand Down
23 changes: 7 additions & 16 deletions doc/storage/filestore.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
============
File uploads
============
==========================
FileStore and File Uploads
==========================

CKAN allows users to upload files directly to file storage either on the local
file system or to online 'cloud' storage like Amazon S3 or Google Storage. The
Expand Down Expand Up @@ -148,18 +148,9 @@ interact with backend storage directly::
15m.


Webstore Integration
====================

It is also possible to have uploaded CSV and Excel files stored in the Webstore
which provides a structured data store built on a relational database backend.
The configuration of this process is described at `the CKAN wiki
<http://wiki.ckan.org/Integrating_CKAN_With_Webstore>`_.

Storing data in the webstore allows for the direct retrieval of the data in a
tabular format. It is possible to fetch a single row of the data, all of the
data and have it returned in HTML, CSV or JSON format. More information and the
API documentation for the webstore is available in the `Webstore Documentation
<http://webstore.readthedocs.org/en/latest/index.html>`_.
DataStore Integration
=====================

It is also possible to have uploaded files (if of a suitable format) stored in
the DataStore which will then provides an API to the data. See :ref:`datastorer` for more details.

0 comments on commit f2b5a5d

Please sign in to comment.