TypeScript/JavaScript
TypeScript or JavaScript client SDK
67 pages
Access Control Tutorial Source Code
Complete source code walkthrough for the TerminusDB JavaScript access control tutorial.
Your First 15 Minutes — Build from Scratch
Build a complete git-for-data workflow from scratch. Create a database, insert a document, branch, edit, diff branches, and merge — step by step with curl.
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.
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.
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.
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.
Get Documents
How to retrieve documents from TerminusDB using the JavaScript client, Python client, or HTTP API.
How to use the TerminusDB Document UI SDK
How to use the TerminusDB Document UI SDK
How to Version JSON Data in an Application Database
Version JSON documents with Git-style commits, branches, diffs and full history. Step-by-step guide with runnable curl and TypeScript examples against TerminusDB.
Install a TerminusDB Client Library
Install the TerminusDB client for TypeScript, Python, or Rust. One command to start building.
JSON Diff and Patch with TerminusDB
Compute structural diffs between JSON documents and apply them as patches with the TerminusDB JSON Diff and Patch API. Works standalone against any two JSON objects, or against TerminusDB's immutable history to compare two commits or layers. Includes a no-auth quickstart, HTTP endpoint reference, curl examples, JavaScript and Python client examples, and the full set of patch operation types.
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.
Query Documents using the JavaScript Client
A guide to show how to perform basic document queries using the JavaScript Client.
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.
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.
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.
Squash Commits on a Branch
How to squash multiple commits into one using the JavaScript client, Python client, or HTTP API.
TypeScript Client — Quickstart
Connect to TerminusDB from TypeScript. Branch, edit, diff, and merge documents using the terminusdb npm client.
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
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
Document API Reference Guide
A reference guide for the TerminusDB document API interface.
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
How to Use the JavaScript Client
Bite sized how to guides to get you up and running with the JavaScript Client
JSON-LD Context Processing
How TerminusDB Enterprise Edition 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
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.
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
Reference for the TerminusDB schema language: document classes, subdocuments, key strategies (Lexical, Hash, Random, UuidV7), enums and type rules, with JSON.
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
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 React Table
Learn how to include TerminusDB React Table components in your projects to display documents in an interactive table
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
ViewDocumentComponent
The ViewDocumentComponent allows you to view existing documents using the FrameViewer component
A Graph Database with Git-like Version Control for Production Data
Database version control for production data — Git-style commits, branches, diffs, merges and clone/push/pull, built into the TerminusDB graph database engine.
An Open-Source Graph Database with ACID Transactions
TerminusDB is an Apache 2.0 open-source graph database where every write is an ACID commit: atomic, schema-checked, isolated and durable. With runnable proof.
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.
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.
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.