Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
////
Generic Start
////
* Neo4j Aura

* Introduction
** xref:index.adoc[About Aura]
** xref:new-console.adoc[New Neo4j Aura console]
** xref:microsoft-fabric.adoc[Workload for Microsoft Fabric]
** xref:visual-tour/index.adoc[Visual tour]

* xref:graph-analytics/index.adoc[]
** xref:visual-tour/index.adoc[Tour of the console]

* Quick start
** xref:getting-started/create-account.adoc[Create an account]
** xref:getting-started/create-instance.adoc[Create an instance]
** xref:getting-started/connect-instance.adoc[Connect to an instance]
** xref:getting-started/migrate-metadata.adoc[Migrate metadata from Workspace]

* xref:graph-analytics/index.adoc[]
* xref:microsoft-fabric.adoc[Workload for Microsoft Fabric]

* xref:cloud-providers.adoc[Cloud provider marketplaces]

* Manage instances
Expand Down
63 changes: 0 additions & 63 deletions modules/ROOT/pages/getting-started/connect-instance.adoc
Original file line number Diff line number Diff line change
@@ -1,63 +0,0 @@
[[connect-to-instance]]
= Connect to an instance
:description: This page describes how to connect to an instance in the new Neo4j Aura console.
:page-aliases: auradb/getting-started/connect-database.adoc, aurads/connecting/index.adoc

To interact with a database in an instance, you need to establish a connection.

. Go to *Import*, *Explore* or *Query*.
. Select *Status* and from there you can connect to an instance.
. You may need your *Username* and *Password* credentials.

[.shadow]
.Connection banner
image::connectionbanner1.png[]

[.shadow]
.Connection modal
image::connectionmodalnonremote.png[width=300]

[cols="20%,80%"]
|===
| Field | Description

|Connection method
|The protocol is used for the communication between the Neo4j database server and the client application or tool.
The default is `neo4j+s//`.
// For more information about connection schemes, see link:https://neo4j.com/docs/operations-manual/current/configuration/connectors/[Operations Manual -> Configure network connectors] and link:https://neo4j.com/docs/bolt/current/bolt/[Bolt Protocol].

// |Connection URL
// |You can get this from your instance details

|Single sign-on
|If this is set up, you can use SSO.

|Database user
|Neo4j by default

|Password
|You are given the password when you initially create the instance
|===

== Connection method

To connect to an instance, select one of the following connection methods: *neo4j+s://* or *https://*

The connection method protocol is used for the communication between the Neo4j database server and the client application or tool.
For more information about connection schemes, see link:https://neo4j.com/docs/operations-manual/current/configuration/connectors/[Operations Manual -> Configure network connectors] and link:https://neo4j.com/docs/bolt/current/bolt/[Bolt Protocol].

=== *neo4j+s://*

Establishes a TLS-encrypted connection to Neo4j using the Bolt protocol over WebSockets, with full certificate validation.
Use for optimal performance.

=== *https://*

TLS encrypted connection to Neo4j over HTTPS (Query API), with full certificate validation.
Use in environments where port restrictions may prevent access to the Bolt port.

== Errors

In an enterprise environment with restrictive networking, connection errors are sometimes caused because non-standard ports (like the Bolt protocol) are blocked by firewalls when using *neo4j+s://*.

Switching to *https://* can address connection issues and ensure seamless connectivity without extra configuration.
99 changes: 98 additions & 1 deletion modules/ROOT/pages/getting-started/create-account.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,101 @@
Once you have accepted the terms and conditions and verified your email address, you can start using the console.

The console exists in two versions,the new console, and the classic experience, as mentioned in xref:index.adoc[About Neo4j Aura console].
You can toggle between the different versions, via the account dropdown in the top right corner.
You can toggle between the different versions, via the account dropdown in the top right corner.

[[create-instance]]
= Create an instance

Check failure on line 14 in modules/ROOT/pages/getting-started/create-account.adoc

View workflow job for this annotation

GitHub Actions / docs-verify-pr / log-report

modules/ROOT/pages/getting-started/create-account.adoc

level 0 sections can only be used when doctype is book
:description: This page describes how to create an instance in the new Neo4j Aura console.
:page-aliases: auradb/getting-started/create-database.adoc, aurads/create-instance.adoc

There are two types of Aura product instances:

* **AuraDB** (the default Aura instance type)
* **AuraDS** (the xref:graph-analytics/index.adoc#aura-ds[fully managed version] of Neo4j Graph Data Science)

Select the type of instance using the switch on the top right, then choose the tier that best suits your needs.

For AuraDB, you can upgrade your tier, and resize your instance's memory and storage later if your needs change.
For pre-paid AuraDB instances on GCP, adjustable storage independent of memory is available, see xref:managing-instances/instance-actions.adoc#_adjust_storage[Adjust storage] for more information.

You can optionally enable additional features:

* xref:graph-analytics/index.adoc#aura-gds-plugin[Graph Analytics plugin] to add graph analytics capabilities (**AuraDB Professional only**)
* xref:managing-instances/instance-details.adoc#aura-vector-optimization[Vector optimization] to enhance performance for vector-based operations

After selecting **Next**, your instance is created.
A password is generated for the instance, ensure to either copy or download it, as it will **not** be recoverable after.
The password is required to access your instance later.

[NOTE]
====
You can only create **one Free instance** per account.
To create more instances, you need to upgrade your tier.
See link:https://neo4j.com/pricing/[Neo4j Pricing] for more information on the different tiers.
====

[[connect-to-instance]]
= Connect to an instance

Check failure on line 45 in modules/ROOT/pages/getting-started/create-account.adoc

View workflow job for this annotation

GitHub Actions / docs-verify-pr / log-report

modules/ROOT/pages/getting-started/create-account.adoc

level 0 sections can only be used when doctype is book
:description: This page describes how to connect to an instance in the new Neo4j Aura console.
:page-aliases: auradb/getting-started/connect-database.adoc, aurads/connecting/index.adoc

To interact with a database in an instance, you need to establish a connection.

. Go to *Import*, *Explore* or *Query*.
. Select *Status* and from there you can connect to an instance.
. You may need your *Username* and *Password* credentials.

[.shadow]
.Connection banner
image::connectionbanner1.png[]

[.shadow]
.Connection modal
image::connectionmodalnonremote.png[width=300]

[cols="20%,80%"]
|===
| Field | Description

|Connection method
|The protocol is used for the communication between the Neo4j database server and the client application or tool.
The default is `neo4j+s//`.
// For more information about connection schemes, see link:https://neo4j.com/docs/operations-manual/current/configuration/connectors/[Operations Manual -> Configure network connectors] and link:https://neo4j.com/docs/bolt/current/bolt/[Bolt Protocol].

// |Connection URL
// |You can get this from your instance details

|Single sign-on
|If this is set up, you can use SSO.

|Database user
|Neo4j by default

|Password
|You are given the password when you initially create the instance
|===

== Connection method

To connect to an instance, select one of the following connection methods: *neo4j+s://* or *https://*

The connection method protocol is used for the communication between the Neo4j database server and the client application or tool.
For more information about connection schemes, see link:https://neo4j.com/docs/operations-manual/current/configuration/connectors/[Operations Manual -> Configure network connectors] and link:https://neo4j.com/docs/bolt/current/bolt/[Bolt Protocol].

=== *neo4j+s://*

Establishes a TLS-encrypted connection to Neo4j using the Bolt protocol over WebSockets, with full certificate validation.
Use for optimal performance.

=== *https://*

TLS encrypted connection to Neo4j over HTTPS (Query API), with full certificate validation.
Use in environments where port restrictions may prevent access to the Bolt port.

== Errors

In an enterprise environment with restrictive networking, connection errors are sometimes caused because non-standard ports (like the Bolt protocol) are blocked by firewalls when using *neo4j+s://*.

Switching to *https://* can address connection issues and ensure seamless connectivity without extra configuration.


65 changes: 64 additions & 1 deletion modules/ROOT/pages/visual-tour/index.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,67 @@
[[visual-overview]]
= Visual tour of the console
= Tour of the console
:description: This section introduces the console UI.
:gds-sessions-page: {neo4j-docs-base-uri}/graph-data-science/current/installation/aura-graph-analytics-serverless/

When you sign up to Aura, you'll be taken through an onboarding flow.
When you log into the console, it's likely that you will land in a project.

== Get started

Explore the content to maximize your Neo4j Aura experience.

Import your data: Data in Neo4j is stored as a graph rather than tables.
Import your data to begin organizing it into nodes and relationships.

Query your data:
Unlock insights in your graph with Cypher, Neo4j's powerful query language.
Effortlessly explore connections, analyze patterns, and gain deeper understanding of your connected data.

Build an application:
Bring your ideas to life with Neo4j.
Easily build an application or proof-of-concept with popular drivers, like Python and GraphQL, to unlock the power of your connected data.

Neo4j in production:
Prepare your Neo4j database for production.
Optimize queries, enhance security, scale seamlessly, and more.


You can quick start to an instance here too!

There's also a link to the AI search tool > https://neo4j.com/docs/?chatbot=open

And you can invite your team from there too!

== Developer hub

Discover the client libraries, APIs and useful resources to develop applications with Neo4j

Choose how you want to connect

* Python
* Java
* JavaScript
* Go
* .NET
* GraphQL
* Query API
* CLI
* and more available in the deployment center https://neo4j.com/deployment-center/#drivers-tab

There's an in-product tutorial to connect to a driver, that walks you through all the steps.
Basically, once you've created an instance - you use all those details to connect to - then you can use the instance in your code!

Visual Studio Code extension

Check out helpful resources
Find code samples, documentation, and courses to accelerate your Neo4j application building experience.

* Git repositories
* Documentation
* Graph academy

Graph Analytics

== Structure

The hierarchy of the console consists of organizations, projects, and instances:
Expand Down Expand Up @@ -99,6 +158,10 @@ Session details include:
* The user who created the session
* The time remaining to the session configured time limit

=== Data APIs



== Tools

The tools allow you to interact with your data and therefore require an active connection to an instance.
Expand Down
Loading