sprockets.clients.postgresql/docs/examples.rst
Gavin M. Roy f626d052c5 Add ease of use imports and add integration tests
- Import in psycopg2 classes into the ``sprockets.clients.postgresql`` namespace to make it easier to work with
- Add integration tests that connect to a local postgresql instance if it's running
- Update documentation a bit
2014-09-05 16:16:09 -04:00

47 lines
1.3 KiB
ReStructuredText

Examples
========
The following example sets the environment variables for connecting to
PostgreSQL on localhost to the ``postgres`` database and issues a query.
.. code:: python
import os
from sprockets.clients import postgresql
os.environ['POSTGRES_HOST'] = 'localhost'
os.environ['POSTGRES_USER'] = 'postgres'
os.environ['POSTGRES_PORT'] = 5432
os.environ['POSTGRES_DBNAME'] = 'postgres'
session = postgresql.Session('postgres')
result = session.query('SELECT 1')
print(repr(result))
The following example shows how to use the :py:class:`TornadoSession <sprockets.clients.postgresql.TornadoSession>`
class in a Tornado :py:class:`RequestHandler <tornado.web.RequestHandler>`.
.. code:: python
import os
from tornado import gen
from sprockets.clients import postgresql
from tornado import web
os.environ['POSTGRES_HOST'] = 'localhost'
os.environ['POSTGRES_USER'] = 'postgres'
os.environ['POSTGRES_PORT'] = 5432
os.environ['POSTGRES_DBNAME'] = 'postgres'
class RequestHandler(web.RequestHandler):
def initialize(self):
self.session = postgresql.TornadoSession('postgres')
@gen.coroutine
def get(self, *args, **kwargs):
result = yield self.session.query('SELECT 1')
self.write(result.as_dict())
result.free()