Skip to content

Commit 368718a

Browse files
committed
Add documentation for API header info and more on document API
1 parent 2352646 commit 368718a

File tree

4 files changed

+330
-231
lines changed

4 files changed

+330
-231
lines changed
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: Document Graph API Howto
3+
nextjs:
4+
metadata:
5+
title: Document Graph API Howto
6+
description: A howto guide for the TerminusDB document API interface.
7+
alternates:
8+
canonical: https://terminusdb.org/docs/document-graph-api-howto/
9+
media: []
10+
---
11+
12+
The TerminusDB document interface blends knowledge graphs with document databases and realize the best parts of both, and offers a database-oriented approach to knowledge graph processing, where the complex and painful handling of relational tables and the inflexibiltiy of working with complete documents in a document databases are avoided.
13+
14+
Documents in TerminusDB follow a strict schema which makes document modelling both precise and easy. Technical professionals will immediately feel at home with a JSON syntax, extended with types and identifiers for precise handling of both top level document, and subdocument handling.
15+
16+
## Documents offers the best of graph, documents and relations
17+
18+
The document interface implements an opionionated subset of the JSON-LD standard, with automatic ID generation and schemaful handling of documents and subdocuments, to form a special-purpose database for closed world assumption knowledge graph processesing.
19+
20+
The document interface consists of two endpoints. The first endpoint, `document`, is how we get documents into and out of TerminusDB. Since schemas consist of documents too, this is also how you'd update the schema, they use the same semantics.
21+
22+
The second endpoint, `schema`, is how we can easily get schema information out of TerminusDB. While technically it is possible to get all schema information through the document interface, the schema interface is more convenient for this purpose, as it takes class inheritance into account to give a complete image of all the properties that are usable on a certain class.
23+
24+
## Using the document API
25+
26+
The easiest way to get started with the document API is to use the TerminusDB client libraries, which provide a high-level interface to the document API:
27+
28+
* [Javascript](/docs/use-the-javascript-client/)
29+
* [Python](/docs/use-the-python-client/)
30+
31+
## Further Reading
32+
33+
* [Document Insertion Reference Guide](/docs/document-insertion/)
34+
* [Documents in a knowledge graph and how to use them](/docs/documents-explanation/)
35+
* [Immutability, version history, and revision control](/docs/immutability-explanation/)

0 commit comments

Comments
 (0)