Link

Introduction

TerminusDB consists of a large number of different code-repositories and packages, each of which is made available individually on the TerminusDB github page, as well as being bundled into releases. This document describes the different packages and what they do and why you might need them.

Core Server Packages

These packages are part of the core TerminusDB DB Server engine

terminusdb-server

The main server package - built in Prolog - contains much of the logic and orchestration of the system

terminusdb-store

The underlying data store - built in Rust - provides fast access to an immutable append only data-store

jwt_io

JWT authentication support for Prolog - used by terminusdb-server to enable JWT authentication

terminus_store_prolog

Prolog bindings which allow Terminus Server to talk to terminusdb-store

terminusdb-store-test

Automated load testing scripts for terminusdb-store

terminusdb-upgrade-to-store

Old package to support upgrading from terminusdb-server 1.0 to terminusdb-server 1.1 - requiring a change in underlying storage engine from HDT to terminusdb-store

Client Language Packages

Client libraries for accessing TerminusDB from programming languages

terminusdb-client

Javascript client library - comes as npm model or script

terminusdb-client-python

Python client library - includes panda dataframes integration.

User Interface

User Interface libraries for visualising TerminusDB contents and query results

terminusdb-console

The management dashboard that ships with TerminusDB

terminusdb-react-table

A react table element for displaying TerminusDB query results

terminusdb-react-graph

A react graph element based on d3, for displaying TerminusDB query results as graphs

terminusdb-react-chart

A react charting element, for displaying TerminusDB query results as charts

Documentation and News

Repositories which provide documentation and news about TerminusDB

terminusdb-doc

The documentation site for terminus DB - includes this page!

terminusdb-tutorials

A collection of tutorials and useful scripts to help users better understand TerminusDB

terminusdb-schema

Documentation on the internal datastructures used by TerminusDB

terminusdb-blog

The TerminusDB blog site

terminusdb-community

The TerminusDB community website

terminusdb-events

The TerminusDB events listing site

documentation-sprint

Special repository for supporting documentation sprints

terminusdb-knowledge

Some background articles on terminus DB

Deployment

Repositories to help deploy TerminusDB

terminusdb-quickstart

Quickstart script for loading TerminusDB as a docker container

terminusdb-heroku

One click deploy of TerminusDB to a heroku account.

katacoda-scenarios

TerminusDB deployed as a katacode tutorial (Deprecated as service has become tumbleweed)

swi-prolog-docker

Docker container pre-built for SWI-Prolog