a68896c4a0
* docs(readme): add embedded quick-start run-through + trim Clients
- Quick start: a copy-pasteable embedded (local file) run-through
(schema → init → load → query → branch), followed by a "Storage backends"
table that surfaces the one thing that changes across embedded / S3 object
storage / RustFS-MinIO — the graph address — with a pointer to cluster mode
for served multi-graph deployments.
- Clients: collapse to a two-line pointer (npm packages + omnigraph-ts repo);
Python SDK marked coming soon.
* docs(readme,quickstart): fix init addressing + drop non-parsing schema commas
Addresses PR review (both verified against source):
- README "Storage backends": `init` takes the graph address as a positional
argument, not `--store` (`Command::Init { uri: String }`) — Codex. Table now
shows bare addresses and a note on which flag each verb uses.
- docs/user/quickstart.md: drop trailing commas in the schema. The .pg grammar
(`prop_decl = { ident ~ ":" ~ type_ref ~ annotation* }`, node body
`(prop_decl | body_constraint)*`, comma not in WHITESPACE) has no comma rule,
so `name: String,` fails to parse — Greptile.
2.3 KiB
Quickstart
This walks the core loop end to end: define a schema, initialize a graph, load
data, query it, and use a branch. It uses a local file-backed graph; swap the
path for an s3://… URI to run the same flow against object storage.
Install the omnigraph CLI first.
1. Write a schema
A schema (.pg) declares your node and edge types. Save this as schema.pg:
node Person {
name: String
title: String?
}
See the schema language for types, constraints, and edges.
2. Initialize the graph
omnigraph init --schema schema.pg graph.omni
init creates an empty graph at the given URI with your schema applied.
3. Load data
load is the single bulk-write command. --mode is required
(overwrite | append | merge):
omnigraph load --data people.jsonl --mode overwrite graph.omni
people.jsonl is newline-delimited JSON, one record per line. For finer-grained
or inline writes, see mutations.
4. Query
Write a query (.gq) — save as queries.gq:
query find_people($title: String) {
match { $p: Person { title: $title } }
return { $p.name }
}
Run it:
omnigraph query find_people --query queries.gq \
--params '{"title":"Engineer"}' --format table --store graph.omni
The query name is positional; --query points at the .gq source and
--store addresses the graph's storage directly.
The query language covers match/return/order, and
search covers vector and full-text search.
5. Work on a branch
Branches isolate changes until you merge them — Git-style, across the whole graph:
omnigraph branch create review/new-hires graph.omni
omnigraph load --data new-hires.jsonl --mode append --branch review/new-hires graph.omni
# inspect the branch, then integrate it
omnigraph branch merge review/new-hires --into main graph.omni
See branches & commits and merging.
Next steps
- CLI reference — every command and flag.
- Schema language and query language.
- Operating a cluster and running the server for multi-graph, multi-user deployments.