Skip to content

aura procedures #747

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.

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 2 commits into
base: console
Choose a base branch
from
Open

aura procedures #747

wants to merge 2 commits into from

Conversation

fiquick
Copy link
Collaborator

@fiquick fiquick commented Jul 4, 2025

@fiquick fiquick added the WIP label Jul 4, 2025
@fiquick fiquick requested a review from AlexicaWright July 4, 2025 17:05
The following are known to be restricted in Aura (e.g. due to permission, cluster, or filesystem constraints).

`CALL db.info()`
Used for system-level diagnostics (❌ Not supported in Aura Free ✅ Supported in Aura Pro)
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

any idea how to present these ones which are not supported in free, but are supported in pro?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd suggest to put them in a table and use a footnote.

Copy link
Collaborator

@AlexicaWright AlexicaWright left a comment

Choose a reason for hiding this comment

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

Let's find a better place for these. They don't belong in the Query section.

@@ -76,6 +76,7 @@ Generic Start
** xref:query/introduction.adoc[What is Query?]
** xref:query/visual-tour.adoc[Visual tour]
** xref:query/operations.adoc[Query operations]
** xref:query/procedures.adoc[Aura procedures]
Copy link
Collaborator

Choose a reason for hiding this comment

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

Procedures should not be part of the Query docs.


This page provides a reference for built-in procedures supported in Neo4j Aura (including both AuraDB and AuraDS).
Aura restricts access to certain administrative and custom capabilities due to its fully managed, secure architecture.
This guide highlights what is available, how to use them, and which procedures are not supported.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
This guide highlights what is available, how to use them, and which procedures are not supported.


The full list of Neo4j procedures is available at https://neo4j.com/docs/operations-manual/current/procedures/

To check which procedures are available in your Aura instance, run the following Cypher command in the query editor or Cypher shell:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
To check which procedures are available in your Aura instance, run the following Cypher command in the query editor or Cypher shell:
To check which procedures are available in your Aura instance, run the following Cypher command in Query or Cypher shell:

Do Aura users use Cypher shell?

Comment on lines +17 to +21
.All procedures must be called with the CALL keyword, e.g.
[source,cypher]
----
CALL db.labels();
----
Copy link
Collaborator

@AlexicaWright AlexicaWright Jul 7, 2025

Choose a reason for hiding this comment

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

Suggested change
.All procedures must be called with the CALL keyword, e.g.
[source,cypher]
----
CALL db.labels();
----

`CALL db.schema.nodeTypeProperties();`
Lists properties by node type.

== Index and Query Management
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
== Index and Query Management
== Index and query management

@@ -0,0 +1,164 @@
= Aura Built-in Procedures Reference
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
= Aura Built-in Procedures Reference
= Aura built-in procedures reference

Copy link
Collaborator

@AlexicaWright AlexicaWright left a comment

Choose a reason for hiding this comment

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

How do we ensure that these are always correct and up to date? Do we need to have them in the Aura docs? They are already listed in the Operations Manual. It creates extra work to maintain the same content in two different places. What prompted this addition?


== Schema and Metadata

`CALL db.labels();`
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
`CALL db.labels();`
`db.labels();`

We are listing the procedures, seems superfluous to include CALL on every line.

`CALL db.awaitIndexes(300);`
Wait for all indexes to come online.

`CALL db.index.fulltext.awaitEventuallyConsistentIndexRefresh();`
Copy link
Collaborator

Choose a reason for hiding this comment

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

Description to come?

@neo4j-docops-agent
Copy link
Collaborator

This PR includes documentation updates
View the updated docs at https://neo4j-docs-aura-747.surge.sh

New pages:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants