Beginner
Content suitable for users new to TerminusDB or databases in general
61 pages
Access Control Tutorial
Step-by-step tutorial to create a read-only user and grant database access in TerminusDB using curl. Takes less than 10 minutes.
Clone a Demo Database
Clone a demo database from the public templates server to your local TerminusDB instance — no account required.
Explore a Real Dataset — Star Wars Tutorial
Clone, query, branch, and diff a Star Wars database in 15 minutes. Learn TerminusDB's git-for-data workflow on real data.
Explore an Ecommerce Dataset
Clone an ecommerce database, query orders across customers, branch to update an order status, and see the structural diff — in 15 minutes.
Getting Started
Technical documentation for TerminusDB and the DFRNT TerminusDB cloud.
Git-like version control for JSON data
TerminusDB gives JSON documents Git-like version control — structural diff, patch, branches, and full commit history. Store schemaless JSON with automatic deduplication. Tutorial with curl examples.
How to query with datalog (WOQL)
Hands-on learn by doing tutorial to learn the WOQL Datalog language with working JavaScript examples
Learn WOQL: An Interactive Tutorial
A hands-on interactive tutorial that teaches the WOQL query language from first principles, with runnable examples you can edit and execute against your local TerminusDB instance.
Python Client — Quickstart
Connect to TerminusDB from Python. Branch, edit, diff, and merge documents using the terminusdb-client Python library.
Tutorial 1: Dates, Comparisons & Range Queries
Hands-on tutorial using the WOQL Playground to learn date representation, comparison predicates, half-open range filtering, and the as-of vs period query pattern.
WOQL Basics — Pattern Matching and Graph Traversal
WOQL is TerminusDB's Datalog-based query language for pattern matching, graph traversal, and data transformation. Learn the basics with worked examples.
WOQL Getting Started
Examples to Get Started with the TerminusDB Web Object Query Langauge (WOQL)
Your First 10 Minutes with TerminusDB
Get started with TerminusDB in 10 minutes. Clone a ready-made dataset, then branch, diff, and merge — the full git-for-data workflow with zero setup.
Your First 15 Minutes — Build from Scratch
Build a complete git-for-data workflow from scratch. Create a database, insert a document, branch, edit, diff branches, and merge — step by step with curl.
Add a Schema
Define and add a schema to your TerminusDB database using the HTTP API, TypeScript client, or Python client.
Branch a Project with the TerminusDB Dashboard
A guide to show how to branch projects using the TerminusDB dashboard.
Clone a Project using the TerminusDB Dashboard
A guide to show how to clone a project using the TerminusDB dashboard.
Create a Database
Create a new TerminusDB database using the HTTP API, TypeScript client, or Python client.
Create teams using TerminusDB
A how-to guide for creating teams using the TerminusDB dashboard.
Filter with GraphQL
How to filter query results using field conditions and comparison operators in TerminusDB GraphQL queries.
How to Branch Your Database
Step-by-step guide to database branching in TerminusDB — create, list, switch, diff, merge, and delete branches with HTTP API, TypeScript, and Python examples.
How to connect to TerminusDB
How to connect with TerminusDB using an API key
How to create a project with TerminusDB
A how-to guide showing you how to create a new project using the TerminusDB dashboard
How to get your API key using the DFRNT TerminusDB cloud
A how-to guide showing how to get your API key to set up and configure your environment to use with a client.
How to Merge Branches
Step-by-step guide to merging branches in TerminusDB — apply changes, detect conflicts, resolve them, and roll back failed merges. HTTP API, TypeScript, and Python examples.
How to Time-Travel (Query Historical Data)
Step-by-step guide to querying historical data in TerminusDB — get commit history, query at a specific commit, compare points in time, and restore previous states. HTTP API, TypeScript, and Python examples.
How to Undo Changes (Reset, Revert, Squash)
Step-by-step guide to undoing changes in TerminusDB — reset to a previous commit, revert specific changes, squash commits, and understand the difference between reset and revert. HTTP API, TypeScript, and Python examples.
Install TerminusDB with Docker
Get TerminusDB running locally in under 2 minutes with Docker Compose.
Invite Users to Your Team
A how-to guide for inviting collaborators to your team using the TerminusDB dashboard.
Learn the GraphQL Basics for TerminusDB
Learn to query TerminusDB using GraphQL with a Star Wars dataset cloned from the public templates server.
Limit Results with GraphQL
How to use limit to limit query results with GraphQL
Offset to Provide Paging
A guide showing how to use offset in GraphQL to provide pagination
Order By in GraphQL
How to use the order by argument in GraphQL queries with TerminusDB
Read documents with WOQL
A guide to show how to read documents with WOQL in your TerminusDB projects.
Reset a Project with the TerminusDB Dashboard
A guide to show how to reset to a particular commit of a branch or main using the TerminusDB dashboard.
Run a WOQL Query
Execute WOQL queries against your TerminusDB database using the HTTP API, TypeScript client, or Python client.
TypeScript Client — Quickstart
Connect to TerminusDB from TypeScript. Branch, edit, diff, and merge documents using the terminusdb npm client.
Connecting to GraphQL Reference Guide
A reference guide detailing connecting to GraphQL with TerminusDB.
Glossary of Terms for TerminusDB
A glossary of terms for TerminusDB to ensure terms are clearly defined and understood in the same way across the community to enable better conversations
How to Model Schema
Bit sized how to guides to help you model and build schema for TerminusDB projects.
How to Query with GraphQL
Comprehensive guides for querying and modifying data in TerminusDB using GraphQL including queries, mutations, filtering, and more.
How to Use the Clients
How to guides to use the JavaScrip and Python Clients with TerminusDB
How to Use the JavaScript Client
Bite sized how to guides to get you up and running with the JavaScript Client
How to Use the Python Client
Bite sized how to guides to help you get started with the Python Client
TerminusDB Installation Options
Choose how you'd like to install TerminusDB
ACID Transactions Explanation
An explanation about ACID Transactions and how TerminusDB ensures ACID compliance, Atomicity, Consistency, Isolation, and Durability
Choosing a Query Interface: WOQL, GraphQL, or HTTP API
Compare TerminusDB's three query interfaces — HTTP Document API, GraphQL, and WOQL — and decide which to use for your workload.
Document Graph API Howto
A howto guide for the TerminusDB document API interface.
Getting Started
TerminusDB Technical Documentation
Knowledge Graph Database with Git-like Version Control
An instructional overview of TerminusDB as a git-for-data knowledge graph database — covering commits, branches, merges, rollback, diff and patch, time travel, and the similarities and differences with Git.
Next steps with TerminusDB
An overview of the ways to get started with TerminusDB with Javascript and Python on Windows, macOS, or Linux, and how to run it locally or in the cloud.
TerminusDB Documentation
TerminusDB is an open-source document graph database with built-in version control. Branch, diff, and merge your data like code. Start in 10 minutes with Docker.
TerminusDB vs MongoDB
A neutral, factual comparison of TerminusDB and MongoDB — data model, schema enforcement, version control, querying, and when to choose each document database.
TerminusDB vs Neo4j
A neutral, factual comparison of TerminusDB and Neo4j — data model, query language, version control, schema enforcement, and when to choose each.
TerminusDB: At a glance
Description of the key technical features and capabilities of TerminusDB at a glance with links to the documentation
The Open Source Knowledge Graph Database
An instructional overview of TerminusDB as an open source knowledge graph database — a NoSQL graph database built on the closed world assumption of RDF, with an immutable history, ACID transactions, and a document-shaped class system that keeps related triples on a shared lifecycle.
The WOQL Query Language, Explained
WOQL (Web Object Query Language) is TerminusDB's declarative Datalog-based query language. Traverse document relationships without JOINs, branch-aware, with built-in unification.
What is Datalog?
Datalog is a declarative query language for graph databases. Learn what Datalog is, how it compares to SQL, and why it excels at recursive queries.
What is DFRNT Hub?
Learn about DFRNT Hub, the company behind TerminusDB's commercial hosting and enterprise solutions.
What is TerminusDB?
TerminusDB is an open-source document graph database with built-in version control. Branch, diff, merge, and time-travel your data like Git — with ACID transactions.
WOQL Common Patterns
Ten practical WOQL query patterns you can copy and adapt — filter, join, aggregate, path query, insert, update, delete, schema query, time-travel, and subgraph queries.