Graph Documents
Document CRUD operations (add, get, edit, delete, query)
58 pages
Getting Started
Technical documentation for TerminusDB and the DFRNT TerminusDB cloud.
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 using the JavaScript Client
A guide to show how to add documents to TerminusDB using the JavaScript Client.
Backup & Restore
How to use the TwinfoxDB Enterprise bundle and unbundle API endpoints for database backup, restore, migration, and disaster recovery.
Connect to a Database using the Python Client
A guide to show how to connect to a TerminusDB project using the Python client.
Create a Database using the JavaScript Client
A guide to show how to create a database using the TerminusDB JavaScript Client.
Create a database with the Python Client
A guide showing how to create a TerminusDB database using the Python Client.
Delete a Document using the JavaScript Client
A guide to show how to delete a document in TerminusDB using the JavaScript Client.
Edit a Document with the JavaScript Client
A guide to show how to update a document in TerminusDB using the JavaScript Client.
Edit a Document with the Python Client
A guide to show how to update a document in TerminusDB using the Python Client
Edit Documents using WOQL
A guide with example showing how to edit documents using WOQL
Get Documents using the JavaScript Client
A guide to show how to get documents to TerminusDB and TerminusDB using the JavaScript Client
Get Documents with the Python Client
A guide to show how-to get documents from TerminusDB using the Python Client
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 Add Documents with the Python Client
A guide to show how to add documents to your TerminusDB projects using the Python Client.
How to delete a document using the Python client
A guide to show how to delete a document from TerminusDB using the Python Client
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 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.
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 has components to assemble a dashboard quickly.
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.
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 TwinfoxDB Enterprise 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 TwinfoxDB Enterprise 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.
How to Curate & Import Data
How to guides for curating and importing data into TerminusDB and TerminusDB
Immutability and Concurrency
Why TerminusDB avoids locks and how its immutable delta architecture enables safe concurrent access.
Immutability Explanation
An explanation of how TerminusDB implements immutability, and handles deleted and new data.
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 JSON documents in a schema-enforced graph. 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.
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.