Testing a Database Connection

For a database to be included in a Database Import, you can test your connection or add your database to Civis from the import's configuration page. You might want to test the connection to make sure your url and credentials are accurate. This helps reduce the amount of time it takes to validate the database connections. 

To test an existing or new Civis database connection, navigate to the Database Imports page from the Data menu on the top navigation panel.

Click "New Database", this will open the "Add Source" Panel.

You will see two options "Select URL" and "New URL".  "Select URL" is for when the database was previously added to Civis and you want to add a new user or role, but do not need to edit the connection URL. "New URL" can be used to verify the connection URL and credentials before adding the database allowing for making changes to the URL string or credentials.

For the "Select URL" tab, fill out the following fields:

• URL - The existing database you want to use in the import.
• Username - The username of the database user or role Civis will use to access the source data.
• Password - The password of the database user or role Civis will use to access the source data.

For the "New URL" tab, fill out the following fields:

• Name  - The name of the database to be created. Future imports can reference this database by this name.
• URL - The JDBC connection string for the database. Contact your database administrator for this information.  It should be in the appropriate format for each database:
• SQL Server - jdbc:sqlserver://your.host.com;databaseName=yourDbName
• MySQL - jdbc:mysql://your.host.com/yourDbName
• Oracle - jdbc:oracle:thin:@//your.host.com:port/yourDbName
• PostgreSQL - jdbc:postgresql://your.host.com/yourDbName
• Redshift - jdbc:redshift://your.host.com:port/yourDbName 
• Snowflake - jdbc:snowflake://YourAccountName.snowflakecomputing.com:port/?db=yourDbName
• Username - The username of the database user or role Civis will use to access the source data.
• Password - The password of the database user or role Civis will use to access the source data.

Click on "Test" in the bottom left to test the connection to the database. You should see a banner that the connection was successful at the top. Otherwise, an error will appear to show you what went wrong.

Once you have verified the connection, click "Add" to use the database connection and credentials for your Import Job.

Disclaimer: As noted in the panel above, testing is not supported for connections that require a server certificate and/or an SSL key pair. See Adding a Server Certificate to Civis for a Database Sync or Adding SSL Key Pairs to DBSyncs for help setting up those connections.