Skip to content

Commit

Permalink
[docs] sqlalchemy
Browse files Browse the repository at this point in the history
  • Loading branch information
hartym committed Jan 14, 2018
1 parent 7418ef5 commit 8860a7b
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 5 deletions.
19 changes: 18 additions & 1 deletion docs/extension/sqlalchemy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
6 changes: 2 additions & 4 deletions readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
conda:
file: readthedocs-conda.yml
python:
extra_requirements:
- dev
- docker
- sqlalchemy
extra_requirements: [ dev, docker, sqlalchemy ]

0 comments on commit 8860a7b

Please sign in to comment.