Skip to content

Commit

Permalink
docs(nit): Use correct PostgreSQL capitalization
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmckinney committed Jan 9, 2024
1 parent 0a2735f commit d2bd282
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Dialect-specific:
0.4.0 - December 19, 2016
-------------------------

* Modified ``example.py`` so it no longer depends on Postgres.
* Modified ``example.py`` so it no longer depends on PostgreSQL.
* It is no longer necessary to run :code:`agatesql.patch()` after importing agatesql.
* Upgrade required agate to ``1.5.0``.

Expand Down
6 changes: 4 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ For details on development or supported platforms see the `agate documentation <

.. warning::

You'll need to have the correct `sqlalchemy drivers <https://docs.sqlalchemy.org/en/rel_1_0/dialects/index.html>`_ installed for whatever database you plan to access. For instance, in order to read/write tables in a Postgres database, you'll also need to ``pip install psycopg2``.
You'll need to have the correct `SQLAlchemy drivers <https://docs.sqlalchemy.org/en/20/dialects/index.html>`_ installed for whatever database you plan to access. For instance, in order to read/write tables in a PostgreSQL database, you'll also need to ``pip install psycopg2``.

agate-sql supports all `included dialects <https://docs.sqlalchemy.org/en/20/dialects/index.html#included-dialects>`__. It is known to work with these `external dialects <https://docs.sqlalchemy.org/en/20/dialects/index.html#external-dialects>`__: CrateDB, Ingres.

Usage
=====
Expand All @@ -29,7 +31,7 @@ agate-sql uses a monkey patching pattern to add SQL support to all :class:`agate
import agate
import agatesql
Importing :mod:`.agatesql` attaches new methods to :class:`agate.Table <agate.table.Table>`. For example, to import a table named :code:`doctors` from a local postgresql database named :code:`hospitals` you will use :meth:`.from_sql`:
Importing :mod:`.agatesql` attaches new methods to :class:`agate.Table <agate.table.Table>`. For example, to import a table named :code:`doctors` from a local PostgreSQL database named :code:`hospitals` you will use :meth:`.from_sql`:

.. code-block:: python
Expand Down

0 comments on commit d2bd282

Please sign in to comment.