Skip to content

Commit ce0c835

Browse files
committed
readme
1 parent 1f67d1b commit ce0c835

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@ A Graph Database for Julia, built on top of [SQLite.jl](https://github.com/Julia
44

55
## Quickstart
66

7-
- *Nodes* must have "properties", even if `nothing`.
8-
- *Edges* must have "properties", even if `nothing`.
7+
- *Nodes* and *Edges* must have "properties", even if `nothing`.
8+
- The types returned by `getindex` (`Node`/`Edge`) have a `props` field that contains the JSON String.
9+
- You can read it as whatever type you wish with `JSON3.read(node.props, T)`
910

1011

1112
### Creating a Graph Database
@@ -45,7 +46,7 @@ db[1, :] # all outgoing edges from node 1
4546

4647
db[1, 2:5] # outgoing edges from node 1 to any of nodes 2,3,4,5
4748

48-
db[:, 1] # all incoming edges to node 1
49+
db[:, 2] # all incoming edges to node 2
4950
```
5051

5152
### Querying Based on Properties

0 commit comments

Comments
 (0)