Skip to content

Commit

Permalink
Documentation: Clarify the purpose of this "legacy" driver
Browse files Browse the repository at this point in the history
- Describe why it is still needed in a few cases.
- Also add the recommendation to use the official driver in other cases.
  • Loading branch information
amotl committed Mar 22, 2023
1 parent d14f255 commit f615472
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,17 @@ database using the `PostgreSQL Wire Protocol`_.
databases in Java.


*****
About
*****

Overview
========

- This JDBC driver is needed in certain scenarios like the one outlined at
`Apache Kafka, Apache Flink, and CrateDB`_.
- Officially, and for general purpose use, we recommend to use the canonical
`PostgreSQL JDBC Driver`_ instead.
*************
Documentation
*************
Expand Down Expand Up @@ -52,6 +63,7 @@ Examples
"guestbook" application, using `Spring Data JDBC`_.


.. _Apache Kafka, Apache Flink, and CrateDB: https://github.com/crate/cratedb-examples/tree/main/stacks/kafka-flink
.. _Basic example for connecting to CrateDB using JDBC: https://github.com/crate/cratedb-examples/tree/main/by-language/java-jdbc
.. _CrateDB: https://crate.io/products/cratedb/
.. _hosted on GitHub: https://github.com/crate/crate-jdbc/
Expand Down

0 comments on commit f615472

Please sign in to comment.