Test a Databricks connection

Learn more about the endpoint used to test a Databricks connection for Reltio Zero Copy Interaction Integration from Databricks.

Test an existing Databricks connection configuration in Reltio to verify that Reltio can connect to the Databricks SQL Warehouse by using the stored OAuth credentials.

Note: This operation returns HTTP 200 OK for both successful and unsuccessful tests, so use the connected field in the response body to determine the actual result.

HTTP method and endpoint

Use the following HTTP method and endpoint path to test the Databricks connection. In this endpoint, test is the fixed action segment used to validate the saved Databricks connection configuration.

POST {platformUrl}/reltio/api/tenants/{tenantId}/interactions/database-configs/{connectionName}/test

The following table describes the endpoint path parameters.


Parameter	Type	Required	Description
`tenantId`	String	Yes	Unique identifier of the tenant where the Databricks connection is defined. Example: ce5627DYnQ6abcD
`connectionName`	String	Yes	Name of the existing Databricks connection configuration that you want to test.

Request headers

The following request headers must be included.


Header	Value	Required
`Authorization`	Bearer `<access_token>`	Yes
`Content-Type`	application/json	Yes

Request body

This operation does not require a request body.

Example request

Use the following example to test the Databricks connection configuration.

POST {platformUrl}/reltio/api/tenants/{tenantId}/interactions/database-configs/{connectionName}/test

Response body

The following table describes the response fields returned by this operation.


Field	Type	Description
`status`	String	Overall response status.
`data.connected`	Boolean	Indicates whether the Databricks connection test succeeded.
`data.databaseType`	String	Database type of the tested connection.
`data.message`	String	Result message returned by the connection test API.

Example response

This operation returns HTTP 200 OK for both successful and unsuccessful tests. Check the data.connected field to determine whether the Databricks connection is valid.

If the connection test succeeds, the response is similar to the following example.

{
  "status": "success",
  "data": {
    "connected": true,
    "databaseType": "DATABRICKS",
    "message": "Connection successful"
  }
}

If the connection test fails, the response is similar to the following example. Review the response message to identify the issue, update the values saved through Create a Databricks connection configuration or Store Databricks OAuth credentials as needed, and then test the connection again.

{
  "status": "success",
  "data": {
    "connected": false,
    "databaseType": "DATABRICKS",
    "message": "Connection failed: Unable to connect to SQL Warehouse"
  }
}

Unify and manage your data