From 24312ca537dc939ee54be8fcdf7d51c3de17d445 Mon Sep 17 00:00:00 2001 From: Martijn Dirkse Date: Tue, 12 Nov 2024 18:30:44 +0100 Subject: [PATCH] Add table of database drivers --- docs/source/deploying/databaseDriver.rst | 70 ++++++++++++++++++++++++ docs/source/deploying/deploying.rst | 1 + 2 files changed, 71 insertions(+) create mode 100644 docs/source/deploying/databaseDriver.rst diff --git a/docs/source/deploying/databaseDriver.rst b/docs/source/deploying/databaseDriver.rst new file mode 100644 index 00000000..d146ee4c --- /dev/null +++ b/docs/source/deploying/databaseDriver.rst @@ -0,0 +1,70 @@ + .. WARNING:: + + Under construction. + +.. _deployingDatabaseDriver: + +The Database Driver +=================== + +To access a database, the Frank!Framework needs a *database driver*. A database driver is a Java library provided by the database vendor. Frank developers who provide a Docker image with a complete Frank application should include the database driver of the chosen database. System administrators working with such Docker images do not have to worry about the database driver. System administrators who only receive a Frank configuration, not a complete Frank application, should install the database driver in the deployment environment. This section is both for Frank developers and system administrators. It explains for each database brand which database driver is needed and how it can be obtained. + +.. WARNING:: + + Until release 8.3 of the Frank!Framework, the database drivers of many databases were included in the Docker image provided by the maintainers of the Frank!Framework. This is the Docker image that holds the Frank!Framework deployed on Apache Tomcat. From the 9.0 release onwards, the database drivers will be excluded from this standard image to make it smaller. Frank developers typically derive a Docker image from this standard image to provide the Frank configurations the customer needs. They should take care now to add the database driver of the chosen database. + +The database driver is related to the ``type`` field of ``resources.yml``, see the previous section :ref:`deployingDatabase`. The value of the ``type`` field is the name of a Java class that should be in the database driver. The Frank!Framework uses the class referenced by the ``type`` field as the entry point of the database driver. + +Java applications use Maven as a tool to manage dependencies. In Maven, each library is referenced by three *Maven coordinates* which are the group id, the artifact id and the version. These coordinates are not only usable by Maven, but they can also be used to search for database drivers on the internet. The following table lists for each ``type`` the Maven coordinates of the related database driver. + ++--------------------------------------------------+-----------------------------------------------------+ +| ``type`` | Maven dependency | ++==================================================+=====================================================+ +| ``org.postgresql.Driver`` | .. code-block:: | +| or | | +| ``org.postgresql.xa.PGXADataSource`` | | +| | org.postgresql | +| | postgresql | +| | 42.7.4 | +| | | ++--------------------------------------------------+-----------------------------------------------------+ +| ``org.mariadb.jdbc.Driver`` | .. code-block:: | +| | | +| | | +| | org.mariadb.jdbc | +| | mariadb-java-client | +| | 3.5.0 | +| | | ++--------------------------------------------------+-----------------------------------------------------+ +| ``com.mysql.cj.jdbc.Driver`` | .. code-block:: | +| | | +| | | +| | com.mysql | +| | mysql-connector-j | +| | 9.1.0 | +| | | ++--------------------------------------------------+-----------------------------------------------------+ +| ``com.microsoft.sqlserver.jdbc.SQLServerDriver`` | .. code-block:: | +| | | +| | | +| | com.microsoft.sqlserver | +| | mssql-jdbc | +| | 12.8.1.jre11 | +| | | ++--------------------------------------------------+-----------------------------------------------------+ +| ``oracle.jdbc.driver.OracleDriver`` | .. code-block:: | +| | | +| | | +| | com.oracle.database.jdbc | +| | ojdbc11 | +| | 23.6.0.24.10 | +| | | ++--------------------------------------------------+-----------------------------------------------------+ +| ``org.h2.jdbcx.JdbcDataSource`` | .. code-block:: | +| | | +| | | +| | com.h2database | +| | h2 | +| | 2.3.232 | +| | | ++--------------------------------------------------+-----------------------------------------------------+ diff --git a/docs/source/deploying/deploying.rst b/docs/source/deploying/deploying.rst index bb86f161..54b64e0c 100644 --- a/docs/source/deploying/deploying.rst +++ b/docs/source/deploying/deploying.rst @@ -28,6 +28,7 @@ Here is the table of contents of this chapter: dtapAndInstanceName database + databaseDriver requiringAuthorization overviewSecurityRoles credentials