This document covers the steps for connecting the DbVisualizer database tool with Adobe Experience Platform Query Service.
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.
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.
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.
Use the search bar or select PostgreSQL from the driver name dropdown list. The Database Connection workspace appears.
From the Database Connection workspace, select the Properties tab, followed by the Driver Properties from the navigation sidebar.
The three required driver properties are seen in the table below.
||The host name for the PostgreSQL server. This value is your Experience Platform Host credential.|
||This controls the use of SSL requirements. You must use the value “1” to enable this requirement.|
||The username connected to the database is your Organization ID. It is an alphanumeric string ending in
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.
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.
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.
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.
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.
To make a connection, select the Connection tab from the Database Connection workspace and enter your Experience Platform credentials for the following settings.
After you have input all relevant credentials, select Connect.
The Connect dialog appears on the first occasion of the session.
Enter your Userid and Password and select Connect. A message appears in the log to confirm a successful connection.
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.