Skip to content

Commit

Permalink
Improve SQL support section in JDBC connectors
Browse files Browse the repository at this point in the history
- No content changes but...
- Consistent wording
_ Markdown link syntax
- Move related configs to SQL support section
- Improve list and rejig as small local ToC, add links
  • Loading branch information
mosabua committed Dec 27, 2024
1 parent 575b641 commit 38b298e
Show file tree
Hide file tree
Showing 18 changed files with 257 additions and 157 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### ALTER SCHEMA
### ALTER SCHEMA limitation

The connector supports renaming a schema with the `ALTER SCHEMA RENAME`
statement. `ALTER SCHEMA SET AUTHORIZATION` is not supported.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### ALTER TABLE RENAME TO
### ALTER TABLE RENAME TO limitation

The connector does not support renaming tables across multiple schemas. For
example, the following statement is supported:
Expand Down
25 changes: 16 additions & 9 deletions docs/src/main/sphinx/connector/clickhouse.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,6 @@ configured connector to create a catalog named `sales`.
```{include} jdbc-case-insensitive-matching.fragment
```

```{include} non-transactional-insert.fragment
```

## Querying ClickHouse

The ClickHouse connector provides a schema for every ClickHouse *database*.
Expand Down Expand Up @@ -317,25 +314,35 @@ No other types are supported.
(clickhouse-sql-support)=
## SQL support

The connector provides read and write access to data and metadata in
a ClickHouse catalog. In addition to the {ref}`globally available
<sql-globally-available>` and {ref}`read operation <sql-read-operations>`
The connector provides read and write access to data and metadata in a
ClickHouse catalog. In addition to the [globally
available](sql-globally-available) and [read operation](sql-read-operations)
statements, the connector supports the following features:

- {doc}`/sql/insert`
- {doc}`/sql/truncate`
- {ref}`sql-schema-table-management`
- [](/sql/insert), see also [](clickhouse-insert)
- [](/sql/truncate)
- [](sql-schema-table-management), see also:
- [](clickhouse-alter-table)
- [](clickhouse-procedures)
- [](clickhouse-table-functions)

(clickhouse-insert)=
```{include} non-transactional-insert.fragment
```

(clickhouse-alter-table)=
```{include} alter-schema-limitation.fragment
```

(clickhouse-procedures)=
### Procedures

```{include} jdbc-procedures-flush.fragment
```
```{include} procedures-execute.fragment
```

(clickhouse-table-functions)=
### Table functions

The connector provides specific {doc}`table functions </functions/table>` to
Expand Down
12 changes: 9 additions & 3 deletions docs/src/main/sphinx/connector/druid.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,17 +116,23 @@ be an empty string `''`, and so forth.
(druid-sql-support)=
## SQL support

The connector provides {ref}`globally available <sql-globally-available>` and
{ref}`read operation <sql-read-operations>` statements to access data and
metadata in the Druid database.
The connector provides read access to data and metadata in the Druid database.
In addition to the [globally available](sql-globally-available) and [read
operation](sql-read-operations) statements, the connector supports the following
features:

- [](druid-procedures)
- [](druid-table-functions)

(druid-procedures)=
### Procedures

```{include} jdbc-procedures-flush.fragment
```
```{include} procedures-execute.fragment
```

(druid-table-functions)=
### Table functions

The connector provides specific {doc}`table functions </functions/table>` to
Expand Down
12 changes: 9 additions & 3 deletions docs/src/main/sphinx/connector/exasol.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,17 +133,23 @@ Exasol does not support longer values.
(exasol-sql-support)=
## SQL support

The connector provides {ref}`globally available <sql-globally-available>` and
{ref}`read operation <sql-read-operations>` statements to access data and
metadata in the Exasol database.
The connector provides read access to data and metadata in Exasol. In addition
to the [globally available](sql-globally-available) and [read
operation](sql-read-operations) statements, the connector supports the following
features:

- [](exasol-procedures)
- [](exasol-table-functions)

(exasol-procedures)=
### Procedures

```{include} jdbc-procedures-flush.fragment
```
```{include} procedures-execute.fragment
```

(exasol-table-functions)=
### Table functions

The connector provides specific {doc}`table functions </functions/table>` to
Expand Down
25 changes: 15 additions & 10 deletions docs/src/main/sphinx/connector/ignite.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,6 @@ configured connector to create a catalog named `sales`.
```{include} jdbc-case-insensitive-matching.fragment
```

```{include} non-transactional-insert.fragment
```

## Table properties

Table property usage example:
Expand Down Expand Up @@ -173,20 +170,28 @@ Ignite. In addition to the {ref}`globally available
<sql-globally-available>` and {ref}`read operation <sql-read-operations>`
statements, the connector supports the following features:

- {doc}`/sql/insert`
- {doc}`/sql/update`
- {doc}`/sql/delete`
- {doc}`/sql/create-table`
- {doc}`/sql/create-table-as`
- {doc}`/sql/drop-table`
- {doc}`/sql/alter-table`
- [](/sql/insert), see also [](ignite-insert)
- [](/sql/update), see also [](ignite-update)
- [](/sql/delete)
- [](/sql/create-table)
- [](/sql/create-table-as)
- [](/sql/drop-table)
- [](/sql/alter-table), see also [](ignite-alter-table)
- [](ignite-procedures)

(ignite-insert)=
```{include} non-transactional-insert.fragment
```

(ignite-update)=
```{include} sql-update-limitation.fragment
```

(ignite-alter-table)=
```{include} alter-table-limitation.fragment
```

(ignite-procedures)=
### Procedures

```{include} jdbc-procedures-flush.fragment
Expand Down
39 changes: 23 additions & 16 deletions docs/src/main/sphinx/connector/mariadb.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,6 @@ properties files.
```{include} jdbc-case-insensitive-matching.fragment
```

```{include} non-transactional-insert.fragment
```

(mariadb-fte-support)=
### Fault-tolerant execution support

Expand Down Expand Up @@ -283,35 +280,45 @@ Complete list of [MariaDB data types](https://mariadb.com/kb/en/data-types/).
(mariadb-sql-support)=
## SQL support

The connector provides read access and write access to data and metadata in
a MariaDB database. In addition to the {ref}`globally available
<sql-globally-available>` and {ref}`read operation <sql-read-operations>`
The connector provides read access and write access to data and metadata in a
MariaDB database. In addition to the [globally
available](sql-globally-available) and [read operation](sql-read-operations)
statements, the connector supports the following features:

- {doc}`/sql/insert`
- {doc}`/sql/update`
- {doc}`/sql/delete`
- {doc}`/sql/truncate`
- {doc}`/sql/create-table`
- {doc}`/sql/create-table-as`
- {doc}`/sql/drop-table`
- {doc}`/sql/alter-table`
- {doc}`/sql/create-schema`
- {doc}`/sql/drop-schema`
- [](/sql/insert), see also [](mariadb-insert)
- [](/sql/update), see also [](mariadb-update)
- [](/sql/delete), see also [](mariadb-delete)
- [](/sql/truncate)
- [](/sql/create-table)
- [](/sql/create-table-as)
- [](/sql/drop-table)
- [](/sql/alter-table)
- [](/sql/create-schema)
- [](/sql/drop-schema)
- [](mariadb-procedures)
- [](mariadb-table-functions)

(mariadb-insert)=
```{include} non-transactional-insert.fragment
```

(mariadb-update)=
```{include} sql-update-limitation.fragment
```

(mariadb-delete)=
```{include} sql-delete-limitation.fragment
```

(mariadb-procedures)=
### Procedures

```{include} jdbc-procedures-flush.fragment
```
```{include} procedures-execute.fragment
```

(mariadb-table-functions)=
### Table functions

The connector provides specific {doc}`table functions </functions/table>` to
Expand Down
39 changes: 23 additions & 16 deletions docs/src/main/sphinx/connector/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,6 @@ creates a catalog named `sales` using the configured connector.
```{include} jdbc-case-insensitive-matching.fragment
```

```{include} non-transactional-insert.fragment
```

(mysql-fte-support)=
### Fault-tolerant execution support

Expand Down Expand Up @@ -334,33 +331,43 @@ that catalog name instead of `example` in the above examples.
## SQL support

The connector provides read access and write access to data and metadata in the
MySQL database. In addition to the {ref}`globally available <sql-globally-available>` and
{ref}`read operation <sql-read-operations>` statements, the connector supports
the following statements:

- {doc}`/sql/insert`
- {doc}`/sql/update`
- {doc}`/sql/delete`
- {doc}`/sql/truncate`
- {doc}`/sql/create-table`
- {doc}`/sql/create-table-as`
- {doc}`/sql/drop-table`
- {doc}`/sql/create-schema`
- {doc}`/sql/drop-schema`
MySQL database. In addition to the [globally available](sql-globally-available)
and [read operation](sql-read-operations) statements, the connector supports the
following features:

- [](/sql/insert), see also [](mysql-insert)
- [](/sql/update), see also [](mysql-update)
- [](/sql/delete), see also [](mysql-delete)
- [](/sql/truncate)
- [](/sql/create-table)
- [](/sql/create-table-as)
- [](/sql/drop-table)
- [](/sql/create-schema)
- [](/sql/drop-schema)
- [](mysql-procedures)
- [](mysql-table-functions)

(mysql-insert)=
```{include} non-transactional-insert.fragment
```

(mysql-update)=
```{include} sql-update-limitation.fragment
```

(mysql-delete)=
```{include} sql-delete-limitation.fragment
```

(mysql-procedures)=
### Procedures

```{include} jdbc-procedures-flush.fragment
```
```{include} procedures-execute.fragment
```

(mysql-table-functions)=
### Table functions

The connector provides specific {doc}`table functions </functions/table>` to
Expand Down
40 changes: 24 additions & 16 deletions docs/src/main/sphinx/connector/oracle.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,6 @@ you name the property file `sales.properties`, Trino creates a catalog named
```{include} jdbc-case-insensitive-matching.fragment
```

```{include} non-transactional-insert.fragment
```

(oracle-fte-support)=
### Fault-tolerant execution support

Expand Down Expand Up @@ -405,36 +402,47 @@ fails. This is also true for the equivalent `VARCHAR` types.
## SQL support

The connector provides read access and write access to data and metadata in
Oracle. In addition to the {ref}`globally available <sql-globally-available>`
and {ref}`read operation <sql-read-operations>` statements, the connector
supports the following statements:

- {doc}`/sql/insert`
- {doc}`/sql/update`
- {doc}`/sql/delete`
- {doc}`/sql/truncate`
- {doc}`/sql/create-table`
- {doc}`/sql/create-table-as`
- {doc}`/sql/drop-table`
- {doc}`/sql/alter-table`
- {doc}`/sql/comment`
Oracle. In addition to the [globally available](sql-globally-available) and
[read operation](sql-read-operations) statements, the connector supports the
following features:

- [](/sql/insert), see also [](oracle-insert)
- [](/sql/update), see also [](oracle-update)
- [](/sql/delete), see also [](oracle-delete)
- [](/sql/truncate)
- [](/sql/create-table)
- [](/sql/create-table-as)
- [](/sql/drop-table)
- [](/sql/alter-table), see also [](oracle-alter-table)
- [](/sql/comment)
- [](oracle-procedures)
- [](oracle-table-functions)

(oracle-insert)=
```{include} non-transactional-insert.fragment
```

(oracle-update)=
```{include} sql-update-limitation.fragment
```

(oracle-delete)=
```{include} sql-delete-limitation.fragment
```

(oracle-alter-table)=
```{include} alter-table-limitation.fragment
```

(oracle-procedures)=
### Procedures

```{include} jdbc-procedures-flush.fragment
```
```{include} procedures-execute.fragment
```

(oracle-table-functions)=
### Table functions

The connector provides specific {doc}`table functions </functions/table>` to
Expand Down
Loading

0 comments on commit 38b298e

Please sign in to comment.