diff --git a/docs/extension/sqlalchemy.rst b/docs/extension/sqlalchemy.rst index 8ee649c..fc29abc 100644 --- a/docs/extension/sqlalchemy.rst +++ b/docs/extension/sqlalchemy.rst @@ -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: diff --git a/readthedocs.yml b/readthedocs.yml index 9937b05..be95ec8 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -1,7 +1,5 @@ conda: file: readthedocs-conda.yml python: - extra_requirements: - - dev - - docker - - sqlalchemy + extra_requirements: [ dev, docker, sqlalchemy ] +