Expand on Neo4j and Query API #634
Conversation
|
|
||
| Neo4j tools have traditionally connected over Bolt, a binary protocol that offers optimal performance and stability, that requires an open WebSocket connection to the Neo4j port. | ||
|
|
There was a problem hiding this comment.
Is this true? I think neo4j has been around for quite some time and as mentioned above, it's built on bolt but it is not the same, so we should probably say that.
There was a problem hiding this comment.
Right, I was curious about why the tooltip in the UI didn't mention Bolt - when a customer hovers over neo4j it says:
"Connect through the Neo4j protocol using a WebSocket connection to the Neo4j port. Use for best performance and stability."
Co-authored-by: Jessica Wright <[email protected]>
Co-authored-by: Jessica Wright <[email protected]>
Co-authored-by: Jessica Wright <[email protected]>
Co-authored-by: Jessica Wright <[email protected]>
modules/ROOT/pages/api/overview.adoc
Outdated
| If you run into any issues with a particular request, you can https://support.neo4j.com/[raise a support ticket] and provide the `X-Request-Id`. | ||
|
|
||
| == Query API |
There was a problem hiding this comment.
Not sure if the Query API belongs in the Aura API. We could maybe change the top level header to API and then have separate sections on Aura API and Query API.
modules/ROOT/pages/api/overview.adoc
Outdated
| To send Cypher queries to an Aura instance, make a POST request to the following endpoint: | ||
|
|
||
| https://<databaseID>.databases.neo4j.io/db/<databaseName>/query/v2 |
There was a problem hiding this comment.
This needs to be escaped, it shouldn't be clickable.
modules/ROOT/pages/api/overview.adoc
Outdated
| ---- | ||
|
|
||
| Note the last line above and inclusion of `:443` is not required as its the default. |
There was a problem hiding this comment.
Then why is it included?
Co-authored-by: Jessica Wright <[email protected]>
Co-authored-by: Jessica Wright <[email protected]>
Co-authored-by: Jessica Wright <[email protected]>
Co-authored-by: Jessica Wright <[email protected]>
|
This PR includes documentation updates New pages: Updated pages: |
|
This PR includes documentation updates New pages: Updated pages: |
| * for Aura instances host is of the format `<databaseID>.databases.neo4j.io` | ||
|
|
||
| * the on-prem documentation refers to port `:7474` and this is true for a on-prem install but Aura, given its HTTPS, the <port> defaults as 443. |
There was a problem hiding this comment.
What do you mean with "on-prem"? This is not terminology we use externally.
| In an enterprise environment with restrictive networking, connection errors are sometimes caused because non-standard ports used by the Neo4j protocol are blocked by firewalls. | ||
|
|
||
| == Query API for Aura |
There was a problem hiding this comment.
I don't think this is the spot for this either. We need to find a better place for it. Let's talk about it!
Co-authored-by: Jessica Wright <[email protected]>
Co-authored-by: Jessica Wright <[email protected]>
Co-authored-by: Jessica Wright <[email protected]>
Co-authored-by: Jessica Wright <[email protected]>
Co-authored-by: Jessica Wright <[email protected]>
|
This PR includes documentation updates New pages: Updated pages: |
No description provided.