Updated on 2025-07-08 GMT+08:00

Accessing DataArtsFabric SQL Using DBeaver

DBeaver is a SQL client and database management tool. For relational databases, you can use JDBC APIs to interact with a database through the JDBC driver.

Obtaining DBeaver

You can obtain the DBeaver of the required version from the DBeaver community based on the OS.

Interconnecting DataArtsFabric SQL with JDBC

  1. Obtain the Maven coordinates of JDBC. For details, see Obtaining JDBC.
  2. Open DBeaver, choose Database > Driver Manager from the menu bar, and add a custom driver.
  3. In the Driver Manager dialog box, click New to open a new driver dialog box.
  4. Switch to the Libraries tab. Click Add Artifact, copy the Maven coordinates obtained in 1 to Dependency Declaration, and click OK. Click Find Class. On the displayed page, click Download, select org.postgresql.Driver, and click OK.
  5. Switch to the Settings tab page and set the parameters. The Driver Name can be customized. Set Driver Type to Generic. After the JAR file of the driver is imported, the class name is automatically loaded.

    URL template:

    jdbc:fabricsql://{host}[:{port}]/[{database}]

    Click OK to add the DataArtsFabric SQL driver.

  6. After the creation is complete, click New Database Connection, select the driver added in the previous step, and click Next.
  7. On the Main tab page, enter the host name and database name. You do not need to set the username and password. Switch to the Driver properties tab page and set the parameters described in Table 1. Click Finish.
  8. Set connection properties. Switch to Driver properties tab page.

    Table 1 DataArtsFabric SQL connection parameters

    Property Name

    Description

    Mandatory or Optional

    How to Obtain

    AccessKeyID

    Authentication ID

    Mandatory

    Creating a Permanent Access Key or Obtaining Temporary Access Keys and Security Tokens of an IAM User

    SecretAccessKey

    Authentication key

    Mandatory

    securityToken

    STSToken

    Optional (required when a temporary AK/SK pair is used.)

    workspaceId

    Workspace ID

    Mandatory

    Click View Details in Workspace Management Console.

    endpointId

    Endpoint ID

    Mandatory

    Querying Details About a SQL Endpoint

    lakeformation_instance_id

    LakeFormation instance ID

    Mandatory

    LakeFormation information created in Planning and Creating a LakeFormation Instance, Catalog, Database, and Table.

    PGDBNAME

    Lakeformation catalog name

    Mandatory

  9. After the database connection is added, click the drop-down arrow to display the schema list in the database.