Skip to content

Commit a3548ea

Browse files
committed
update README
1 parent 312c049 commit a3548ea

File tree

1 file changed

+30
-27
lines changed

1 file changed

+30
-27
lines changed

README.md

Lines changed: 30 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
Simple wrapper around the Neo4j BI connector for metabase.
99

10-
*Note:* This project is a WIP 🚧
10+
_Note:_ This project is a WIP 🚧
1111

1212
## Installation
1313

@@ -25,39 +25,42 @@ docker run --name metabase-neo4j -p 3000:3000 metabase/neo4j
2525
- Download the latest metabase version from [here](https://metabase.com/start/jar.html)
2626
- Download the latest neo4j.metabase-driver.jar jar from the [releases](https://github.com/bbenzikry/metabase-neo4j-driver/releases) page
2727
- Create a metabase folder and place your metabase.jar
28-
- Copy neo4j.metabase-driver.jar to the ``plugins/`` folder
28+
- Copy neo4j.metabase-driver.jar to the `plugins/` folder
2929
```bash
3030
.
3131
├── metabase.jar
3232
└── plugins
3333
└── neo4j.metabase-driver.jar
3434
```
35-
- Run ```java -jar metabase.jar```
35+
- Run `java -jar metabase.jar`
3636

3737
## Working with a relational model on graphs
3838

3939
The JDBC driver exposes schemas for **Relationships** and **Nodes**
4040

41-
* Relationships
41+
- Relationships
4242

43-
* The driver creates one table for each distinct combination of source label, relationship type, and target label.
43+
- The driver creates one table for each distinct combination of source label, relationship type, and target label.
44+
45+
- Nodes
46+
47+
- The driver only creates tables for nodes that have labels.
48+
- The driver creates one table for each distinct combination of node labels.
4449

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-
4950
Given
50-
* Node1, with the label [Alphabet]
51-
* Node2, with the label [Google]
52-
* Node3, with the labels[Alphabet,Google]
53-
51+
52+
- Node1, with the label [Alphabet]
53+
- Node2, with the label [Google]
54+
- Node3, with the labels[Alphabet,Google]
55+
5456
The following tables will be created:
55-
* Alphabet
56-
* Google
57-
* Alphabet_Google
5857

59-
* Naming
60-
Separators between node label names and relationship names is an underscore by default
58+
- Alphabet
59+
- Google
60+
- Alphabet_Google
61+
62+
- Naming
63+
Separators between node label names and relationship names is an underscore by default
6164

6265
To change the Node name seperator, you can use the LabelSeparator JDBC property, or RelNodeSeperator for Relationship tables.
6366

@@ -82,7 +85,7 @@ lein install-for-building-drivers
8285

8386
#### Download and install the Neo4j BI connector
8487

85-
* Get the connector [here](https://neo4j.com/bi-connector/)
88+
- Get the connector [here](https://neo4j.com/bi-connector/)
8689

8790
```bash
8891
# cp the jar to the maven dir
@@ -105,7 +108,7 @@ cp target/uberjar/neo4j.metabase-driver.jar /path/to/metabase/plugins/
105108
jar -jar /path/to/metabase/metabase.jar
106109
```
107110

108-
*or:*
111+
_or:_
109112

110113
```bash
111114
mkdir -p /path/to/metabase_source/plugins
@@ -122,16 +125,16 @@ It is not heavily tested and is not compatible with neo4j 3.5 ( even though the
122125

123126
## TODO
124127

125-
* Edge properties
126-
* Timestamp casting support
127-
* Testing
128-
* CI
128+
- ~~Edge properties~~
129+
- ~~Timestamp casting support~~
130+
- Testing
131+
- CI
129132

130133
## Future
131134

132-
* Support Cypher extended queries as BI connector matures
133-
* Cypher and graph viz for Metabase ( directly or via ad-hoc JDBC driver )
135+
- Support Cypher extended queries as BI connector matures
136+
- Cypher and graph viz for Metabase ( directly or via ad-hoc JDBC driver )
134137

135138
## Known issues
136139

137-
* 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.
140+
- 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.

0 commit comments

Comments
 (0)