aws/amazon-neptune-jdbc-driver

[FEATURE] Document getting a neo4j Driver w/IAM support

Opened this issue · 2 comments

er1c commented
  • Have you validated that this is not currently reported in
    limitations or
    milestones? If so, please link it.

Feature Request Related to a Problem?

Abstract out the neptune-compatible neo4j Driver (or just document it better?). I want to use a library like: https://github.com/neotypes/neotypes that requires the neo4j Driver interface, but I also need/want IAM support.

It seems like some (all?) of this is being implemented in https://github.com/aws/amazon-neptune-jdbc-driver/blob/develop/src/main/java/software/aws/neptune/opencypher/OpenCypherQueryExecutor.java#L22-L83

The AWS docs on this (https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-bolt.html#access-graph-opencypher-bolt-java-iam-auth) have some java code, but 1) it's for an old neo4j driver, and 2) it is aws sdk v1

Describe the Solution

Document howto get a GraphDatabase.driver with the assistance of the amazon-neptune-jdbc-driver

Describe Alternatives that have been Considered

The AWS docs should be updated?

Cole-Greer commented

Hi @er1c, the underlying neo4j driver instance is not intended to be exposed to end users. I'm not sure I understand your use case correctly. Are you simply using the JDBC driver to obtain a Neo4j Driver instance, or are you looking to connect via JDBC, modify the Neo4j driver, and then continue to use the JDBC connection?

xiazcy commented

Thank you for creating the issue. As Cole noted, could you please elaborate on how you are trying to use the JDBC?
If you are simply trying to connect to Neptune with openCypher, the AWS docs you've linked should allow you to use the Neo4j driver directly, which will create the connection for querying through the Neo4j driver itself. In this case, you don't need to use the JDBC driver.