doc/book/en/devrepo/dataimport.rst
changeset 10461 37644c518705
parent 10460 d260722f2453
--- a/doc/book/en/devrepo/dataimport.rst	Fri Jun 26 16:09:27 2015 +0200
+++ b/doc/book/en/devrepo/dataimport.rst	Fri Jun 26 16:10:33 2015 +0200
@@ -1,29 +1,75 @@
-. -*- coding: utf-8 -*-
+.. -*- coding: utf-8 -*-
 
 .. _dataimport:
 
 Dataimport
 ==========
 
-*CubicWeb* is designed to manipulate huge of amount of data, and provides utilities to do so.  They
-allow to insert data within different levels of the *CubicWeb* API, allowing different
-speed/security tradeoffs. Those keeping all the *CubicWeb* hooks and security will be slower but the
-possible errors in insertion (bad data types, integrity error, ...) will be raised.
+*CubicWeb* is designed to manipulate huge of amount of data, and provides utilities to do so.
+
+The main entry point is :mod:`cubicweb.dataimport.importer` which defines an
+:class:`ExtEntitiesImporter` class responsible for importing data from an external source in the
+form :class:`ExtEntity` objects. An :class:`ExtEntity` is a transitional representation of an
+entity to be imported in the CubicWeb instance; building this representation is usually
+domain-specific -- e.g. dependent of the kind of data source (RDF, CSV, etc.) -- and is thus the
+responsibility of the end-user.
+
+Along with the importer, a *store* must be selected, which is responsible for insertion of data into
+the database. There exists different kind of stores_, allowing to insert data within different
+levels of the *CubicWeb* API and with different speed/security tradeoffs. Those keeping all the
+*CubicWeb* hooks and security will be slower but the possible errors in insertion (bad data types,
+integrity error, ...) will be handled.
+
 
-These data import utilities are provided in the package `cubicweb.dataimport`.
+Example
+-------
+
+Consider the following schema snippet.
+
+.. code-block:: python
 
-The API is built on top of the following concepts:
+    class Person(EntityType):
+        name = String(required=True)
+
+    class knows(RelationDefinition):
+        subject = 'Person'
+        object = 'Person'
+
+along with some data in a ``people.csv`` file::
 
-* `Store`, class responsible for inserting values in the backend database
+    # uri,name,knows
+    http://www.example.org/alice,Alice,
+    http://www.example.org/bob,Bob,http://www.example.org/alice
 
-* `ExtEntity`, some intermediate representation of data to import, using external identifier but no
-  eid, and usually with slightly different representation than the associated entity's schema
+The following code (using a shell context) defines a function `extentities_from_csv` to read
+`Person` external entities coming from a CSV file and calls the :class:`ExtEntitiesImporter` to
+insert corresponding entities and relations into the CubicWeb instance.
+
+.. code-block:: python
+
+    from cubicweb.dataimport import ucsvreader, RQLObjectStore
+    from cubicweb.dataimport.importer import ExtEntity, ExtEntitiesImporter
 
-* `Generator`, class or functions that will yield `ExtEntity` from some data source (eg RDF, CSV)
+    def extentities_from_csv(fpath):
+        """Yield Person ExtEntities read from `fpath` CSV file."""
+        with open(fpath) as f:
+            for uri, name, knows in ucsvreader(f, skipfirst=True, skip_empty=False):
+                yield ExtEntity('Personne', uri,
+                                {'nom': set([name]), 'connait': set([knows])})
 
-* `Importer`, class responsible for turning `ExtEntity`'s extid to eid, doing creation or update
-  accordingly and may be controlling the insertion order of entities before feeding them to a
-  `Store`
+    extenties = extentities_from_csv('people.csv')
+    store = RQLObjectStore(cnx)
+    importer = ExtEntitiesImporter(schema, store)
+    importer.import_entities(extenties)
+    commit()
+    rset = cnx.execute('String N WHERE X nom N, X connait Y, Y nom "Alice"')
+    assert rset[0][0] == u'Bob', rset
+
+Importer API
+------------
+
+.. automodule:: cubicweb.dataimport.importer
+
 
 Stores
 ~~~~~~
@@ -90,8 +136,3 @@
 This store relies on *COPY FROM*/execute many sql commands to directly push data using SQL commands
 rather than using the whole *CubicWeb* API. For now, **it only works with PostgresSQL** as it requires
 the *COPY FROM* command.
-
-ExtEntity and Importer
-~~~~~~~~~~~~~~~~~~~~~~
-
-.. automodule:: cubicweb.dataimport.importer