Skip to content

add info about model ID #812

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: console
Choose a base branch
from
Open

add info about model ID #812

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d7e7ea7
add info about model ID
AlexicaWright Sep 23, 2025
52a96b0
Merge branch 'console' into import-model-id
AlexicaWright Sep 24, 2025
061f0e6
small edits
AlexicaWright Sep 24, 2025
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
2 changes: 1 addition & 1 deletion modules/ROOT/pages/import/file-provision.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ When you use the *New data source* button, you are presented with the following
* Databricks
* Snowflake
* AWS S3
* Azure Blogs & Data Lake Storage
* Azure Blobs & Data Lake Storage
* Google Cloud Storage

Regardless of which one you select, you are required to provide roughly the same information to allow the Import service to load the tables for you from your remote source.
Expand Down
5 changes: 5 additions & 0 deletions modules/ROOT/pages/import/introduction.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,8 @@ For more information, see the link:https://neo4j.com/docs/data-importer/current/
====
Only CSV files can be imported in the standalone tool.
====

== Import via API

Additionally, import can also be achieved via API, as described in link:{neo4j-docs-base-uri}/aura/platform/api/specification/?urls.primaryName=Aura%20v2beta1#/[Aura API specification].
Note that this is only available with v2beta1 of the Aura API.
9 changes: 8 additions & 1 deletion modules/ROOT/pages/import/modeling.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,14 @@ Relationships need to have a _type_ and one or more _properties_.
You can add a new model and see your available models (if you have any) in the *Graph models* tab.
If you add a new model, you can either either *Connect to a data source* to select a source from your list (see xref:import/file-provision.adoc[] for information about data sources), or you can drag and drop (or browse for) local flat files.

Once you have defined your data source, you have three options to create your model:
Once you have defined your data source, you are taken to the *data model panel*.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Once you have defined your data source, you are taken to the *data model panel*.
Once you have defined your data source, you can choose to create a model from the data source, and it will take you to the modelling page*.

At this point, a *model ID* is generated and appended to the URL.

For example, in the URL `console-preview.neo4j.io/tools/import/models/0952dbcf-bc71-4413-8575-f8ffd4551234`, the model ID is `0952dbcf-bc71-4413-8575-f8ffd4551234`.

This ID is useful if you intend to import via the link:{neo4j-docs-base-uri}/aura/platform/api/specification/?urls.primaryName=Aura%20v2beta1#/[API], but note that doing so requires a complete model with data source and mapping.

You have three options to create your model:

* *Define manually* - sketch your model and map your data
* *Generate from schema* - automatically define and map a model based on tables and constraints in your data
Expand Down