Reference
Technical reference for lookup (Diataxis: information-oriented)
83 pages
Access Control Reference
Complete reference for TerminusDB's role-based access control system. Manage users, roles, capabilities, and database permissions via the HTTP API.
Access Control Reference Guide
A driver to manage access control with the JS Client
Access Control with the JavaScript Client Reference Guide
A reference guide to help understand TerminusDB access control using the JavaScript Client to manage teams, users and database access
Allen's Interval Algebra and ISO 8601 Intervals
Guide to Allen's Interval Algebra in WOQL — covering the xdd:dateTimeInterval type, typecasting between inclusive and half-open intervals, all 13 Allen relations, interval classification, and converting between reporting durations and temporal intervals.
Array fields in the document UI
Examples of how array fields are rendered and managed in the TerminusDB Document UI SDK.
Choice Document in the Document UI
How document choice works in the document UI
Collaboration Features with the JavaScript Client
How to guides to help you use TerminusDB collaboration features using the JavaScript Client
Collaboration Features with the Python Client
How to guides to help you get to grips with TerminusDB collaboration features using the Python Client.
Collaboration Features with the TerminusDB Dashboard
How-to guides for leveraging collaboration features — branching, merging, and change requests — using the TerminusDB dashboard.
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
Connecting to GraphQL Reference Guide
A reference guide detailing connecting to GraphQL with TerminusDB.
Context Cache
How TwinfoxDB Enterprise caches remote JSON-LD contexts locally using pre-seeded files and a disk-backed HTTP cache.
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
DocumentsGraphqlTable Component
The DocumentsGraphqlTable component allows you to use GraphQL queries and visualize the results in a the TDBReactTable
EditDocumentComponent
The EditDocumentComponent allows you to edit an existing document using the FrameViewer component
End-of-Month Preservation Rules
Complete reference for TerminusDB's end-of-month (EOM) preservation rules — the financial convention for month-based duration arithmetic that keeps month-end dates on month-end boundaries.
Enterprise Configuration Reference
Complete reference for all TwinfoxDB Enterprise environment variables covering context caching, remote context processing, LRU cache tuning, and feature activation.
Git-for-Data Reference
Complete reference for Git-for-Data operations in TerminusDB — push, pull, fetch, clone, rebase, and remote management with HTTP API, TypeScript, and Python examples.
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
GraphQL Mutations Reference
Learn how to insert, replace, and delete documents in TerminusDB using GraphQL mutations including _insertDocuments, _replaceDocuments, and _deleteDocuments.
GraphQL Naming Conventions Reference Guide
A reference guide detail the GraphQL naming conventions in TerminusDB and TerminusDB.
GraphQL Query Reference Guide
A GraphQL query reference guide explaining the workings of GraphQL queries with TerminusDB
How to Curate & Import Data
How to guides for curating and importing data into TerminusDB and TerminusDB
How to Manage Projects with TerminusDB
Bit sized how to guides to get to know the TerminusDB dashboard to manage your projects
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 Collaboration Features
How to guides for using TerminusDB collaboration features using the clients and dashboard.
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
ISO 8601 Time Processing in TerminusDB
Learn to process dates, times, durations, and intervals accurately in TerminusDB. Four progressive tutorials cover everything from basic date comparison to creative temporal pattern-solving for financial reporting and scheduling.
JSON-LD Context Processing
How TwinfoxDB Enterprise handles JSON-LD @context for document expansion, compaction, and round-trip context bridging using the Rust json-ld crate.
List Properties in the Document UI
How list properties work in the document UI software development kit.
ListDocumentsComponent
The ListDocumentsComponent element allows you to visualize the documents inside the TDBReactTable and query the documents using the advanced search component
Managing Users and Invitations in TerminusDB
Learn how to create organizations, invite users with specific roles, and manage authorization in TerminusDB using the REST API
Mandatory Properties in the Document UI
How mandatory properties work in the document user interface.
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
One Of for mutually disjoint properties (@oneof)
An example of how one of properties work in the document UI
Optional Properties
How optional properties work in the document UI
Order By Using @metadata
How to order properties in the document UI
Patch Endpoint — Apply Structural Patches to Documents
Apply JSON diff patches to documents in a TerminusDB branch. Patch a single document with a before/after comparison, or patch multiple documents in a resource by ID.
Prefix Management API
Learn how to manage namespace prefixes in TerminusDB to simplify your document IRIs and organize your data vocabularies.
Prometheus Observability
How to use the TwinfoxDB Enterprise Prometheus metrics endpoint for production monitoring, including available gauges for memory, cache, and request tracking.
Range Queries with triple_slice and quad_slice
How to use triple_slice and quad_slice for fast range queries on typed values in TerminusDB, with automatic type inference from the schema
RDF List Access Operations
Learn how to read elements from RDF lists using peek, member, length, list, and slice operations in WOQL.
RDF List Creation Operations
Learn how to create empty RDF lists and check if lists are empty using WOQL library functions in TerminusDB.
RDF List Modification Operations
Learn how to add, remove, and modify elements in RDF lists using push, pop, append, insert, drop, and clear operations in WOQL.
RDF List Transformation Operations
Learn how to reorder RDF lists using swap and reverse operations in WOQL for 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.
Render As Markdown Using @metadata
How to render properties as markdown in the document UI
Schema Migration Reference Guide
Complete reference for schema migration operations in TerminusDB — add fields, rename properties, change types, and re-key documents with worked examples.
Schema Reference Guide
Complete reference for the TerminusDB schema language — document classes, properties, key strategies, enums, and type inference rules.
Set Properties in the Document UI
How to use set properties in the document UI
sys:JSON Properties in the Document UI
How to use sys:JSON properties in the document UI
System Graph Interface to GraphQL
TerminusDB technical documentation - System Graph Interface to GraphQL
TerminusDB Dashboard Reference Guide
A conceptual overview of the TerminusDB dashboard describing its features and their purpose.
TerminusDB Data Types
Comprehensive reference for all data types supported in TerminusDB, including XSD, RDF, XDD extensions, and System types.
TerminusDB Data Types
The core data types for TerminusDB, derived from XML Data Types providing strong data interoperability
TerminusDB Document Types Compared
Compare TerminusDB document types - when to use regular documents, subdocuments, and shared documents for different ownership and lifecycle patterns
TerminusDB Document UI SDK - Using Choice Subdocuments
A guide showing how to use multiple choice subdocuments with the TerminusDB Document UI SDK.
TerminusDB Installation Options
Choose how you'd like to install TerminusDB
TerminusDB Path Query Reference Guide
A reference guide to path queries in TerminusDB.
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
useTDBDocuments hook
useTDBDocuments is the main hook to connect @terminusdb/terminusdb-documents-ui with the TerminusDB server
useTDBGraphqlQuery
useTDBGraphqlQuery` is the main hook to connect @terminusdb/terminusdb-react-table with TerminusDB server
Version Control Operations — Git for Data
TerminusDB is a git for data database. Complete reference for git-based version control operations — branch, merge, diff, time-travel, reset, and squash with HTTP API examples and expected responses.
ViewDocumentComponent
The ViewDocumentComponent allows you to view existing documents using the FrameViewer component
WOQL Class Reference Guide
Complete reference for all WOQL query language classes, generated from the authoritative schema definition.
WOQL Control Flow: Backtracking, Scope, and Performance
Deep guide to WOQL's execution model — how backtracking generates solutions, how variable scope works across sub-queries, and how to structure queries for optimal performance with triple, triple_slice, and streaming results.
WOQL ISO8601 Time and Date Handling
Complete guide to WOQL date, time, duration, and interval handling — ISO 8601 types, comparators, sequences, Allen's Interval Algebra, and financial EOM rules.
WOQL RDF List Operations
Comprehensive guide to working with rdf:List structures in TerminusDB using WOQL library functions for list manipulation.
WOQL Set Operations Reference
Reference guide for WOQL set operations including set_difference, set_intersection, set_union, set_member, and list_to_set
WOQL Variable Generation Guide (Javascript)
Complete guide to the four variable generation methods in the TerminusDB JavaScript client - vars, vars_unique, Vars, and VarsUnique - with practical examples and use cases