|
1 | 1 | # Neo4j Metabase driver |
2 | 2 |
|
| 3 | + |
| 4 | + |
| 5 | +[](https://github.com/bbenzikry/metabase-neo4j-driver/releases) |
| 6 | +[](https://raw.githubusercontent.com/bbenzikry/metabase-neo4j-driver/master/LICENSE) |
| 7 | + |
3 | 8 | Simple wrapper around the Neo4j BI connector for metabase. |
4 | 9 |
|
| 10 | +*Note:* This project is a WIP 🚧 |
| 11 | + |
| 12 | +## Installation |
| 13 | + |
| 14 | +### Run with Docker |
| 15 | + |
| 16 | +```bash |
| 17 | +git clone https://github.com/bbenzikry/metabase-neo4j-driver.git |
| 18 | +cd metabase-neo4j-driver |
| 19 | +docker build -t metabase/neo4j . |
| 20 | +docker run --name metabase-neo4j -p 3000:3000 metabase/neo4j |
| 21 | +``` |
| 22 | + |
| 23 | +### JAR installation |
| 24 | + |
| 25 | +- Download the latest metabase version from [here](https://metabase.com/start/jar.html) |
| 26 | +- Download the latest neo4j.metabase-driver.jar jar from the [releases](https://github.com/bbenzikry/metabase-neo4j-driver/releases) page |
| 27 | +- Create a metabase folder and place your metabase.jar |
| 28 | +- Copy neo4j.metabase-driver.jar to the ``plugins/`` folder |
| 29 | + ```bash |
| 30 | + . |
| 31 | + ├── metabase.jar |
| 32 | + └── plugins |
| 33 | + └── neo4j.metabase-driver.jar |
| 34 | + ``` |
| 35 | +- Run ```java -jar metabase.jar``` |
| 36 | + |
| 37 | +## Working with a relational model on graphs |
| 38 | + |
| 39 | +The JDBC driver exposes schemas for **Relationships** and **Nodes** |
| 40 | + |
| 41 | +* Relationships |
| 42 | + |
| 43 | + * The driver creates one table for each distinct combination of source label, relationship type, and target label. |
| 44 | + |
| 45 | +* Nodes |
| 46 | + * The driver only creates tables for nodes that have labels. |
| 47 | + * The driver creates one table for each distinct combination of node labels. |
| 48 | + |
| 49 | + Given |
| 50 | + * Node1, with the label [Alphabet] |
| 51 | + * Node2, with the label [Google] |
| 52 | + * Node3, with the labels[Alphabet,Google] |
| 53 | + |
| 54 | + The following tables will be created: |
| 55 | + * Alphabet |
| 56 | + * Google |
| 57 | + * Alphabet_Google |
| 58 | + |
| 59 | +* Naming |
| 60 | +Separators between node label names and relationship names is an underscore by default |
| 61 | + |
| 62 | +To change the Node name seperator, you can use the LabelSeparator JDBC property, or RelNodeSeperator for Relationship tables. |
| 63 | + |
| 64 | +JDBC properties can be added via the driver configuration as shown in the image below. |
| 65 | + |
| 66 | +> For an up to date list of allowed configuration values, please download the [JDBC driver](https://neo4j.com/bi-connector/) |
| 67 | +
|
| 68 | + |
| 69 | + |
5 | 70 | ## Building the driver |
6 | 71 |
|
7 | 72 | ### Prerequisites |
@@ -49,39 +114,6 @@ cd /path/to/metabase_source |
49 | 114 | lein run |
50 | 115 | ``` |
51 | 116 |
|
52 | | -## Working with a relational model on graphs |
53 | | - |
54 | | -The JDBC driver exposes schemas for **Relationships** and **Nodes** |
55 | | - |
56 | | -* Relationships |
57 | | - |
58 | | - * The driver creates one table for each distinct combination of source label, relationship type, and target label. |
59 | | - |
60 | | -* Nodes |
61 | | - * The driver only creates tables for nodes that have labels. |
62 | | - * The driver creates one table for each distinct combination of node labels. |
63 | | - |
64 | | - Given |
65 | | - * Node1, with the label [Alphabet] |
66 | | - * Node2, with the label [Google] |
67 | | - * Node3, with the labels[Alphabet,Google] |
68 | | - |
69 | | - The following tables will be created: |
70 | | - * Alphabet |
71 | | - * Google |
72 | | - * Alphabet_Google |
73 | | - |
74 | | -* Naming |
75 | | -Separators between node label names and relationship names is an underscore by default |
76 | | - |
77 | | -To change the Node name seperator, you can use the LabelSeparator JDBC property, or RelNodeSeperator for Relationship tables. |
78 | | - |
79 | | -JDBC properties can be added via the driver configuration as shown in the image below. |
80 | | - |
81 | | -> For an up to date list of allowed configuration values, please download the [JDBC driver](https://neo4j.com/bi-connector/) |
82 | | -
|
83 | | - |
84 | | - |
85 | 117 | ## Caveats |
86 | 118 |
|
87 | 119 | **This is a WIP.** |
|
0 commit comments