How-To Guide
Task-oriented guide solving a specific problem (Diataxis: task-oriented)
Subtopics
86 pages
Add a Schema
Define and add a schema to your TerminusDB database using the HTTP API, TypeScript client, or Python client.
Add Documents
How to insert documents into TerminusDB using the JavaScript client, Python client, or HTTP API.
Advanced Docker Configuration
Production deployment, environment configuration, CLI access, and migration options for TerminusDB Docker containers.
Advanced Filtering
How to use nested conditions, logical operators, and regex patterns to build advanced GraphQL filters in TerminusDB.
Backup & Restore
How to use the TwinfoxDB Enterprise bundle and unbundle API endpoints for database backup, restore, migration, and disaster recovery.
Branch a Project with the TerminusDB Dashboard
A guide to show how to branch projects using the TerminusDB dashboard.
Call TerminusDB from the Browser
How to make HTTP requests to the TerminusDB API from browser JavaScript. No CORS configuration needed — TerminusDB allows all origins by default.
Clone a Database
How to clone a TerminusDB database from a remote server using the TypeScript client, Python client, or HTTP API.
Clone a Project using the TerminusDB Dashboard
A guide to show how to clone a project using the TerminusDB dashboard.
Connect with Apollo Client to use GraphQL with TerminusDB
A reference guide to get you up and running with TerminusDB & TerminusDB using GraphQL and Apollo Client
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.
Delete Documents
How to delete documents from TerminusDB using the JavaScript client, Python client, or HTTP API.
Diff an Object or a Database Branch with the JS Client
A guide to show how to use the JS Client to diff an object or a database branch.
Edit Documents
How to update documents in TerminusDB using the JavaScript client, Python client, or HTTP API.
Edit Documents using WOQL
A guide with example showing how to edit documents using WOQL
Execute WOQL JSON-LD Queries Directly
How to run raw WOQL JSON-LD queries with the JavaScript client, enabling access to new server features before client library support
Filter with GraphQL
How to filter query results using field conditions and comparison operators in TerminusDB GraphQL queries.
Get Documents
How to retrieve documents from TerminusDB using the JavaScript client, Python client, or HTTP API.
GraphQL with RDF URI/IRI
Using GraphQL with RDF and URI/IRI fields with TerminusDB
How to add and delete documents and subdocuments using WOQL
A how-to guide with an example showing how to add documents and subdocuments using a WOQL query.
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 compare values with a CSV file using WOQL
Learn how to efficiently compare a list of values against a CSV file to find additions, deletions, and unchanged items using WOQL
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 delete documents using WOQL
A how-to guide showing how to construct a WOQL query to delete documents.
How to extract tabular data from JSON with WOQL
Learn how to extract rows and columns from JSON arrays using the sys:Dictionary pattern and dot operator in WOQL
How to filter with WOQL
A guide showing how to filter with WOQL in your TerminusDB projects
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 Group Results in WOQL
A guide to show how to group results of data in your TerminusDB projects using WOQL.
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 Order Results in WOQL
A guide to show you how to order results using order_by in WOQL.
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.
How to use the HTTP Documents API
Quick introduction to the HTTP Documents API and how to use common ways to interact with it using various clients as a quick reference guide
How to use the terminusdb CLI query interface
Quick introduction to the terminusdb CLI WOQL Query interface which has a distinct syntax to other flavours.
How to use the TerminusDB Document UI SDK
How to use the TerminusDB Document UI SDK
Import Data with the Python Client
A guide to show how to import CSV data into TerminusDB using the Python Client
Import JSON-LD Documents with WOQL
TerminusDB stores data as RDF triples and presents it as JSON-LD. This guide shows how to load existing JSON-LD from files, APIs, or other sources using the Document API or WOQL.
Index Your Data
How to index your content and data with VectorLink
Install a TerminusDB Client Library
Install the TerminusDB client for TypeScript, Python, or Rust. One command to start building.
Install on Kubernetes
Install TerminusDB on a Kubernetes cluster
Install TerminusDB from Source Code
Everything you need to install TerminusDB from source code.
Install TerminusDB with Docker
Get TerminusDB running locally in under 2 minutes with Docker Compose.
Install TerminusDB with Docker on Windows
Complete guide to installing and running TerminusDB with Docker on Windows, including backup and restore instructions
Invite Users to Your Team
A how-to guide for inviting collaborators to your team using the TerminusDB dashboard.
JSON Diff and Patch with TerminusDB
JSON Diff and Patch reference guide to compare JSON documents.
Language-Tagged RDF Strings with curl
How to store and retrieve multilingual text in TerminusDB using rdf:langString and the HTTP API with curl.
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
Manage Access Control with the CLI
Create users, list roles, grant and revoke capabilities using the TerminusDB CLI. Includes a worked example for anonymous public cloning.
Manual reverse branch cloning
How to manually clone branches between data products
Mathematical Operations in WOQL
How to perform arithmetic, aggregation, and mathematical comparisons in WOQL queries with TerminusDB.
Offset to Provide Paging
A guide showing how to use offset in GraphQL to provide pagination
OpenAI and Handlebars Configuration
How to configure OpenAI embeddings and Handlebars templates for VectorLink semantic indexing in TerminusDB.
Order By in GraphQL
How to use the order by argument in GraphQL queries with TerminusDB
Path Queries in GraphQL
How to do path queries on TerminusDB data products using GraphQL
Path Queries in WOQL
A guide to show how to do path queries in WOQL for your TerminusDB projects.
Perform a Delta Rollup
How delta rollup works in TerminusDB. Automatic in standard deployments via the built-in rollup plugin — manual optimisation is available for custom deployments.
Pull Updates from Remote
How to pull new commits from a remote TerminusDB database into your local clone using the TypeScript client, Python client, or HTTP API.
Push Changes to Remote
How to push local commits to a remote TerminusDB database using the TypeScript client, Python client, or HTTP API.
Queries between Data Products
Learn how to use datalog with knowledge graphs in data products to encode data in a way that resembles the real world, and easily query and manipulate it.
Query Arrays and Sets with WOQL
A guide to show how to query arrays and sets with WOQL in your TerminusDB projects.
Query Documents using the JavaScript Client
A guide to show how to perform basic document queries using the JavaScript Client.
Querying Layers with GraphQL
Learn how to query TerminusDB layer objects using GraphQL to navigate version control history and repository structure.
Read documents with WOQL
A guide to show how to read documents with WOQL in your TerminusDB projects.
Reset a Branch to a Previous Commit
How to reset a TerminusDB branch to a specific commit using the JavaScript client, Python client, or HTTP API.
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.
Schema CRUD Operations
Create, read, update, and delete schema classes and properties in TerminusDB using the TypeScript client, Python client, or HTTP API.
Schema Queries with WOQL
A guide to show how to query schema with WOQL in your TerminusDB projects.
Self-Hosted Installation Guide
How to deploy TerminusDB on your own infrastructure with production-ready configuration. Docker single container, Docker Compose, and bare-metal options.
Set Commit Messages on Document Operations
How to set author and message on document writes so the commit log records who made the change and why.
Set up VectorLink
Steps to set up VectorLink to work with OpenAI
Squash Commits on a Branch
How to squash multiple commits into one using the JavaScript client, Python client, or HTTP API.
Squash Commits with the TerminusDB Dashboard
A guide to show how to squash the commits of a branch or main into one large commit using the TerminusDB dashboard.
Subdocument Handling with WOQL
A comprehensive guide to creating, reading, updating, and deleting subdocuments using WOQL queries in TerminusDB.
Time Travel using the DFRNT TerminusDB cloud dashboard
A guide to show how to time travel to any previous commit using the DFRNT TerminusDB cloud dashboard.
TypeScript Client — Quickstart
Connect to TerminusDB from TypeScript. Branch, edit, diff, and merge documents using the terminusdb npm client.
Use GraphQL Back Links for easy queries
How to traverse relationships in reverse using GraphQL back links (inverseOf) in TerminusDB to query parent documents from children.
Use the DFRNT TerminusDB cloud Dashboard to Curate Data & Content
A how-to guide describing how to use the DFRNT TerminusDB cloud dashboard to add, edit, and delete content and data
Use the JSON View for building a Schema
Use the JSON editor to build your TerminusDB schema. Define documents, properties, links, and enums.
Use the Model Builder UI
The model builder UI allows you to construct classes of objects and define what data they have, and what links (or relationships) they have between them.
WOQL Tips and Tricks
Practical tips and tricks for writing robust WOQL queries, including handling optional bindings, debugging techniques, and query composition patterns.
Working with Data in WOQL
A practical guide to WOQL's data types, variable binding, solutions, typecasting, dicts, lists, group_by, CSV and JSON conversion, and how backtracking drives result generation.
Writing Plugins for TerminusDB
Learn how to write custom plugins for TerminusDB to extend database functionality with hooks and custom behavior.