Connect DbVisualizer to Query Service

This document covers the steps for connecting the DbVisualizer database tool with Adobe Experience Platform Query Service.

Getting started

This guide requires that you already have access to the DbVisualizer desktop app and are familiar with how to navigate its interface. To download the DbVisualizer desktop app or for more information, see the official DbVisualizer documentation.

NOTE

There are Windows, macOS, and Linux versions of DbVisualizer. Screenshots in this guide were taken using the macOS desktop app. There may be minor discrepancies in the UI between the versions.

To acquire the necessary credentials for connecting DbVisualizer to Experience Platform, you must have access to the Queries workspace in the Platform UI. Please contact your IMS Organization administrator if you do not currently have access to the Queries workspace.

Create a database connection

Once you have installed the desktop app on your local machine, start the app and select Create a Database Connection from the initial DbVisualizer menu. Then select Create a Connection in the panel to the right.

The DbVisualizer main menu with "Create a Database Connection" highlighted.

Use the search bar or select PostgreSQL from the driver name dropdown list. The Database Connection workspace appears.

The driver name dropdown menu with PostgreSQL highlighted.

From the Database Connection workspace, select the Properties tab, followed by the Driver Properties from the navigation sidebar.

The Database Connection workspace with Properties and Driver Properties highlighted.

The driver properties seen in the table below are recommended to enable the use of SSL with DBVisualizer.

Property Description
PGHOST The host name for the PostgreSQL server. This value is your Experience Platform Host credential.
ssl Define the SSL value 1 to enable the use of SSL.
sslmode This controls the level of SSL protection. You are recommended to use the require SSL mode when connecting third party clients to Adobe Experience Platform. The require mode ensures that encryption is required on all communications and that the network is trusted to connect to the correct server. Server SSL certificate validation is not required. For more information, see the documentation on SSL options for connecting third-party clients to Query Service.
user The username connected to the database is your Organization ID. It is an alphanumeric string ending in @adobe.org
IMPORTANT

See the Query Service SSL documentation to learn about SSL support for third-party connections to Adobe Experience Platform Query Service, and how to connect using verify-full SSL mode.

Query Service credentials

The PGHOST and user values are taken from your Adobe Experience Platform credentials. To find your credentials, log in to the Platform UI and select Queries from the left navigation, followed by Credentials. For more information on finding your database name, host, port, and login credentials, please read the credentials guide.

The Credentials page of the Experience Platform Queries workspace with Credentials and the Expiring Credentials highlighted.

Query Service also offers non-expiring credentials to allow for a one-time setup with third-party clients. See the documentation for full instructions on how to generate and use non-expiring credentials.

Use the search bar to find each property then select the corresponding cell for the parameter’s value. The cell will highlight in blue. Enter your Platform credential in the value field and select Apply to add the driver property.

NOTE

To add a second user profile, select user from the parameter column then select the blue + (plus) icon to add credentials for each user. Select Apply to add the driver property.

The Edited column shows a checkmark to denote that the parameter value has been updated.

Authentication

To require a user ID and password-based authentication each time a connection is established, select Authentication from the navigation sidebar under PostgreSQL.

In the Connection Authentication panel, check both the Require Userid and Require Password checkboxes then select Apply.

The Authentication panel for PostgreSQL Database Connection with the Require Userid and Password checkboxes highlighted.

Connect to Platform

To make a connection, select the Connection tab from the Database Connection workspace and enter your Experience Platform credentials for the following settings.

  • Name: You are recommended to provide a friendly name to recognize the connection.
  • Database Server: This is your Experience Platform Host credential.
  • Database Port: The port for Query Service. You must use port 80 to connect with Query Service.
  • Database: Use the credential dbname value prod:all.
  • Database Userid: This is your Platform Organization Id. The Userid will be in the format of ORG_ID@AdobeOrg.
  • Database Password: This is an alphanumeric string found on the Query Service credentials dashboard.

After you have input all relevant credentials, select Connect.

The PostgreSQL Database Connection workspace with the Connection tab and connect button highlighted.

The Connect dialog appears on the first occasion of the session.

The Connect: PostgreSQL dialog with the Database Userid and Database Password text fields highlighted.

Enter your Userid and Password and select Connect. A message appears in the log to confirm a successful connection.

Next steps

Now that you have connected DbVisualizer with Query Service, you can use DbVisualizer to write queries. For more information on how to write and run queries, please read the guide on query execution.

On this page