Configuring a Connection
After Installing the Connector you can connect and create a Data Source for data in Neo4j.
Setting Up a Data Source
Complete the following steps to connect to the data:
- Under Connect | To a Server, click More....
- Select the data source called Neo4j by CData.
- Enter the information required for the connection.
- Click Sign In.
- If necessary, select a Database and Schema to discover what tables and views are available.
Using the Connection Builder
The connector makes the most common connection properties available directly in Tableau. However, it can be difficult to use if you need to use more advanced settings or need to troubleshoot connection issues. The connector includes a separate connection builder that allows you to create and test connections outside of Tableau.
There are two ways to access the connection builder:
- On Windows, use a shortcut called Connection Builder in the Start menu, under the CData Tableau Connector for Neo4j folder.
- You can also start the connection builder by going to the driver install directory and running the .jar file in the lib directory.
In the connection builder, you can set values for connection properties and click Test Connection to validate that they work. You can also use the Copy to Clipboard button to save the connection string. This connection string can be given to the Connection String option included in the connector connection window in Tableau.
Connecting to Neo4j
To connect to Neo4j, you have the following options:
If you are connecting to Neo4j AuraDB, you must use the Query API.
If you are connecting to Self-hosted Neo4j you can choose between the Query API and the HTTP API, depending on your version.
Connecting to Self-hosted Neo4j
Query API
To connect to Neo4j instances via the Query API, set the following connection properties:- API: Set this to Query.
- Server: The server hosting the Neo4j instance. An HTTP or HTTPS protocol prefix may be optionally prepended to the server name or address.
- Port: The port on which the Neo4j service is running. Self-managed instances have a default port of 7474 for the Query API. If connecting over HTTPS, supply the HTTPS port for the Neo4j instance specified in Server.
- User: The username of the user using the Neo4j instance.
- Password: The password of the user using the Neo4j instance.
- Database: The database to target in the Neo4j instance. Defaults to Neo4j.
HTTP API
To connect to Neo4j instances via the HTTP API, set the following connection properties:- API: Set this to HTTP.
- Server: The server hosting the Neo4j instance. An HTTP or HTTPS protocol prefix may be optionally prepended to the server name or address.
- Port: The port on which the Neo4j service is running. The provider connects to HTTP 7474 port by default. If connecting over HTTPS, supply the HTTPS port for the Neo4j instance specified in Server.
- User: The username of the user using the Neo4j instance.
- Password: The password of the user using the Neo4j instance.
- Database: The database to target in the Neo4j instance. Defaults to Neo4j.
Connecting to Neo4j AuraDB
Neo4j AuraDB
To connect to Neo4j Aura instances, the required properties will be the same as the Query API configuration above. Notes on finding property values are below.- API: Set this to Query.
- Server: Found in Query API URL in the Inspect menu of the instance in the Neo4j Aura cloud console. Nothing after Neo4j.io should be provided.
- Port: Set this to 443.
- User: The username of the user using the Neo4j instance.
- Password: Provided only once when creating the instance or when a new user is invited.
- Database: Currently, Neo4j Aura deployments do not allow changing the database name from the default value of Neo4j.
Next Step
See Using the Connector to create data visualizations.