Documentation

Driver managements

CloudBeaver supports almost any database which has JDBC driver.
Generally it support all drivers supported by DBeaver.

By default e do not enable all DBeaver drivers in CloudBeaver. They must be added to server configuration on demand.

Adding new driver dependencies

Driver dependencies are configured in the folder server/drivers.
In order to add new driver:

  • Create new folder for a new driver
  • Copy POM file from any other driver config to the new directory
  • Change module name and driver dependencies in the new POM file

Example of PostgreSQL driver config:

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <artifactId>drivers.postgresql</artifactId>
    <version>1.0.0</version>
    <parent>
        <groupId>io.cloudbeaver</groupId>
        <artifactId>drivers</artifactId>
        <version>1.0.0</version>
        <relativePath>../</relativePath>
    </parent>

    <properties>
        <deps.output.dir>postgresql</deps.output.dir>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.postgresql</groupId>
            <artifactId>postgresql</artifactId>
            <version>42.2.5</version>
        </dependency>
        <dependency>
            <groupId>net.postgis</groupId>
            <artifactId>postgis-jdbc</artifactId>
            <version>2.2.1</version>
        </dependency>
    </dependencies>

</project>

Adding new driver to the server

Enabled drivers are configured in file server/bundles/io.cloudbeaver.resources.drivers.base/plugin.xml.
You can copy some existing driver configuration to add a new one.

There are 3 configuration lines for each driver:

  1. <resource name="drivers/driver-name" /> - says that file-system folder drivers/driver-name can be used to load driver jars.
  2. <bundle id="drivers.driver-name" /> - needed for driver configuration enable in DBeaver platform
  3. <driver id="generic:driver-name" /> - enabled DBeaver driver in CloudBeaver. Driver ID can be found in DBeaver platform (in one of database-specific plugin.xml files).