Skip to content

Commit ea58de8

Browse files
committed
revise / refine text
1 parent 6ebddab commit ea58de8

1 file changed

Lines changed: 23 additions & 21 deletions

File tree

  • docs/deploy-and-configure/configuration/dataintegration/jdbc

docs/deploy-and-configure/configuration/dataintegration/jdbc/index.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,49 +5,50 @@ tags:
55
---
66
# Setup and use of JDBC Drivers
77

8-
Corporate Memory allows to use JDBC to connect to Database Management Systems (DBMS).
9-
We ship some drivers as part of our platform.
10-
Custom drivers can be added and used, too.
8+
Corporate Memory supports JDBC connections to database management systems (DBMSs).
9+
The platform includes several JDBC drivers by default.
10+
You can also add and use custom drivers.
1111

1212
!!! info "References"
1313

14-
For more technical details also check the following reference pages:
14+
For more technical details, see the following reference pages:
1515

1616
- [Remote SQL endpoint](../../../../build/reference/dataset/Jdbc.md) and
1717
- [Snowflake SQL endpoint](../../../../build/reference/dataset/SnowflakeJdbc.md).
1818

19-
## Embedded JDBC Driver
19+
## Bundled JDBC Drivers
2020

21-
Our platform contains and ship the following JDBC drivers:
21+
The platform includes the following JDBC drivers:
2222

2323
- PostgreSQL (`postgresql v42.7.10`)
2424
- MariaDB (includes support for MySQL, `mariadb-java-client v3.5.7`)
2525
- Microsoft SQL Server (`mssql-jdbc v13.2.1.jre11`)
2626
- Snowflake (`snowflake-jdbc v3.28.0`)
2727

28-
## Custom JDBC Driver
28+
## Custom JDBC Drivers
2929

30-
In addition to the shipped default JDBC drivers custom JDBC drivers can be registered.
31-
The following steps describe how they are configured.
30+
In addition to the bundled JDBC drivers, you can register custom JDBC drivers.
31+
The following sections describe the required configuration.
3232

3333
### Download Custom JDBC Driver
3434

35-
Download the respective JDBC driver for the Database Management Systems that need to be connected.
36-
[Integrations](../../../../build/integrations/index.md) provides links for well know system and at the same time lists those that are in active use with Corporate Memory.
35+
Download the JDBC driver for each database management system that you want to connect to.
36+
[Integrations](../../../../build/integrations/index.md) provides links for well-known systems and lists those that are actively used with Corporate Memory.
3737

3838
### Provide a Custom JDBC Driver
3939

40-
Consult your solutions manager or DevOps specialist for options how to copy / inject additional files, namely the JDBC driver `jar`, into a Corporate Memory deployment.
41-
Depending on the specific deployment model used the suitable options differ, some possibilities:
40+
Consult your solutions manager or DevOps specialist for options to copy or inject the JDBC driver `jar` into a Corporate Memory deployment.
41+
Depending on the deployment model, suitable options include:
4242

43-
- the docker compose package `cmem-orchestration` mounts the folder `./conf/dataintegration/plugin/` into the DataIntegration container (this location is assumed in the configuration snippets below and mapped to the container internal path `/opt/cmem/eccenca-DataIntegration/dist/etc/dataintegration/conf/plugin/`),
44-
- a dedicated Build project into which the driver jar files are uploaded as project (file) resources,
45-
- dedicated file or resource mounts in a docker compose or helm/kubernets configuration.
43+
- The Docker Compose package `cmem-orchestration` mounts the folder `./conf/dataintegration/plugin/` into the DataIntegration container.
44+
The configuration snippets below assume this location, which maps to `/opt/cmem/eccenca-DataIntegration/dist/etc/dataintegration/conf/plugin/` inside the container.
45+
- A dedicated _Build project_ in which the driver JAR files are uploaded as project file resources.
46+
- Dedicated file or resource mounts in a Docker Compose or Helm/Kubernetes configuration.
4647

4748
## Driver Registration
4849

49-
A custom JDBC driver needs to be registered in the DataIntegration configuration file, `dataintegration.conf`, `spark.sql.options` section.
50-
The following example demonstrates how to register the custom JDBC driver for the Databricks data lakehouse:
50+
A custom JDBC driver must be registered in the DataIntegration configuration file `dataintegration.conf`, in the `spark.sql.options` section.
51+
The following example shows how to register a custom JDBC driver for Databricks:
5152

5253
```conf
5354
@@ -64,12 +65,13 @@ spark.sql.options {
6465
6566
```
6667

67-
## Use the driver
68+
## Use the Driver
6869

69-
JDBC drivers are used via the **Remote SQL endpoint** (or **Snowflake SQL endpoint**) dataset type.
70+
JDBC drivers are used through the **Remote SQL endpoint** or **Snowflake SQL endpoint** dataset type.
7071

7172
![](jdbc-dataset.png){ class="bordered" width="85%" }
7273

73-
They can be configured in the configuration dialog of the dataset, consult the documentation of your DBMS / JDBC driver for details about the [JDBC connection string](https://www.baeldung.com/java-jdbc-url-format).
74+
Configure them in the dataset configuration dialog.
75+
For details about the JDBC connection string, consult your DBMS or JDBC driver documentation.
7476

7577
![](jdbc-config-databricks.png){ class="bordered" width="100%" }

0 commit comments

Comments
 (0)