Skip to content

Neo4j

Overview

This guide provides instructions on how to set up and use Neo4j with Team Edition.

First, you must start creating a connection in Team Edition and select Neo4j. If you haven’t done this yet, see our Database Connection article.

Team Edition connects to Neo4j using a dedicated JDBC driver. It supports all modern Neo4j versions.

Neo4j specialty

Neo4j is a graph database built for working with connected data. It stores data as nodes and relationships, not tables. This format is great for things like networks, hierarchies, and recommendations.

Neo4j uses Cypher – a SQL-like language designed for graph patterns. It’s optimized for exploring relationships, not just rows.

Info

For more, see the Neo4j documentation.

Setting up

This section provides an overview of Team Edition's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, AWS SSM and Kubernetes.

Tip

When you connect to Neo4j for the first time, Team Edition will prompt you to download the driver. Click the value under the Version column to open a dropdown menu and choose the version you need. For more on changing or updating the version, see how to update driver version.

Neo4j connection settings

In this subsection, we will outline the settings for establishing a direct connection to a Neo4j database using Team Edition. Correctly configuring your connection ensures seamless interaction between Team Edition and your Neo4j database.

The connection settings page requires you to fill in specific fields to establish the initial connection.

Field Description
Connect by (Host/URL) Choose whether you want to connect using a host or a URL.
URL If you are connecting via URL, enter the URL of your Neo4j database here. This field is disabled if you're connecting via the host.
Host If you are connecting via host, enter the host address of your Neo4j database here.
Port Enter the port number for your Neo4j database. The default Neo4j port is 7687.
Authentication Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles:

- Native Database Authentication
- DBeaver Profile Authentication.
Connection Details Provide additional connection details if necessary.
Driver Name This field will be auto-filled based on your selected driver type.
Driver Settings If there are any specific driver settings, configure them here.

Connection details

The Connection Details section in Team Edition allows you to customize your experience while working with Neo4j database. This includes options for adjusting the Navigator View, setting up Security measures, applying Filters, configuring Connection Initialization settings, and setting up Shell Commands. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles:

Secure Connection Configurations

Team Edition supports secure connections to your Neo4j database. Guidance on configuring such connections, specifically SSH, Proxy, Kubernetes, and AWS SSM connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles:

Secure Storage with Secret Providers

Team Edition supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see Secret Providers.

Powering Neo4j with Team Edition

Team Edition provides the ability to view and manage databases.

Neo4j database objects

Team Edition lets you view and work with Neo4j database objects. It supports key metadata types, so you can explore and manage:

  • Databases
  • Tables (Nodes)
    • Columns (Properties)
    • Constraints
    • Indexes
    • Foreign Keys (Relationships)
  • Data types

Neo4j features in Team Edition

In addition, Neo4j includes a range of features designed to enhance the user experience and efficiency when working with Neo4j databases. Here are some of the key features:

Category Feature
Data Transfer Data Export
Browsing collections JSON documents