Schema
Schema definition, types, constraints, migration, and weakening
29 pages
Add a Schema
Define and add a schema to your TerminusDB database using the HTTP API, TypeScript client, or Python client.
Clustering Embeddings
How to enable store_clustering in your schema to generate clustering embeddings for projection, deduplication, and entity resolution
Query Arrays and Sets with WOQL
A guide to show how to query arrays and sets with WOQL in your TerminusDB projects.
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.
Subdocument Handling with WOQL
A comprehensive guide to creating, reading, updating, and deleting subdocuments using WOQL queries in TerminusDB.
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.
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
Context Cache
How TwinfoxDB Enterprise caches remote JSON-LD contexts locally using pre-seeded files and a disk-backed HTTP cache.
How to Model Schema
Bit sized how to guides to help you model and build schema for TerminusDB projects.
List Properties in the Document UI
How list properties work in the document UI software development kit.
Mandatory Properties in the Document UI
How mandatory properties work in the document user interface.
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
Prefix Management API
Learn how to manage namespace prefixes in TerminusDB to simplify your document IRIs and organize your data vocabularies.
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
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.
XSD Data Types
Comprehensive reference for all data types for XSD and for use with RDF.
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.
What is Schema Weakening
An explanation about schema weakening and why you need it to change a schema which provides constraints and assurances of the shapes of your graph data
Cookbook: Leveraging Arrays with WOQL
Learn to query and manipulate TerminusDB multidimensional arrays using WOQL patterns for efficient data access and processing
Schema Validation Errors — TerminusDB Troubleshooting
Diagnose and fix schema validation errors in TerminusDB including type mismatches on insert, missing required fields, class not found, and enum validation failures.
Troubleshooting Document ID Migration
How to fix subdocument ID prefix mismatches after schema changes using the ChangeKey migration operation.