@terminusdb/terminusdb-client
Version:
TerminusDB client library
177 lines (119 loc) • 7.13 kB
Markdown
[][terminusdb-client-js-docs]
[]: https://terminusdb.github.io/terminusdb-client-js/
---
[](https://discord.gg/yTJKAma)
[](https://www.reddit.com/r/TerminusDB/)
[](https://twitter.com/TerminusDB)
[](https://www.npmjs.com/package/@terminusdb/terminusdb-client)
[](https://www.npmjs.com/package/@terminusdb/terminusdb-client)
[](https://coveralls.io/builds/76119876)
> This repository is for the JavaScript client library for TerminusDB and
> TerminusCMS.
[**TerminusDB**][terminusdb] is an [open-source][terminusdb-repo] graph database and document store. It allows you to link JSON documents in a powerful knowledge graph all through a simple document API.
[]: https://terminusdb.org/
[]: https://terminusdb.org/docs/
[]: https://github.com/terminusdb/terminusdb
It is the model-based, in-memory, and distributed knowledge graph database for hierarchical records with a git-for-data collaboration model at its heart. So many great things in a single package and a high precision datalog query language with advanced features like transactions, schema validation and unification.
For many, it serves as a headless content management system for complex enviroments with push, pull, clone, rebase and merge capabilities with immutable history and a strong schema checker that covers both the simplest and most advanced models.
Use the [cloud-based studio environment](https://studio.dfrnt.com/) to [build graph data products in the cloud](https://dfrnt.com/solutions-studio) or in your [localhost dockerized TerminusDB instances](https://terminusdb.org/docs/install-terminusdb-as-a-docker-container/). Try it out for yourself, it's free to get started with generous limits, clone a demo project to play around.
- Node.js version 20+ if using the TerminusDB client library as a Node.js package (might work with earlier versions too).
## Installation
The TerminusDB JavaScript client library can be used either as a Node.js package or as a script that runs in the browser.
### NPM Package
> :memo: If you don't already have Node.js installed, [install it][node-install] first.
[node-install]: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
To install the `@terminusdb/terminusdb-client` package as a dependency in an existing package, run:
```sh
$ npm install --save @terminusdb/terminusdb-client
```
This command updates your `package.json`.
### Script
To use the `terminusdb-client` script on a webpage sourced from a CDN, add this to your HTML:
```html
<script src="https://unpkg.com/@terminusdb/terminusdb-client/dist/terminusdb-client.min.js"></script>
```
Alternatively, you can download the latest [`terminusdb-client.min.js`][js], add it to your sources, and use that in the `<script>` instead.
[]: https://unpkg.com/@terminusdb/terminusdb-client/dist/terminusdb-client.min.js
This example creates a simple dataProduct, starting to create a database model the schema
and insert a simple document
For the [full Documentation](https://terminusdb.org/docs/javascript)
```javascript
const TerminusClient = require("@terminusdb/terminusdb-client");
// Connect and configure the TerminusClient
const client = new TerminusClient.WOQLClient('SERVER_CLOUD_URL/mycloudTeam',
{user:"myemail@something.com", organization:'mycloudTeam'})
client.setApiKey(MY_ACCESS_TOKEN)
const bankerSchema = [
{
"@type":"Class",
"@id":"BankAccount",
"@key":{
"@type":"Hash",
"@fields":[
"account_id"
]
},
"account_id":"xsd:string",
"owner":"Person",
"balance":"xsd:decimal"
},
{
"@type":"Class",
"@id":"Person",
"@key":{
"@type":"Lexical",
"@fields":[
"name"
]
},
"name":"xsd:string"
}
]
async function createDataProduct(){
try{
await client.createDatabase("banker", {label: "Banker Account",
comment: "Testing", schema: true})
//add the schema documents
await client.addDocument(bankerSchema,{"graph_type":"schema"},null,"add new schema")
const accountObj = {"@type":"BankAccount",
"account_id":"DBZDFGET23456",
"owner":{
"@type":"Person",
"name":"Tom"
},
"balance":1000
}
//add a document instance
await client.addDocument(accountObj)
client.getDocument({"as_list":true,id:'Person/Tom'})
}catch(err){
console.error(err.message)
}
}
```
Connections options.
To initialize `TerminusDB client` with custom options use
```js
const TerminusClient = require("@terminusdb/terminusdb-client");
const client = new TerminusClient.WOQLClient("http://127.0.0.1:6363/", {
db: "test_db",
user: "admin",
key: "my_secret_key",
});
```
The TerminusDB API can be found at the [TerminusDB Documentation][terminusdb-docs].
TerminusDB communicates using JSON over HTTP. It works with advanced datatypes including integers, floats, decimals, big integers, arbitrary precision decimals, dates and other important XML Datatypes. Math is capped at 20 digits of precision, where the core is ready to support higher precision if needed.
If you encounter any issues, please report it with your os and environment setup, the version that you are using, and a simple reproducible case.
If you encounter other questions, you can ask them on our [Discord Server](https://discord.gg/hTU3XWSzuZ).
> :memo: This project uses [Husky](https://www.npmjs.com/package/husky) which automatically runs lint, tests, and other scripts when you try to commit any changes to the repository. This helps us to improve each commit done to the repo and is automatically installed and configured when you do `npm install`
It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.
Please check [Contributing.md](Contributing.md) for more information.
## Licence
The APACHE 2.0 License
Copyright (c) 2019