oxilite-cli
The oxilite command line: an interactive SPARQL shell, load, query and explain a SQLite-backed RDF store, or serve it over the SPARQL 1.1 protocol with the same routes as oxigraph serve.
Website · API docs · Guide and architecture · Changelog and issues
Install
Shell
oxilite> PREFIX ex: <http://example.com/>
oxilite> INSERT DATA { ex:alice a foaf:Person ; foaf:name "Alice" ; ex:knows ex:bob }
OK · 412 µs
oxilite> SELECT ?who ?name WHERE {
...> ?who a foaf:Person ; foaf:name ?name
...> };
┌──────────┬───────┐
│ who │ name │
├──────────┼───────┤
│ ex:alice │ Alice │
└──────────┴───────┘
1 row · 380 µs
oxilite> .exit
A statement runs as soon as it is complete on one line; a statement over several lines runs when it ends with ; or an empty line. Tab completes dot-commands, SPARQL keywords, prefixes, variables and the store's own predicates and classes in the position they fit. Well-known prefixes (rdf, rdfs, owl, xsd, foaf, schema, …) are predeclared, and PREFIX declarations and loaded Turtle files add to them. Results are tables fitted to the terminal; .mode switches to JSON, XML, CSV, TSV or an RDF format. .help lists the commands: .open, .save, .load, .read, .dump, .explain, .datalog, .graphs, .stats, .prefix, .reasoning, .register, .registry, .timer, .maxrows, .exit and more. History is kept in ~/.oxilite_history.
Commands
Ontologies, shapes and reasoning
|||
A database the CLI creates starts with the system graphs: the oxl: vocabulary in <oxilite:vocabulary> and the registry's own description (--no-system-graphs opts out). Registrations are RDF in the named graph <oxilite:schema>, so the same setup works on Oxigraph with plain SPARQL; each ontology entails only for the graphs it applies to. In the shell: .register, .map, .registry, .shapes, .reasoning, .inferred, .schemagraphs, .materialize. See the schema registry reference.
Versioning
A store keeps its level: opening never changes it. Lowering a level freezes the history (queryable up to the freeze) and deletes it only with --allow-loss. serve answers /query?version=HEAD~1.
serve speaks the SPARQL 1.1 Protocol and Graph Store Protocol at /query, /update and /store, so clients and tools written for oxigraph serve work unchanged. Query results come as JSON, XML, CSV or TSV, graph results in any RDF format. Run oxilite help <command> for every option.
The database is an ordinary SQLite file: open it from Rust with oxilite, from Node.js with @oxilite/node, or with any SQLite tool.
The oxilite family
oxilite is an Oxigraph-compatible RDF database and SPARQL 1.1 engine that stores its data in SQLite, so it runs anywhere SQLite runs: in-process, on a system or vendor libsqlite3, on Cloudflare D1 and in Durable Objects. The same data can be queried with SPARQL and openCypher, reasoned over with RDFS / OWL, and validated with SHACL and ShEx. Read the overview on oxilitedb.com and the full guide in the main README.
| Package | What it is for |
|---|---|
oxilite |
The store: a drop-in for oxigraph::store::Store, plus AsyncStore for D1 |
oxilite-core |
The sans-IO core: term encoding, schema, SPARQL → SQL compiler and planner |
oxilite-rusqlite |
In-process backend with a bundled SQLite (the default) |
oxilite-dylib |
Backend that loads your own libsqlite3 at runtime |
oxilite-d1 |
Cloudflare D1 backend for Rust Workers |
oxilite-cypher |
openCypher over the same data, OWL- and SHACL-aware |
oxilite-jsonld |
JSON-LD documents stored verbatim, one named graph each |
oxilite-vc |
Verifiable Credentials: stored under their id, indexed, queryable |
oxilite-reason |
OWL 2 RL materialization with reasonable |
oxilite-validate |
SHACL and ShEx validation with rudof |
oxilite-cli |
The oxilite command and a SPARQL endpoint like oxigraph serve |
@oxilite/node |
Node.js bindings, API of Oxigraph's JS package |
@oxilite/d1 |
Cloudflare D1 and Durable Objects from TypeScript (WebAssembly core) |
@oxilite/common |
RDF/JS terms and shared TypeScript types |
License
Dual-licensed under MIT or Apache-2.0, at your option, like Oxigraph.