diff --git a/Dockerfile b/Dockerfile index e82a5c6..0e4f81c 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,5 +1,5 @@ FROM metabase/metabase:v0.36.2 ADD --chown=2000:2000 \ - https://github.com/bbenzikry/metabase-neo4j-driver/releases/download/v0.0.2/neo4j.metabase-driver.jar \ + https://github.com/bbenzikry/metabase-neo4j-driver/releases/download/v0.0.3/neo4j.metabase-driver.jar \ /plugins/neo4j.neo4j-driver.jar \ No newline at end of file diff --git a/README.md b/README.md index 928c94f..d350386 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,15 @@ [![Latest Release](https://img.shields.io/github/v/release/bbenzikry/metabase-neo4j-driver.svg?label=latest%20release&include_prereleases)](https://github.com/bbenzikry/metabase-neo4j-driver/releases) [![GitHub license](https://img.shields.io/github/license/bbenzikry/metabase-neo4j-driver)](https://raw.githubusercontent.com/bbenzikry/metabase-neo4j-driver/master/LICENSE) -Simple wrapper around the Neo4j BI connector for metabase. +**SQL** and **Cypher** support for Metabase + +
+ + + + + +
_Note:_ This project is a WIP 🚧 @@ -23,7 +31,7 @@ docker run --name metabase-neo4j -p 3000:3000 metabase/neo4j ### JAR installation - Download the latest metabase version from [here](https://metabase.com/start/jar.html) -- Download the latest neo4j.metabase-driver.jar jar from the [releases](https://github.com/bbenzikry/metabase-neo4j-driver/releases) page +- Download the latest ``neo4j.metabase-driver.jar`` from the [releases](https://github.com/bbenzikry/metabase-neo4j-driver/releases) page - Create a metabase folder and place your metabase.jar - Copy neo4j.metabase-driver.jar to the `plugins/` folder ```bash @@ -34,6 +42,13 @@ docker run --name metabase-neo4j -p 3000:3000 metabase/neo4j ``` - Run `java -jar metabase.jar` + +## Using Cypher + +- Cypher is currently only implemented for explicit querying +- All cypher queries must return column based results ( aggregation results or column values ) +![cypher_use](./screenshots/cypher.png) + ## Working with a relational model on graphs The JDBC driver exposes schemas for **Relationships** and **Nodes** @@ -121,20 +136,27 @@ lein run **This is a WIP.** -It is not heavily tested and is not compatible with neo4j 3.5 ( even though the underlying driver is ) +It is not heavily tested and is not compatible with neo4j 3.5 ( even though the underlying JDBC driver is ) ## TODO - ~~Edge properties~~ - ~~Timestamp casting support~~ +- ~~Cypher support~~ - Testing + - CI ## Future -- Support Cypher extended queries as BI connector matures -- Cypher and graph viz for Metabase ( directly or via ad-hoc JDBC driver ) +- Support complex results in cypher ( e.g. non relational projections ) +- Graph viz support ## Known issues - Initial DB creation and/or sync may time out. You can configure a higher timeout value with the `MB_DB_CONNECTION_TIMEOUT_MS` environment variable. + + +
+Logos and images used in this document are licensed to their original creators and do not indicate any affiliation with this project +
\ No newline at end of file diff --git a/screenshots/cypher.png b/screenshots/cypher.png new file mode 100644 index 0000000..38b65b0 Binary files /dev/null and b/screenshots/cypher.png differ diff --git a/screenshots/db.png b/screenshots/db.png index d2b3017..765c587 100644 Binary files a/screenshots/db.png and b/screenshots/db.png differ diff --git a/screenshots/rel.png b/screenshots/rel.png index 40231e1..7814479 100644 Binary files a/screenshots/rel.png and b/screenshots/rel.png differ diff --git a/screenshots/schema.png b/screenshots/schema.png index 1ace838..516bed6 100644 Binary files a/screenshots/schema.png and b/screenshots/schema.png differ