Skip to content

Commit cd5c646

Browse files
Tweaks ahead of Query API GA (#110)
1 parent 29f3cf7 commit cd5c646

File tree

4 files changed

+11
-6
lines changed

4 files changed

+11
-6
lines changed

modules/ROOT/pages/index.adoc

+7-6
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,31 @@
11
:description: The Neo4j HTTP API allows to execute a series of Cypher statements against a Neo4j server through HTTP requests.
22

3+
34
= Introduction
45

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

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

1214
The main use case of the HTTP API is for developing client applications in languages for which there is no supported library.
1315
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].
1416

17+
By default, the API uses port 7474 for HTTP and port 7473 for HTTPS.
18+
1519
This guide assumes that you have:
1620

17-
- a running Neo4j instance -- if not, check out how to link:{neo4j-docs-base-uri}/operations-manual/current/installation/[install Neo4j]
18-
- some familiarity with <<Cypher>> -- if you need a hand, check out link:{neo4j-docs-base-uri}/getting-started/cypher-intro/[Getting started -> Cypher].
21+
- 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].
22+
- Some familiarity with <<Cypher>> -- If you are new to it, check out link:https://neo4j.com/docs/getting-started/cypher-intro/[Getting started -> Cypher].
1923

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

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

25-
[TIP]
26-
By default, the HTTP API uses port 7474 for HTTP and port 7473 for HTTPS.
27-
2829
[NOTE]
2930
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`].
3031
It's up to the client to initiate a connection with the preferred protocol.

modules/ROOT/partials/glossary.adoc

+2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
[glossary]
2+
[[Aura]]Aura:: link:https://neo4j.com/cloud/platform/aura-graph-database/[Aura] is Neo4j's fully managed cloud service.
3+
It comes with both free and paid plans.
24
[[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.
35
It is like SQL, but for graphs.
46
[[ACID]]ACID:: Atomicity, Consistency, Isolation, Durability (ACID) are properties guaranteeing that database transactions are processed reliably.

preview.yml

+1
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ asciidoc:
3939
page-origin-private: false
4040
page-hide-toc: false
4141
page-mixpanel: 4bfb2414ab973c741b6f067bf06d5575
42+
page-role: not-on-aura
4243
includePDF: false
4344
nonhtmloutput: ""
4445
experimental: ''

publish.yml

+1
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ asciidoc:
4646
page-origin-private: false
4747
page-hide-toc: false
4848
page-mixpanel: 4bfb2414ab973c741b6f067bf06d5575
49+
page-role: not-on-aura
4950
includePDF: false
5051
nonhtmloutput: ""
5152
experimental: ''

0 commit comments

Comments
 (0)