Skip to content

Commit 6666869

Browse files
committed
docs: add integrations, exception handling, resources
1 parent 2f08797 commit 6666869

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.rst

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,15 @@ Tutorials
5757
- `002 - Data Science Library Integrations <https://github.com/aws/amazon-redshift-python-driver/blob/master/tutorials/002%20-%20Data%20Science%20Library%20Integrations.ipynb>`_
5858
- `003 - Amazon Redshift Feature Support <https://github.com/aws/amazon-redshift-python-driver/blob/master/tutorials/003%20-%20Amazon%20Redshift%20Feature%20Support.ipynb>`_
5959

60-
We are working to add more documentation and would love your feedback. Please reach out to the team by `opening an issue <https://github.com/aws/amazon-redshift-python-driver/issues/new/choose>`_ or `starting a discussion <https://github.com/aws/amazon-redshift-python-driver/discussions/new>`_ to help us fill in the gaps in our documentation.
60+
We are working to add more documentation and would love your feedback. Please reach out to the team by `opening an issue <https://github.com/aws/amazon-redshift-python-driver/issues/new/choose>`__ or `starting a discussion <https://github.com/aws/amazon-redshift-python-driver/discussions/new>`_ to help us fill in the gaps in our documentation.
61+
62+
Integrations
63+
~~~~~~~~~~~~
64+
``redshift_connector`` integrates with various open source projects to provide an interface to Amazon Redshift. Please `open an issue <https://github.com/aws/amazon-redshift-python-driver/issues/new/choose>`__ with our project to request new integrations or get support for a ``redshift_connector`` issue seen in an existing integration.
65+
66+
- `apache-airflow <https://github.com/apache/airflow>`_
67+
- `querybook <https://github.com/pinterest/querybook>`_
68+
- `sqlalchemy-redshift <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift>`_
6169

6270
Basic Example
6371
~~~~~~~~~~~~~
@@ -132,9 +140,12 @@ The paramstyle for a cursor can be modified via ``cursor.paramstyle``. The defau
132140
cursor.execute(sql, {"bar": 1, "jar": "hello world"})
133141
134142
143+
Exception Handling
144+
~~~~~~~~~~~~~~~~~~~
145+
``redshift_connector`` uses the guideline for exception handling specified in the `Python DB-API <https://www.python.org/dev/peps/pep-0249/#exceptions>`_. For exception definitions, please see `redshift_connector/error.py <https://github.com/aws/amazon-redshift-python-driver/blob/master/redshift_connector/error.py>`_
135146

136147
Example using IAM Credentials
137-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
148+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
138149
IAM Credentials can be supplied directly to ``connect(...)`` using an AWS profile as shown below:
139150

140151
.. code-block:: python
@@ -420,3 +431,5 @@ You can run tests by using ``pytest test/unit``. This will run all unit tests. I
420431
Additional Resources
421432
~~~~~~~~~~~~~~~~~~~~
422433
- `LICENSE <https://github.com/aws/amazon-redshift-python-driver/blob/master/LICENSE>`_
434+
- `Python Database API Specification v2.0 (PEP 249) <https://www.python.org/dev/peps/pep-0249/>`_
435+
- `PostgreSQL Frontend/Backend Protocol <https://www.postgresql.org/docs/9.3/protocol.html>`_

0 commit comments

Comments
 (0)