Graph Documents
Document CRUD operations (add, get, edit, delete, query)
65 pages
Curl Quickstart - JSON Documents
Use curl and the TerminusDB HTTP API to create a database, store unstructured JSON, then add a schema for structured JSON-LD documents.
Multi-Format Document API with curl
A hands-on tutorial for using the TerminusDB Document API with curl to work with JSON, JSON-LD, RDF/XML, and Turtle formats. Covers a full round-trip cycle for enterprise reference data management.
Python Client — Quickstart
Connect to TerminusDB from Python. Branch, edit, diff, and merge documents using the terminusdb-client Python library.
Rust Client — Getting Started
Connect to TerminusDB from Rust using the community-contributed terminusdb-client crate.
Add Documents
How to insert documents into TerminusDB using the JavaScript client, Python client, or HTTP API.
Backup & Restore
How to use the TerminusDB Enterprise Edition bundle and unbundle API endpoints for database backup, restore, migration, and disaster recovery.
Create a Database
Create a new TerminusDB database using the HTTP API, TypeScript client, or Python client.
Delete Documents
How to delete documents from TerminusDB using the JavaScript client, Python client, or HTTP API.
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
Get Documents
How to retrieve documents from TerminusDB using the JavaScript client, Python client, or HTTP API.
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 delete documents using WOQL
A how-to guide showing how to construct a WOQL query to delete documents.
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 Document UI SDK
How to use the TerminusDB Document UI SDK
Language-Tagged RDF Strings with curl
How to store and retrieve multilingual text in TerminusDB using rdf:langString and the HTTP API with curl.
Query Documents using the JavaScript Client
A guide to show how to perform basic document queries using the JavaScript Client.
Read documents with WOQL
A guide to show how to read documents with WOQL in your TerminusDB projects.
Subdocument Handling with WOQL
A comprehensive guide to creating, reading, updating, and deleting subdocuments using WOQL queries in TerminusDB.
Use TerminusDB Cloud Dashboard to Curate Data & Content
A how-to guide describing how to use 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.
Command Line Interface (CLI) Commands
Documentation of the TerminusDB command line interface (CLI) that enables users to interact with the local database using git-for-data and other operations
Database Path Identifiers Reference
Reference guide for GRAPH_SPEC, DB_SPEC, and path identifiers used in TerminusDB CLI, REST API, and client libraries to address databases, branches, commits, and graphs
Document API Reference Guide
A reference guide for the TerminusDB document API interface.
Document Formats & Content Negotiation
How to read and write TerminusDB documents as JSON, JSON-LD, RDF/XML, or Turtle using query parameters or HTTP content negotiation.
Document UI Components
A list of components and links to further information for the document UI components to build dashboards quickly.
Document UI Template
The Document UI Template provides ready-made React components to assemble a document-driven dashboard quickly with TerminusDB.
Document Unfolding and Cycle Detection Reference
Understanding @unfoldable annotation, cycle detection, and performance characteristics of document traversal in TerminusDB
DocumentClassesSummary Component
The DocumentClassesSummary component allows you to visualize document classes using interactive cards.
Documents UI SDK Data Types
Understand the different data types to build data driven user interfaces
EditDocumentComponent
The EditDocumentComponent allows you to edit an existing document using the FrameViewer component
GraphQL Mutations Reference
Learn how to insert, replace, and delete documents in TerminusDB using GraphQL mutations including _insertDocuments, _replaceDocuments, and _deleteDocuments.
How to Curate & Import Data
How to guides for curating and importing data into TerminusDB and TerminusDB
ListDocumentsComponent
The ListDocumentsComponent element allows you to visualize the documents inside the TDBReactTable and query the documents using the advanced search component
NewDocumentComponent
The NewDocumentComponent allows you to create new documents using the FrameViewer
Numeric Types and Precision Reference
Understanding xsd:decimal, xsd:double, xsd:float arithmetic operations and precision handling in TerminusDB
RDF/XML Support
How TerminusDB Enterprise Edition serializes and parses RDF/XML documents with proper namespace declarations, typed literals, subdocument nesting, and round-trip integrity.
sys:JSON Properties in the Document UI
How to use sys:JSON properties in the document UI
TerminusDB Document Types Compared
Compare TerminusDB document types - when to use regular documents, subdocuments, and shared documents for different ownership and lifecycle patterns
TerminusDB React Table
Learn how to include TerminusDB React Table components in your projects to display documents in an interactive table
Turtle Support
How TerminusDB Enterprise Edition serializes and parses Turtle (TTL) documents with prefix declarations, typed literals, subdocument nesting, and round-trip integrity.
UI SDK GeoJSON for geographic data structures
Understand how <FrameViewer/> can load geoJSON to display geographic data structures in Create, Edit or View Mode
ViewDocumentComponent
The ViewDocumentComponent allows you to view existing documents using the FrameViewer component
ACID Transactions Explanation
An explanation about ACID Transactions and how TerminusDB ensures ACID compliance, Atomicity, Consistency, Isolation, and Durability
Document Graph API Howto
A howto guide for the TerminusDB document API interface.
Graphs Explanation
An introduction to the hierarchy and system of graphs used by TerminusDB for collaboration and revision control.
Immutability and Concurrency
Why TerminusDB avoids locks and how its immutable delta architecture enables safe concurrent access.
Immutable Database Explained
Immutable database explained: what it is, how TerminusDB stores each change as an immutable commit, and what you get from it — audit, time travel, branches.
sys:JSON Internals - How It Works
Technical deep dive into sys:JSON implementation, storage, and behavior in TerminusDB
TerminusDB Document Model — Documents, Subdocuments, and Graph Relationships
TerminusDB stores graph documents in a schema-enforced triple store. Documents have typed relationships, subdocuments for nested data, and shared documents for reuse — combining document-store convenience with graph traversal power.
TerminusDB Internals
Examples to use the internals of TerminusDB from the command line.
The Write Path: Performance Internals
High-level overview of how TerminusDB handles document writes, the commit pipeline introduced in 12.1, and how to optimize for throughput.
Data Model Mismatches — TerminusDB Troubleshooting
Fix data model issues in TerminusDB including wrong @id format, Set vs Array confusion, Optional field handling, and @key strategy problems.
TerminusDB 11.0.0: Typed Storage Backend and Migration
TerminusDB 11.0.0 moves storage to typed XSD files and layer archives, so data files are smaller and typed. A one-time migration tool is required.
TerminusDB 11.0.3: The Patch Endpoint
TerminusDB 11.0.3 lets you apply a JSON diff to documents with the patch endpoint, so structural edits land in one commit. Also: a memory-pinning option.
TerminusDB 11.0.4: The Document History API
TerminusDB 11.0.4 lets you ask when a document changed through the history API, so audit trails need no manual bookkeeping. Also: experimental migrations.
TerminusDB 11.0.6: Automatic Schema Migrations
TerminusDB 11.0.6 lets you migrate data automatically when the schema changes, so class updates carry existing documents along. Also: paged diffs.
TerminusDB 11.1.10: Delete All Documents of a Type
TerminusDB 11.1.10 lets you delete every document of a type in one call, so cleanup needs no loop. Also: WOQL AST type inference, faster deletes.
TerminusDB 11.1.2: Merge Inserts with merge_repeats
TerminusDB 11.1.2 lets you merge repeated inserts for one @id with merge_repeats, so bulk imports stay idempotent. Path traversal is faster too.
TerminusDB 12.0.0: Precise Numbers and Free-Form JSON
TerminusDB 12.0.0 lets you store free-form JSON with deduplication and keep precise rational numbers, so numeric data stays exact. Also: sys:Dictionary docs.
TerminusDB 12.0.5: Streaming History with Diffs
TerminusDB 12.0.5 lets you stream document history with per-commit diffs, so audits show what changed when. Also: group_by on compound values.
TerminusDB 12.0.6: Shared Documents and Handlebars Text Rendering
TerminusDB 12.0.6 lets you share documents between parents with @shared and cascade-delete them, so linked records clean themselves up. Also: Handlebars.
TerminusDB 12.0.7: Resolve Merge Conflicts with Insert and Delete Patches
TerminusDB 12.0.7 lets the patch endpoint insert and delete documents, so you can resolve merge conflicts in one commit. Also: folded diffs, Elixir client.
TerminusDB 12.0.8: UUID v7 Keys and 4.6× Faster Raw JSON Loading
TerminusDB 12.0.8 lets you use UUID v7 document keys, so you can keep IDs issued by other systems. Raw JSON loads about 4.6× faster than before.
TerminusDB 12.1.0-rc2: Indexed Counting
TerminusDB 12.1.0-rc2 counts triples, documents and GraphQL result sets straight from the store indexes: WOQL triple_count patterns and triple_range_count, counted=true document listings, and fast GraphQL _count.