Skip to content

Commit 70db554

Browse files
committed
remove local TOC and old compatibility notes
1 parent 57555cd commit 70db554

File tree

6 files changed

+17
-171
lines changed

6 files changed

+17
-171
lines changed

docs/appendices/compatibility.rst

Lines changed: 0 additions & 76 deletions
This file was deleted.

docs/appendices/index.rst

Lines changed: 0 additions & 15 deletions
This file was deleted.

docs/connect.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,6 @@
44
Connect to CrateDB
55
==================
66

7-
.. rubric:: Table of contents
8-
9-
.. contents::
10-
:local:
11-
12-
137
.. _introduction:
148

159
Introduction

docs/appendices/data-types.rst renamed to docs/data-types.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,6 @@
44
Data types
55
==========
66

7-
.. rubric:: Table of contents
8-
9-
.. contents::
10-
:local:
11-
127
Type mapping
138
============
149

docs/getting-started.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,11 @@ Installation
55
Learn how to install and get started with the :ref:`CrateDB JDBC driver
66
<index>`.
77

8-
.. rubric:: Table of contents
9-
10-
.. contents::
11-
:local:
12-
138
Prerequisites
149
=============
1510

1611
The CrateDB JDBC driver requires Java 8, preferably update 20 or later. We
1712
recommend using `Oracle’s Java`_ on macOS and `OpenJDK`_ on Linux Systems.
18-
Please also consult the :ref:`compatibility-notes` for additional information.
1913

2014
Install
2115
=======

docs/index.rst

Lines changed: 17 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,19 @@
44
CrateDB JDBC Driver
55
###################
66

7-
.. rubric:: Table of contents
8-
9-
.. contents::
10-
:local:
11-
:depth: 1
12-
13-
147
************
158
Introduction
169
************
1710

18-
A `JDBC`_ driver for `CrateDB`_, based on the `PostgreSQL JDBC Driver`_.
19-
It can be used with CrateDB version 0.38.0 and newer.
20-
21-
This is a `JDBC Type 4 driver`_, adhering to the `JDBC 4.1 specification`_. It
22-
is written in pure Java, and communicates with the database using the
23-
`PostgreSQL Wire Protocol`_.
24-
25-
`JDBC`_ is a standard Java API that provides common interfaces for accessing
26-
databases in Java.
27-
11+
A `JDBC`_ driver for `CrateDB`_, based on the `PostgreSQL JDBC Driver`_ which is adhering to the `JDBC 4.1 specification`_. It is written in pure Java, and communicates with the database using the `PostgreSQL Wire Protocol`_.
2812

2913
.. _synopsis:
3014

3115
********
3216
Synopsis
3317
********
3418

35-
Connect to CrateDB instance running on ``localhost``.
19+
Connect to CrateDB instance running on ``localhost``:
3620

3721
.. code-block:: java
3822
@@ -41,7 +25,7 @@ Connect to CrateDB instance running on ``localhost``.
4125
4226
Connection conn = DriverManager.getConnection("jdbc:crate://localhost:5432/");
4327
44-
Connect to CrateDB Cloud.
28+
Connect to CrateDB Cloud:
4529

4630
.. code-block:: java
4731
@@ -56,23 +40,6 @@ Connect to CrateDB Cloud.
5640
5741
Connection conn = DriverManager.getConnection("jdbc:crate://example.aks1.westeurope.azure.cratedb.net:5432/?user=crate", connectionProps);
5842
59-
60-
*************
61-
Documentation
62-
*************
63-
64-
For general help about `JDBC`_, please consult the `JDBC tutorial`_ and the `JDBC
65-
API documentation`_.
66-
67-
.. toctree::
68-
:titlesonly:
69-
70-
getting-started
71-
connect
72-
appendices/index
73-
internals
74-
75-
7643
.. _examples:
7744

7845
Examples
@@ -88,52 +55,39 @@ Examples
8855
and the accompanying repositories `Apache Kafka, Apache Flink, and CrateDB`_
8956
and `Flink example jobs for CrateDB`_.
9057

58+
*************
59+
Documentation
60+
*************
9161

62+
For general help about `JDBC`_, please consult the `JDBC tutorial`_ and the `JDBC API documentation`_.
9263

93-
*******************
94-
Project information
95-
*******************
64+
.. toctree::
65+
:titlesonly:
9666

97-
Resources
98-
=========
99-
- `Source code <https://github.com/crate/crate-jdbc>`_
100-
- `Documentation <https://crate.io/docs/jdbc/>`_
101-
- `Maven Repository <https://repo1.maven.org/maven2/io/crate/>`_
67+
getting-started
68+
connect
69+
data-types
70+
internals
10271

103-
Contributions
104-
=============
105-
The CrateDB JDBC driver library is an open source project, and is
106-
managed on GitHub. Every kind of contribution, feedback, or patch, is much
107-
welcome. `Create an issue`_ or submit a patch if you think we should include a
108-
new feature, or to report or fix a bug.
10972

110-
Development
111-
===========
112-
In order to setup a development environment on your workstation, please head
113-
over to the `development sandbox`_ documentation. When you see the software
114-
tests succeed, you should be ready to start hacking.
73+
.. SEEALSO::
11574

116-
License
117-
=======
118-
The project is licensed under the terms of the Apache 2.0 license, like
119-
`CrateDB itself <CrateDB source_>`_, see `LICENSE`_.
75+
The CrateDB JDBC driver is an open source project and is `hosted on
76+
GitHub`_. Every kind of contribution, feedback, or patch, is much
77+
welcome!
12078

12179

12280
.. _Apache Kafka, Apache Flink, and CrateDB: https://github.com/crate/cratedb-examples/tree/main/framework/flink
12381
.. _Basic example for connecting to CrateDB and CrateDB Cloud using JDBC: https://github.com/crate/cratedb-examples/tree/main/by-language/java-jdbc
12482
.. _Build a data ingestion pipeline using Kafka, Flink, and CrateDB: https://dev.to/crate/build-a-data-ingestion-pipeline-using-kafka-flink-and-cratedb-1h5o
12583
.. _CrateDB: https://crate.io/products/cratedb/
12684
.. _CrateDB source: https://github.com/crate/crate
127-
.. _Create an issue: https://github.com/crate/crate-jdbc/issues
128-
.. _development sandbox: https://github.com/crate/crate-jdbc/blob/master/DEVELOP.rst
12985
.. _Flink example jobs for CrateDB: https://github.com/crate/cratedb-flink-jobs
13086
.. _hosted on GitHub: https://github.com/crate/crate-jdbc/
13187
.. _JDBC: https://en.wikipedia.org/wiki/Java_Database_Connectivity
13288
.. _JDBC 4.1 specification: https://download.oracle.com/otn-pub/jcp/jdbc-4_1-mrel-spec/jdbc4.1-fr-spec.pdf
13389
.. _JDBC API documentation: https://docs.oracle.com/javase/8/docs/technotes/guides/jdbc/
13490
.. _JDBC tutorial: https://docs.oracle.com/javase/tutorial/jdbc/basics/
135-
.. _JDBC Type 4 driver: https://en.wikipedia.org/wiki/JDBC_driver#Type_4_driver_%E2%80%93_Database-Protocol_driver/Thin_Driver_(Pure_Java_driver)
136-
.. _LICENSE: https://github.com/crate/crate-jdbc/blob/master/LICENSE
13791
.. _PostgreSQL JDBC Driver: https://github.com/pgjdbc/pgjdbc
13892
.. _PostgreSQL Wire Protocol: https://www.postgresql.org/docs/current/protocol.html
13993
.. _sample application: https://github.com/crate/crate-sample-apps/tree/main/java-spring

0 commit comments

Comments
 (0)