Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bbenzikry/sqlalchemy-neo4j
SQL Alchemy dialect for Neo4j
https://github.com/bbenzikry/sqlalchemy-neo4j
Last synced: about 1 month ago
JSON representation
SQL Alchemy dialect for Neo4j
- Host: GitHub
- URL: https://github.com/bbenzikry/sqlalchemy-neo4j
- Owner: bbenzikry
- License: mit
- Created: 2021-10-13T10:43:42.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-26T22:20:09.000Z (over 1 year ago)
- Last Synced: 2024-09-28T12:13:35.894Z (about 2 months ago)
- Language: Python
- Size: 34.2 KB
- Stars: 12
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SQL Alchemy dialect for Neo4j
This package provides the SQL dialect for Neo4j, using the official JDBC driver (the Neo4j "BI Connector" )
## Installation
```bash
pip install sqlalchemy-neo4j
```
## Prerequisites
- Java 8 / 11
- Download the [Neo4j BI Connector](https://neo4j.com/bi-connector/)
> The reason the JAR is not included in the package is due to licensing concerns. I may add the jar into the bundle in the future.
- Add the jar to the classpath, either directly via the ``CLASSPATH`` environment variable or while initializing the JVM
> You can also use the ``NEOJDBC_WARMUP`` environment variable, which will ensure we reuse an existing jpype instance or create a new one ( with default parameters )
## Getting started
```python
from sqlalchemy import create_engine
# This happens automatically if you set the NEOJDBC_WARMUP environment variable
jpype.startJVM()
eng = create_engine("neo4j+jdbc://neo4j-neo4j:7687/neo4j?UID=neo4j&PWD=QUOTED_PASSWORD&LogLevel=6&StrictlyUseBoltScheme=false")
execute = engine.execute("select * from Node.YOUR_NODE limit 1")
rows = execute.fetchall()
for row in rows:
print(row)
```
See more [examples](./examples/)
## Related projects
* [Neo4j Metabase Driver](https://github.com/bbenzikry/metabase-neo4j-driver) - Use Neo4j with Metabase. Use both SQL and Cypher ( the driver uses the same underlying BI connector for SQL queries )
## Future
- Add Cypher support
- Add support for Cypher views in JDBC driver
- Add ORM support and testing
## Donations ##
