Skip to content

Tweaks ahead of Query API GA #110

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

Merged
merged 1 commit into from
Sep 2, 2024
Merged
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
13 changes: 7 additions & 6 deletions modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,30 +1,31 @@
:description: The Neo4j HTTP API allows to execute a series of Cypher statements against a Neo4j server through HTTP requests.


= Introduction

[WARNING]
====
The HTTP API is currently not available on link:{neo4j-docs-base-uri}/aura[Neo4j Aura].
The HTTP API is not available on <<Aura>>.
Use the link:{neo4j-docs-base-uri}/query-api/current/[Query API] instead.
====

The Neo4j HTTP API allows to execute a series of Cypher statements against a Neo4j server through HTTP requests.

The main use case of the HTTP API is for developing client applications in languages for which there is no supported library.
If there exists an official library (driver) for the language you are using, consider using that instead -- see link:{neo4j-docs-base-uri}/create-applications/[Create applications].

By default, the API uses port 7474 for HTTP and port 7473 for HTTPS.

This guide assumes that you have:

- a running Neo4j instance -- if not, check out how to link:{neo4j-docs-base-uri}/operations-manual/current/installation/[install Neo4j]
- some familiarity with <<Cypher>> -- if you need a hand, check out link:{neo4j-docs-base-uri}/getting-started/cypher-intro/[Getting started -> Cypher].
- A running instance of Neo4j -- If you don't have one, link:https://neo4j.com/docs/operations-manual/current/installation/[install Neo4j locally] or sign up for an link:https://neo4j.com/cloud/platform/aura-graph-database/[Aura cloud instance].
- Some familiarity with <<Cypher>> -- If you are new to it, check out link:https://neo4j.com/docs/getting-started/cypher-intro/[Getting started -> Cypher].

To execute queries through the HTTP API, you may use either:

- xref:query.adoc[Implicit transactions] -- you just submit queries, the API takes care of the transaction handling for you
- xref:transactions.adoc[Explicit transactions] -- you control the lifecycle of the transaction (open, commit, rollback), within which you can execute queries.

[TIP]
By default, the HTTP API uses port 7474 for HTTP and port 7473 for HTTPS.

[NOTE]
As of Neo4j 5.17, the HTTP API supports HTTP/2 as well as HTTP/1.1, unless either is explicitly disabled in the server configuration setting link:https://neo4j.com/docs/operations-manual/5/configuration/configuration-settings/#config_server.http_enabled_transports[`server.http_enabled_transports`].
It's up to the client to initiate a connection with the preferred protocol.
Expand Down
2 changes: 2 additions & 0 deletions modules/ROOT/partials/glossary.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
[glossary]
[[Aura]]Aura:: link:https://neo4j.com/cloud/platform/aura-graph-database/[Aura] is Neo4j's fully managed cloud service.
It comes with both free and paid plans.
[[Cypher]]Cypher:: link:{neo4j-docs-base-uri}/getting-started/cypher-intro/[Cypher] is Neo4j's graph query language that lets you retrieve data from the database.
It is like SQL, but for graphs.
[[ACID]]ACID:: Atomicity, Consistency, Isolation, Durability (ACID) are properties guaranteeing that database transactions are processed reliably.
Expand Down
1 change: 1 addition & 0 deletions preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ asciidoc:
page-origin-private: false
page-hide-toc: false
page-mixpanel: 4bfb2414ab973c741b6f067bf06d5575
page-role: not-on-aura
includePDF: false
nonhtmloutput: ""
experimental: ''
Expand Down
1 change: 1 addition & 0 deletions publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ asciidoc:
page-origin-private: false
page-hide-toc: false
page-mixpanel: 4bfb2414ab973c741b6f067bf06d5575
page-role: not-on-aura
includePDF: false
nonhtmloutput: ""
experimental: ''
Expand Down
Loading