[docs] sqlalchemy

This commit is contained in:
Romain Dorgueil
2018-01-14 16:32:06 +01:00
parent 7418ef58a3
commit 8860a7b597
2 changed files with 20 additions and 5 deletions

View File

@ -19,7 +19,24 @@ To install the extension, use the `sqlalchemy` extra:
Overview and examples
:::::::::::::::::::::
There are two main tools provided by this extension. One reader, one writer.
First, you'll need a database connection (:obj:`sqlalchemy.engine.Engine` instance), that must be provided as a service.
.. code-block:: python
import sqlalchemy
def get_services():
return {
'sqlalchemy.engine': sqlalchemy.create_engine(...)
}
The `sqlalchemy.engine` name is the default name used by the provided transformations, but you can override it (for
example if you need more than one connection) and specify the service name using `engine='myengine'` while building your
transformations.
There are two transformation classes provided by this extension.
One reader, one writer.
Let's select some data:

View File

@ -1,7 +1,5 @@
conda:
file: readthedocs-conda.yml
python:
extra_requirements:
- dev
- docker
- sqlalchemy
extra_requirements: [ dev, docker, sqlalchemy ]