JavaScript

Get a organization from parameters.

Parameters

Sets the Jwt token for the object

Parameters

Sets the API token for the object, to request a token create an account in https://terminusdb.com/

Parameters

Sets the API token for the object, to request a token create an account in https://terminusdb.com/

Parameters

Get a API url from cloudAPIUrl

Parameters

add extra headers to your request

Parameters

-- TerminusDB API --- Get an organization from the TerminusDB API.

Parameters

-- TerminusDB API --- This end point works in basic authentication, admin user Get list of organizations

-- TerminusDB API --- This end point works in basic authentication, admin user Create an organization

Parameters

Examples

accessControl.createOrganization("my_org_name").then(result=>{
     console.log(result)
})

-- TerminusDB API --- Delete an Organization

Parameters

Examples

accessControl.deleteOrganization("my_org_name").then(result=>{
     console.log(result)
})

--TerminusDB API --- basic authentication, admin user. Create a new role in the system database.

Parameters

Examples

accessControl.createRole("Reader",[ACTIONS.INSTANCE_READ_ACCESS]).then(result=>{
 console.log(result)
})

-- TerminusdDB API --- basic Authentication, admin user. Delete role in the system database, (this api is enabled only in the local installation)

Parameters

Examples

accessControl.deleteRole("Reader").then(result=>{
 console.log(result)
})

-- TerminusdDB API --- basic Authentication, admin user. Return the list of all the users (this api is enabled only in the local installation)

Examples

accessControl.getAllUsers().then(result=>{
 console.log(result)
})

-- TerminusdDB API --- basic Authentication, admin user. Add the user into the system database

Parameters

Examples

accessControl.deleteUser(userId).then(result=>{
 console.log(result)
})

-- TerminusdDB API --- basic Authentication, admin user. Remove the user from the system database.

Parameters

Examples

accessControl.deleteUser(userId).then(result=>{
 console.log(result)
})

-- TerminusdDB API --- Grant/Revoke Capability

Parameters

Examples

//we add an user to an organization and manage users' access
//the user myUser can  access the Organization and all the database under the organization with "reader" Role
client.manageCapability(myUser,myteam,[reader],"grant","organization").then(result=>{
 consol.log(result)
})

//the user myUser can  access the database db__001 under the organization myteam
//with "writer" Role
client.manageCapability(myUser,myteam/db__001,[writer],"grant","database").then(result=>{
 consol.log(result)
})

--TerminusX and TerminusDB API --- Get all the system database roles types.

-- TerminusX and TerminusDB API -- Get all the organization's users and roles,

Parameters

Examples

accessControl.getOrgUsers().then(result=>{
 console.log(result)
})

//this function will return an array of capabilities with users and roles
//-- TerminusX --  response array example
//[{capability: "Capability/3ea26e1d698821c570afe9cb4fe81a3......"
//     email: {@type: "xsd:string", @value: "user@terminusdb.com"}
//     picture: {@type: "xsd:string",…}
//     role: "Role/dataReader"
//     scope: "Organization/my_org_name"
//     user: "User/auth0%7C613f5dnndjdjkTTT"}]
//
//
// -- Local Installation -- response array example
//[{ "@id":"User/auth0%7C615462f8ab33f4006a6bee0c",
//  "capability": [{
//   "@id":"Capability/c52af34b71f6f8916ac0115ecb5fe0e31248ead8b1e3d100852015...",
//   "@type":"Capability",
//  "role": [{
//    "@id":"Role/admin",
//    "@type":"Role",
//    "action": ["instance_read_access"],
//     "name":"Admin Role"
//     }],
//  "scope":"Organization/@team"}]]

-- TerminusX and TerminusDB API -- Get the user roles for a given organization or the default organization,

Parameters

Examples

accessControl.getTeamUserRole("myUser").then(result=>{
 console.log(result)
})

//response object example
{
 "@id": "User/myUser",
  "capability": [
        {
          "@id":"Capability/server_access",
          "@type":"Capability",
          "role": [{
             "@id":"Role/reader",
              "@type":"Role",
             "action": [
                "instance_read_access",
             ],
              "name":"reader"
            }],
          "scope":"Organization/myteam"
        }
      ],
  "name": "myUser"
}

-- TerminusX API --- Check if the organization exists. it is a Head call . IMPORTANT This does not work with the API-TOKEN.

Parameters

-- TerminusX API --- IMPORTANT This does not work with the API-TOKEN. Create an organization

Parameters

Examples

accessControl.createOrganization("my_org_name").then(result=>{
     console.log(result)
})

-- TerminusX API --- Get the pending invitations list.

Parameters

Examples

const invitationList = accessControl.getPendingOrgInvites().then(result=>{
   console.log(invitationList)

})
//this will return an array of invitations object like this
//[{@id: "Organization/my_team_name/invitations/Invitation/7ad0c9eb82b6175bcda9c0dfc2ac51161ef5ba
cb0988d992c4bce82b3fa5d25"
//      @type: "Invitation"
//      creation_date: "2021-10-22T11:13:28.762Z"
//      email_to: "new_user@terminusdb.com"
//      invited_by: "User/auth0%7C6162f8ab33567406a6bee0c"
//      role: "Role/dataReader"
//      status: "needs_invite"}]

-- TerminusX API --- Send a new invitation

Parameters

Examples

accessControl.sendOrgInvite("new_user@terminusdb.com","Role/admin",
"please join myteam").then(result=>{
   console.log(result)
})

-- TerminusX API --- Get the invitation info

Parameters

Examples

const fullInviteId="Organization/my_team_name/invitations/Invitation/7ad0c9eb82b6175bcda9c0dfc
2ac51161ef5ba7cb0988d992c4bce82b3fa5d25"
accessControl.getOrgInvite(fullInviteId).then(result=>{
 console.log(result)
})

-- TerminusX API --- Delete an invitation

Parameters

Examples

const fullInviteId="Organization/my_team_name/invitations/Invitation/7ad0c9eb82b6175bcda9
c0dfc2ac51161ef5ba7cb0988d992c4bce82b3fa5d25"
accessControl.deleteOrgInvite(fullInviteId).then(result=>{
     console.log(result)
})

-- TerminusX API --- Accept /Reject invitation. if the invitation has been accepted we add the current user to the organization. the only user that can accept this invitation is the user registered with the invitation email, we indentify the user with the jwt token

Parameters

Examples

const fullInviteId="Organization/my_team_name/invitations/Invitation/7ad0c9eb82b6175bcda9
c0dfc2ac51161ef5ba7cb0988d992c4bce82b3fa5d25"
accessControl.updateOrgInviteStatus(fullInviteId,true).then(result=>{
  console.log(result)
})

-- TerminusX API --- Get the user role for a given organization or the default organization The user is identified by the jwt or the access token

Parameters

Examples

accessControl.getTeamUserRole().then(result=>{
 console.log(result)
})

//response object example
{"userRole":"Role/admin"}

-- TerminusX API -- Remove an user from an organization, only an admin user can remove an user from an organization

Parameters

Examples

accessControl.removeUserFromOrg("User/auth0%7C613f5dnndjdjkTTT","my_org_name").then(result=>{
 console.log(result)
})

-- TerminusX API -- Get the user's role for every databases under the organization

Parameters

Examples

accessControl.getDatabaseRolesOfUser('User/auth0%7C61790e366377Yu6596a').then(result=>{
     console.log(result)
})

//this is a capabilities list of databases and roles
//[ {capability: "Capability/b395e8523d509dec6b33aefc9baed3b2e2bfadbd4c79d4ff9b20dce2b14e2edc"
//if there is an id we have a user specific capabality for this database
   // name: {@type: "xsd:string", @value: "profiles_test"}
   // role: "Role/dataUpdater"
   // scope: "UserDatabase/7ebdfae5a02bc7e8f6d79sjjjsa4e179b1df9d4576a3b1d2e5ff3b4859"
   // user: "User/auth0%7C61790e11a3966d006906596a"},

//{ capability: null
// if the capability id is null the user level of access for this database is the
same of the team
  //name: {@type: "xsd:string", @value: "Collab002"}
  //role: "Role/dataReader"
  // scope: "UserDatabase/acfcc2db02b83792sssb15239ccdf586fc5b176846ffe4878b1aea6a36c8f"
  //user: "User/auth0%7C61790e11a3966d006906596a"}]

-- TerminusX API -- Create a user's a role for a resource (organization/database)

Parameters

Examples

const dbId = "UserDatabase/acfcc2db02b83792sssb15239ccdf586fc5b176846ffe4878b1aea6a36c8f"
accessControl.assignUserRole('User/auth0%7C61790e11a3966d006906596a',dbId,
"Role/collaborator").then(result=>{
     console.log(result)

})

-- TerminusX API -- Update user's a role for a resource (organization/database), (this api works only in terminusX)

Parameters

Examples

const dbId = "UserDatabase/acfcc2db02b83792sssb15239ccdf586fc5b176846ffe4878b1aea6a36c8f"
const capId= "Capability/b395e8523d509dec6b33aefc9baed3b2e2bfadbd4c79d4ff9b20dce2b14e2edc"
accessControl.updateUserRole('User/auth0%7C61790e11a3966d006906596a',capId,dbId,
"Role/dataUpdater").then(result=>{
     console.log(result)

})

-- TerminusX API -- Get all the access request list for a specify organization

Parameters

Examples

accessControl.accessRequestsList().then(result=>{
 console.log(result)
})

-- TerminusX API -- Get all the access request list for a specify organization

Parameters

Examples

accessControl.sendAccessRequest("myemail@terminusdb.com",
 "my_company",
 "please add me to your team"
).then(result=>{
 console.log(result)
})

-- TerminusX API -- Delete an access request to join your team, only an admin user can delete it

Parameters

Examples

accessControl.deleteAccessRequest("djjdshhsuuwewueueuiHYHYYW.......").then(result=>{
 console.log(result)
})

-- TerminusX API -- Get the userinfo teams ownership and subscription

Parameters

Examples

accessControl.getUserInfo().then(result=>{
   console.log(result)
})

Simple composite functions which produce WOQL queries

Parameters

Parameters

Parameters

Parameters

Parameters

Update a pattern matching rule for the triple (Subject, Predicate, oldObjValue) with the new one (Subject, Predicate, newObjValue)

Parameters

Update a pattern matching rule for the quad [S, P, O, G] (Subject, Predicate, Object, Graph)

Parameters

Deletes all triples in the passed graph (defaults to instance/main)

Parameters

Parameters

Sets the graph resource ID that will be used for subsequent chained function calls

Parameters

Parameters

Basic Error handling

Internal library function which adds a subquery and sets the cursor

Does this query contain an update

Called to inidicate that this query will cause an update to the DB

Wraps the passed value in a json-ld literal carriage

Transforms a javascript representation of a query into a json object if needs be

Wraps the elements of an AS variable in the appropriate json-ld

JSON LD Format Descriptor

Parameters

Wraps arithmetic operators in the appropriate json-ld

takes input that can be either a string (variable name) or an array - each element of the array is a member of the list

takes a list of input that can be any value

creates an unadorned variable name list

Wraps data values

Transforms whatever is passed in as the subject into the appropriate json-ld for variable or id

Transforms whatever is passed in as the predicate (id or variable) into the appropriate json-ld form

Transforms whatever is passed in as the object of a triple into the appropriate json-ld form (variable, literal or id)

Transforms a graph filter or graph id into the proper json-ld form

Transforms strings that start with v: into variable json-ld structures

Parameters

Retrieves the value of the current json-ld context

sets the value of the current json-ld context on a full query scope

vocabulary elements that can be used without prefixes in woql.js queries

Provides the query with a 'vocabulary' a list of well known predicates that can be used without prefixes mapping: id: prefix:id ...

Use instead woqlclient.query('myWOQLQuery')

converts back and forward from json if the argument is present, the current query is set to it, if the argument is not present, the current json version of this query is returned

Parameters

Returns a script version of the query

Parameters

Finds the last woql element that has a subject in it and returns the json for that used for triplebuilder to chain further calls - when they may be inside ands or ors or subqueries

Parameters

Finds the last woql element that has a subject in that is a property id used for triplebuilder to chain further calls - when they may be inside ands or ors or subqueries

Parameters

Turns a textual path pattern into a JSON-LD description

Update a pattern matching rule for the triple (Subject, Predicate, oldObjValue) with the new one (Subject, Predicate, newObjValue)

Parameters

Generates a query that by default matches all triples in a graph identified by "graph" or in all the current terminusDB's graph

Parameters

Update a pattern matching rule for the quad [S, P, O, G] (Subject, Predicate, Object, Graph)

Parameters

Parameters

Sets the graph resource ID that will be used for subsequent chained function calls

Parameters

Specifies the identity of a node that can then be used in subsequent builder functions. Note that node() requires subsequent chained functions to complete the triples / quads that it produces - by itself it only generates the subject.

Parameters

Deletes all triples in the passed graph (defaults to instance/main)

Parameters

Examples

nuke("schema/main")
//will delete everything from the schema/main graph

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Read a node identified by an IRI as a JSON-LD document

Parameters

Insert a document in the graph.

Parameters

Update a document identified by an IRI

Parameters

Delete a document from the graph.

Parameters

Contains definitions of the WOQL functions which map directly to JSON-LD types All other calls and queries can be composed from these

Query running against any specific commit Id

Parameters

Adds a text comment to a query - can also be used to wrap any part of a query to turn it off

Parameters

Filters the query so that only the variables included in [V1...Vn] are returned in the bindings

Parameters

Filter the query to return only results that are distinct in the given variables

Parameters

Logical conjunction of the contained queries - all queries must match or the entire clause fails

Parameters

Creates a logical OR of the arguments

Parameters

Specifies the database URL that will be the default database for the enclosed query

Parameters

Specifies the graph resource to write the contained query into

Parameters

Creates a triple pattern matching rule for the triple [S, P, O] (Subject, Predicate, Object)

Parameters

Creates a triple pattern matching rule for the triple [S, P, O] (Subject, Predicate, Object) added in the current layer

Parameters

Creates a triple pattern matching rule for the triple [S, P, O] (Subject, Predicate, Object) added in the current commit

Parameters

Creates a pattern matching rule for triple [Subject, Predicate, Object]

Parameters

Creates a pattern matching rule for triple [Subject, Predicate, Object] add extra information about the type of the value object

Parameters

Creates a pattern matching rule for the quad [S, P, O, G] (Subject, Predicate, Object, Graph)

Parameters

Creates a pattern matching rule for the quad [S, P, O, G] (Subject, Predicate, Object, Graph) removed from the current commit

Parameters

Creates a pattern matching rule for the quad [S, P, O, G] (Subject, Predicate, Object, Graph) removed from the current commit

Parameters

Returns true if ClassA subsumes ClassB, according to the current DB schema

Parameters

Matches if a is equal to b

Parameters

Substring

Parameters

Use the document inteface to import documents

Parameters

Use the document inteface to import documents

Parameters

Parameters

Identifies a remote resource by URL and specifies the format of the resource through the options

Parameters

Identifies a resource as a local path on the client, to be sent to the server through a HTTP POST request, with the format defined through the options

Parameters

Deletes a single triple from the default graph of the database

Parameters

Adds triples according to the the pattern [subject,predicate,object]

Parameters

Deletes a single triple from the graph [Subject, Predicate, Object, Graph]

Parameters

Adds quads according to the pattern [S,P,O,G]

Parameters

Remove whitespace from both sides of a string:

Parameters

Evaluates the passed arithmetic expression and generates or matches the result value

Parameters

Adds the numbers together

Parameters

Subtracts Numbers N1..Nn

Parameters

Multiplies numbers N1...Nn together

Parameters

Divides numbers N1...Nn by each other left, to right precedence

Parameters

Division - integer division - args are divided left to right

Parameters

Exponent - raises varNum01 to the power of varNum02

Parameters

Generates the nearest lower integer to the passed number

Parameters

Tests whether a given instance IRI has type Class, according to the current state of the DB

Parameters

Generates a string Leverstein distance measure between stringA and stringB

Parameters

Compares the value of v1 against v2 and returns true if v1 is less than v2

Parameters

Compares the value of v1 against v2 and returns true if v1 is greater than v2

Parameters

Specifies that the Subquery is optional - if it does not match the query will not fail

Parameters

Generate a new IRI from the prefix and a hash of the variables which will be unique for any given combination of variables

Parameters

Generates the node's ID combined the variable list with a specific prefix (URL base). If the input variables's values are the same, the output value will be the same.

Parameters

Changes a string to upper-case

Parameters

Changes a string to lower-case

Parameters

Pads out the string input to be exactly len long by appending the pad character pad to form output

Parameters

Splits a string (Input) into a list strings (Output) by removing separator

Parameters

Matches if List includes Element

Parameters

takes a variable number of string arguments and concatenates them into a single string

Parameters

Joins a list variable together (Input) into a string variable (Output) by glueing the strings together with Glue

Parameters

computes the sum of the List of values passed. In contrast to other arithmetic functions, sum self-evaluates - it does not have to be passed to evaluate()

Parameters

Specifies an offset position in the results to start listing results from

Parameters

Specifies a maximum number of results that will be returned from the subquery

Parameters

Matches the regular expression defined in Patern against the Test string, to produce the matched patterns in Matches

Parameters

Calculates the length of the list in va and stores it in vb

Parameters

Logical negation of the contained subquery - if the subquery matches, the query will fail to match

Parameters

Results in one solution of the subqueries

Parameters

Runs the query without backtracking on side-effects

Parameters

Creates a count of the results of the query

Parameters

Casts the value of Input to a new value of type Type and stores the result in CastVar

Parameters

Orders the results of the contained subquery by a precedence list of variables

Parameters

Groups the results of the contained subquery on the basis of identical values for Groupvars, extracts the patterns defined in PatternVars and stores the results in GroupedVar

Parameters

A function that always matches, always returns true

Performs a path regular expression match on the graph

Parameters

Extract the value of a key in a bound document.

Parameters

Calculates the size in bytes of the contents of the resource identified in ResourceID

Parameters

Calculates the number of triples of the contents of the resource identified in ResourceID

Parameters

Returns true if 'elementId' is of type 'elementType', according to the current DB schema

Parameters

Functions to manipulate and check the paging related properties of a query

Returns the value of one of the 'paging' related properties (limit, start,...)

Sets the value of one of the paging_transitive_properties properties

General Pattern 4: Retrieves Branches, Their ID, Head Commit ID, Head Commit Time (if present, new branches have no commits)

get all the commits of a specific branch if a timestamp is given, gets all the commits before the specified timestamp

Parameters

get commits older than the specified commit id

Parameters

Finds the id of the very first commit in a database's history This is useful for finding information about when, by who and why the database was created The first commit is the only commit in the database that does not have a parent commit

Shorthand functions for accessing the pattern matching capabilities

Called to match an entire row of results is matched by a set of rules returns array of rules that matched

Called to test whether an entire column of results is matched by a set of rules returns array of rules that matched

Called to test whether a specific cell is matched by a set of rules returns array of rules that matched

Called to test whether a specific node is matched by a set of rules returns array of rules that matched

Called to test whether a specific edge (source -> target) is matched by a set of rules returns array of rules that matched

Called to test whether a specific frame is matched by a set of rules

Query running against any specific commit Id

Parameters

Examples

let [a, b, c] = vars("a", "b", "c")
WOQL.using("userName/dbName/local/commit|branch/commitID").triple(a, b, c)

Adds a text comment to a query - can also be used to wrap any part of a query to turn it off

Parameters

Parameters

Examples

let [a, b, c] = vars("a", "b", "c")
WOQL.select(a, triple(a, b, c))
Filters the query so that only the variables included in [V1...Vn] are returned in the bindings

Filter the query to return only results that are distinct in the given variables

Parameters

Logical conjunction of the contained queries - all queries must match or the entire clause fails

Parameters

Examples

//find triples that are of type scm:Journey, and have
//a start_station Start, and that start_station is labeled Start_Label
let [Journey, Start, Start_Label] = vars("Journey", "Start", "Start_Label")
WOQL.and(
     WOQL.triple(Journey, "rdf:type", "@schema:Journey"),
     WOQL.triple(Journey, "start_station", Start),
     WOQL.triple(Start, "label", Start_Label))

Use {@link #read_document|read_document} instead.

Read a node identified by an IRI as a JSON-LD document

Parameters

Examples

let [person] = vars("Person")
const query = WOQL.read_document(
     "Person/0b4feda109d9d13c9da809090b342ad9e4d8185545ce05f7cd20b97fe458f547",
    person
);
const res =  await client.query(query);

Insert a document in the graph.

Parameters

Examples

const res = await client.query(
   WOQL.insert_document(WOQL.doc({ "@type" : "Person", "label": "John" }))
)

Update a document identified by an IRI

Parameters

Delete a document from the graph.

Parameters

Creates a logical OR of the arguments

Parameters

Examples

let [Subject] = vars("Subject")
or(
  triple(Subject, 'label', "A"),
  triple(Subject, "label", "a")
 )

Specifies the database URL that will be the default database for the enclosed query

Parameters

Specifies the graph resource to write the contained query into

Parameters

Examples

//Subq is an argument or a chained query
using("admin/minecraft").into("instance/main").add_triple("a", "rdf:type", "@schema:X")
//writes a single tripe (doc:a, rdf:type, scm:X) into the main instance graph

Creates a triple pattern matching rule for the triple [S, P, O] (Subject, Predicate, Object)

Parameters

Creates a triple pattern matching rule for the triple [S, P, O] (Subject, Predicate, Object) added in the current layer

Parameters

Creates a triple pattern matching rule for the triple [S, P, O] (Subject, Predicate, Object) added in the current commit

Parameters

Creates a pattern matching rule for the quad [S, P, O, G] (Subject, Predicate, Object, Graph)

Parameters

Creates a pattern matching rule for the quad [S, P, O, G] (Subject, Predicate, Object, Graph) removed from the current commit

Parameters

Creates a pattern matching rule for the quad [S, P, O, G] (Subject, Predicate, Object, Graph) removed from the current commit

Parameters

Returns true if ClassA subsumes ClassB, according to the current DB schema

Parameters

Matches if a is equal to b

Parameters

Substring

Parameters

Use the document inteface to import documents

Parameters

Examples

let [a, b] = vars("a", "b")
get(as("a", a).as("b", b)).remote("http://my.url.com/x.csv")
//copies the values from column headed "a" into a variable a and from column
//"b" into a variable b from remote CSV

Use the document inteface to import documents

Parameters

Imports the value identified by Source to a Target variable

Parameters

Examples

let [First_Var, Second_Var] = vars('First_Var', 'Second_Var')
WOQL.as("first var", First_Var, "string").as("second var", Second_Var)
WOQL.as(["first var", First_Var, "string"], ["second var", Second_Var])

Identifies a remote resource by URL and specifies the format of the resource through the options

Parameters

Examples

remote({url:"http://url.of.resource"}, {type: "csv"})

Identifies a resource as a local path on the client, to be sent to the server through a HTTP POST request, with the format defined through the options

Parameters

Examples

post("/.../.../", {type:'csv'})

Deletes a single triple from the default graph of the database

Parameters

Examples

delete_triple("john", "age", 42)

Deletes a single triple from the graph [Subject, Predicate, Object, Graph]

Parameters

Examples

remove the class Person from the schema graph
WOQL.delete_quad("Person", "rdf:type", "sys:Class", "schema")

Adds triples according to the the pattern [subject,predicate,object]

Parameters

Adds quads according to the pattern [S,P,O,G]

Parameters

Remove whitespace from both sides of a string:

Parameters

Examples

let [trimmed] = vars("trimmed")
trim("hello   ", trimmed)
//trimmed contains "hello"

Evaluates the passed arithmetic expression and generates or matches the result value

Parameters

Examples

let [result] = vars("result")
evaluate(plus(2, minus(3, 1)), result)

Evaluates the passed arithmetic expression and generates or matches the result value

Parameters

Examples

let [result] = vars("result")
eval(plus(2, minus(3, 1)), result)

Adds the numbers together

Parameters

Examples

let [result] = vars("result")
evaluate(plus(2, plus(3, 1)), result)

Subtracts Numbers N1..Nn

Parameters

Examples

let [result] = vars("result")
evaluate(minus(2.1, plus(0.2, 1)), result)

Multiplies numbers N1...Nn together

Parameters

Examples

let [result] = vars("result")
evaluate(times(10, minus(2.1, plus(0.2, 1))), result)
 //result contains 9.000000000000002y

Divides numbers N1...Nn by each other left, to right precedence

Parameters

Division - integer division - args are divided left to right

Parameters

Examples

let [result] = vars("result")
evaluate(div(10, 3), result)
//result contains 3

Exponent - raises varNum01 to the power of varNum02

Parameters

Examples

let [result] = vars("result")
evaluate(exp(3, 2), result)
//result contains 9

Generates the nearest lower integer to the passed number

Parameters

Examples

let [result] = vars("result")
evaluate(divide(floor(times(10, minus(2.1, plus(0.2, 1)))), 10), result)
//result contains 0.9 - floating point error removed

Tests whether a given instance IRI has type Class, according to the current state of the DB

Parameters

Examples

let [subject] = vars("subject")
isa(subject, "Person")

Generates a string Leverstein distance measure between stringA and stringB

Parameters

Examples

let [dist] = vars('dist')
like("hello", "hallo", dist)
//dist contains 0.7265420560747664

Compares the value of v1 against v2 and returns true if v1 is less than v2

Parameters

Examples

let [result] = vars("result")
less(1, 1.1).eq(result, literal(true, "boolean"))
//result contains true

Compares the value of v1 against v2 and returns true if v1 is greater than v2

Parameters

Examples

let [result] = vars("result")
greater(1.2, 1.1).eq(result, literal(true, "boolean"))
//result contains true

Specifies that the Subquery is optional - if it does not match the query will not fail

Parameters

Examples

let [subject] = vars("subject")
opt(triple(subject, 'label', "A"))
//Subq is an argument or a chained query
opt().triple(subject, 'label', "A")

Generate a new IRI from the prefix and a hash of the variables which will be unique for any given combination of variables

Parameters

Examples

let [newid] = vars("newid")
unique("doc:Person", ["John", "Smith"], newid)

Generate a new IRI from the prefix and concatention of the variables

Parameters

Examples

let [newid] = vars("newid")
idgen("doc:Person", ["John", "Smith"], newid)

Changes a string to upper-case

Parameters

Examples

let [allcaps] = vars("allcaps")
upper("aBCe", allcaps)
//upper contains "ABCE"

Changes a string to lower-case

Parameters

Examples

let [lower] = var("l")
lower("aBCe", lower)
//lower contains "abce"

Pads out the string input to be exactly len long by appending the pad character pad to form output

Parameters

Examples

let [fixed] = vars("fixed length")
pad("joe", " ", 8, fixed)
//fixed contains "joe     "

Splits a string (Input) into a list strings (Output) by removing separator

Parameters

Examples

let [words] = vars("words")
split("joe has a hat", " ", words)

Matches if List includes Element

Parameters

Examples

let [name] = vars("name")
member(name, ["john", "joe", "frank"])

takes a variable number of string arguments and concatenates them into a single string

Parameters

Examples

let [first_name, last_name, full_name] = vars("first_name", "last_name", "full_name")
concat([first_name, " ", last_name], full_name)

Joins a list variable together (Input) into a string variable (Output) by glueing the strings together with Glue

Parameters

Examples

let [sentence] = vars("sentence")
join(["joe", "has", "a", "hat", " ", sentence)

computes the sum of the List of values passed. In contrast to other arithmetic functions, sum self-evaluates - it does not have to be passed to evaluate()

Parameters

Examples

let [total] = vars("total")
sum([2, 3, 4, 5], total)

Specifies an offset position in the results to start listing results from

Parameters

Examples

let [a, b, c] = vars("a", "b", "c")
start(100).triple(a, b, c)

Specifies a maximum number of results that will be returned from the subquery

Parameters

Examples

let [a, b, c] = vars("a", "b", "c")
limit(100).triple(a, b, c)
//subquery is an argument or a chained query
limit(100,triple(a, b, c))

Matches the regular expression defined in Patern against the Test string, to produce the matched patterns in Matches

Parameters

Examples

let [All, Sub] = vars("All", "Sub")
WOQL.re("h(.).*", "hello", [All, Sub])
//e contains 'e', llo contains 'llo'
//p is a regex pattern (.*) using normal regular expression syntax, the only unusual
thing is that special characters have to be escaped twice, s is the string to be matched
and m is a list of matches:

Calculates the length of the list in va and stores it in vb

Parameters

Examples

let [count] = vars("count")
length(["john", "joe", "frank"], count)

Logical negation of the contained subquery - if the subquery matches, the query will fail to match

Parameters

Examples

let [subject, label] = vars("subject", "label")
not().triple(subject, 'label', label)

Results in one solution of the subqueries

Parameters

Runs the query without backtracking on side-effects

Parameters

Creates a count of the results of the query

Parameters

Examples

let [count, Person] = vars("count", "Person")
WOQL.count(count).triple(Person, "rdf:type", "@schema:Person")

Casts the value of Input to a new value of type Type and stores the result in CastVar

Parameters

Examples

let [time] = vars("time")
cast("22/3/98", "xsd:dateTime", time)

Orders the results of the contained subquery by a precedence list of variables

Parameters

Examples

let [A, B, C] = vars("A", "B", "C")
WOQL.order_by(A, [B, "asc"], [C, "desc"]).triple(A, B, C);

Groups the results of the contained subquery on the basis of identical values for Groupvars, extracts the patterns defined in PatternVars and stores the results in GroupedVar

Parameters

Examples

//subquery is an argument or a chained query
let [age, last_name, first_name, age_group, person] = vars("age", "last name", "first name",
"age group", "person")
group_by(age, [last_name, first_name], age_group)
  .triple(person, "first_name", first_name)
  .triple(person, "last_name", last_name)
  .triple(person, "age", age)

A function that always matches, always returns true

Examples

when(true()).triple("a", "b", "c")

Performs a path regular expression match on the graph

Parameters

Examples

let [person, grand_uncle, lineage] = vars("person", "grand uncle", "lineage")
path(person, "((father|mother) {2,2}), brother)", grand_uncle, lineage)

Calculates the size in bytes of the contents of the resource identified in ResourceID

Parameters

Examples

let [varSize] = vars("varSize")
size("admin/minecraft/local/branch/main/instance/main", varSize)
//returns the number of bytes in the main instance graph on the main branch

Calculates the number of triples of the contents of the resource identified in ResourceID

Parameters

Examples

let [count] = vars("count")
triple_count("admin/minecraft/local/_commits", count)
//returns the number of bytes in the local commit graph

Returns true if 'elementId' is of type 'elementType', according to the current DB schema

Parameters

Generates a query that by default matches all triples in a graph identified by "graph" or in all the current terminusDB's graph

Parameters

Examples

star("schema/main")
//will return every triple in schema/main graph

Generates a query that by default matches all triples in a graph - identical to star() except for order of arguments

Parameters

Specifies the identity of a node that can then be used in subsequent builder functions. Note that node() requires subsequent chained functions to complete the triples / quads that it produces - by itself it only generates the subject.

Parameters

Examples

node("mydoc").label("my label")
//equivalent to triple("mydoc", "label", "my label")

Inserts a single triple into the database declaring the Node to have type Type, optionally into the specified graph

Parameters

Examples

insert("mydoc", "MyType")
//equivalent to add_triple("mydoc", "rdf:type", "@schema:MyType")

Sets the graph resource ID that will be used for subsequent chained function calls

Parameters

Examples

WOQL.graph("schema")
//equivalent to add_quad("MyClass", "label", "My Class Label", "schema/main")

Deletes all triples in the passed graph (defaults to instance/main)

Parameters

Examples

nuke("schema/main")
//will delete everything from the schema/main graph

Generates an empty WOQLQuery object

Examples

let q = query()
//then q.triple(1, 1) ...

Generates a WOQLQuery object from the passed WOQL JSON - if an argument is passed, the query object is created from it, if none is passed, the current state is returned as a JSON-LD

Parameters

get the predefined library query [WOQLLibrary](/api/woqlLibrary.js?id=WOQLLibrary)

Examples

//get commits older than the specified commit id
const query = WOQL.lib().previousCommits('m8vpxewh2aovfauebfkbzwmj4qwr5lb')

//return the commits of a specific branch starting from the head
//you can add the limit (how many results to return.) and the start point
//if a timestamp is given, gets the commits before the specified timestamp
//WOQL.lib().commits(branch='main',limit=0,start=0,timestamp=0)

const query = WOQL.lib().commits('main',10,2,1630683082.9278786)

//return the branches list with the timestamp and commits id
const query = WOQL.lib().branches()

Generates explicitly a JSON-LD string literal from the input

Parameters

Examples

string(1)
//returns { "@type": "xsd:string", "@value": "1" }

Generates explicitly a JSON-LD string literal from the input

Parameters

Examples

literal(1, "nonNegativeInteger")
//returns { "@type": "xsd:nonNegativeInteger", "@value": 1 }

Generates explicitly a JSON-LD literal date from the imput

Parameters

Examples

date("2022-10-02")
//returns { "@type": "xsd:date", "@value": "2022-10-02" }

Generates explicitly a JSON-LD literal datetime from the imput

Parameters

Examples

datetime("2022-10-19T14:17:12Z")
//returns { "@type": "xsd:dateTime", "@value": "2022-10-19T14:17:12Z" }

Generates explicitly a JSON-LD literal boolean from the input

Parameters

Examples

boolean(true)
//returns { "@type": "xsd:boolean", "@value": true }

Explicitly sets a value to be an IRI - avoiding automatic type marshalling

Parameters

Generates javascript variables for use as WOQL variables within a query

Parameters

Examples

const [a, b, c] = WOQL.vars("a", "b", "c")
//a, b, c are javascript variables which can be used as WOQL variables in subsequent queries

Produces an encoded form of a document that can be used by a WOQL operation such as `WOQL.insert_document`.

Parameters

Examples

const doc = WOQL.doc({ "@type": "Person", name: "Newperson" })

Use instead to run your query woqlclient.query('myWOQLQuery')

Parameters

Parameters

Examples

const v = WOQL.Vars('var01', 'var02', 'var03');
triple(v.var01, v.var02, v.var03)

query module allow you to use WOQL words as top level functions

Parameters

Update a pattern matching rule for the triple (Subject, Predicate, oldObjValue) with the new one (Subject, Predicate, newObjValue)

Parameters

Update a pattern matching rule for the quad [S, P, O, G] (Subject, Predicate, Object, Graph)

Parameters

Creates a pattern matching rule for a triple [Subject, Predicate, Object] add extra information about the type of the value object

Parameters

Creates a pattern matching rule for a triple [Subject, Predicate, Object]

Parameters

Extract the value of a key in a bound document.

Parameters

set the api key to access the cloud resources

Parameters

add extra headers to your request

Parameters

creates a copy of the client with identical internal state and context useful if we want to change context for a particular API call without changing the current client context

Examples

let newClient = client.copy()

Gets the current connected server url it can only be set creating a new WOQLCLient instance

Retrieve the URL of the server’s API base that we are currently connected to

Examples

let api_url = client.api()

Gets/Sets the client’s internal organization context value, if you change the organization name the databases list will be set to empty

Parameters

Examples

client.organization("admin")

Checks if a database exists Returns true if a DB exists and false if it doesn't. Other results throw an exception.

Parameters

Examples

async function executeIfDatabaseExists(f){
     const hasDB = await client.hasDatabase("admin", "testdb")
     if (hasDB) {
         f()
     }
}

Gets the organization's databases list. If no organization has been set up, the function throws an exception

Examples

async function callGetDatabases(){
     const dbList = await client.getDatabases()
     console.log(dbList)
}

Set/Get the organization's databases list (id, label, comment) that the current user has access to on the server.

Parameters

Examples

//to get the list of all organization's databases
async function callGetDatabases(){
     await client.getDatabases()
     console.log(client.databases())
}

Gets the current user object as returned by the connect capabilities response user has fields: [id, name, notes, author]

Gets the database's details

Parameters

Sets / Gets the current database

Parameters

Examples

client.db("mydb")

Sets the internal client context to allow it to talk to the server’s internal system database

Gets / Sets the client’s internal repository context value (defaults to ‘local’)

Parameters

Examples

client.repo("origin")

Gets/Sets the client’s internal branch context value (defaults to ‘main’)

Parameters

Sets / gets the current ref pointer (pointer to a commit within a branch) Reference ID or Commit ID are unique hashes that are created whenever a new commit is recorded

Parameters

Examples

client.ref("mkz98k2h3j8cqjwi3wxxzuyn7cr6cw7")

Sets/Gets set the database basic connection credential

Parameters

Examples

client.localAuth({user:"admin","key":"mykey","type":"basic"})

Sets/Gets the jwt token for authentication we need this to connect 2 terminusdb server to each other for push, pull, clone actions

Parameters

Examples

client.remoteAuth({"key":"dhfmnmjglkrelgkptohkn","type":"jwt"})

Gets the string that will be written into the commit log for the current user

Examples

client.author()

Parameters

Examples

sets several of the internal state values in a single call
(similar to connect, but only sets internal client state, does not communicate with server)
client.set({key: "mypass", branch: "dev", repo: "origin"})

Generates a resource string for the required context of the current context for "commits" "meta" "branch" and "ref" special resources

Parameters

Examples

const branch_resource = client.resource("branch")

You can call this to get the server info or override the start params configuration, this.connectionConfig.server will be used if present, or the promise will be rejected.

Parameters

Examples

client.connect()

Creates a new database in TerminusDB server

Parameters

Examples

//remember set schema:true if you need to add a schema graph
client.createDatabase("mydb", {label: "My Database", comment: "Testing", schema: true})

Update a database in TerminusDB server

Parameters

Examples

client.updateDatabase({id: "mydb", label: "My Database", comment: "Testing"})

Deletes a database from a TerminusDB server

Parameters

Examples

client.deleteDatabase("mydb")

Retrieve the contents of a graph within a TerminusDB as triples, encoded in the turtle (ttl) format

Parameters

Examples

const turtle = await client.getTriples("schema", "alt")

Replace the contents of the specified graph with the passed triples encoded in the turtle (ttl) format

Parameters

Examples

client.updateTriples("schema", "alt", turtle_string, "dumping triples to graph alt")

Appends the passed turtle to the contents of a graph

Parameters

Sends a message to the server

Parameters

Sends an action to the server

Parameters

Gets TerminusDB Server Information

Examples

client.info()

Executes a WOQL query on the specified database and returns the results

Parameters

Examples

const result = await client.query(WOQL.star())

Creates a new branch with a TerminusDB database, starting from the current context of the client (branch / ref)

Parameters

Examples

client.branch("dev")

Squash branch commits

Parameters

Reset branch to a commit id, Reference ID or Commit ID are unique hashes that are created whenever a new commit is recorded

Parameters

Optimize db branch

Parameters

Deletes a branch from database

Parameters

Pull changes from a branch on a remote database to a branch on a local database

Parameters

Examples

client.pull({remote: "origin", remote_branch: "main", message: "Pulling from remote"})

Fetch updates to a remote database to a remote repository with the local database

Parameters

Push changes from a branch on a local database to a branch on a remote database

Parameters

Examples

client.push({remote: "origin", remote_branch: "main", message: "Pulling from remote"})

Merges the passed branch into the current one using the rebase operation

Parameters

Examples

//from the branch head
client.rebase({rebase_from: "admin/db_name/local/branch/branch_name", message:
"Merging from dev")
//or from a commit id
client.rebase({rebase_from: "admin/db_name/local/commit/9w8hk3y6rb8tjdy961de3i536ntkqd8",
message: "Merging from dev")

Reset the current branch HEAD to the specified commit path

Parameters

Clones a remote repo and creates a local copy

Parameters

Examples

client.clonedb({remote_url: "https://my.terminusdb.com/myorg/mydb", label "Cloned DB", comment: "Cloned from mydb"}, newid: "mydb")

Common request dispatch function

Generates the json structure for commit messages

Parameters

Generates the json structure for commit descriptor

Parameters

Adds an author string (from the user object returned by connect) to the commit message.

Parameters

to add a new document or a list of new documents into the instance or the schema graph.

Parameters

Examples

const json = [{ "@type" : "Class",
             "@id" : "Coordinate",
             "@key" : { '@type' : 'Hash',
             '@fields' : ['x','y'] },
             "x" : "xsd:decimal",
             "y" : "xsd:decimal" },
             { "@type" : "Class",
             "@id" : "Country",
             "@key" : { '@type' : 'Lexical',
                         '@fields' : [name] },
             "name" : "xsd:string",
             "perimeter" : { "@type" : "List",
                             "@class" : "Coordinate" } }]
client.addDocument(json,{"graph_type":"schema"},"mydb","add new schema documents")

//if we would like to override the entire schema
const json = [
{"@base": "terminusdb:///data/",
      "@schema": "terminusdb:///schema#",
      "@type": "@context"
  },
  {
      "@id": "Person",
       "@key": {
          "@type": "Random"
      },
      "@type": "Class",
      "name": {
          "@class": "xsd:string",
          "@type": "Optional"
      }
  }]

// client.addDocument(json,{"graph_type":"schema","full_replace:true"},
      "mydb","update the all schema");

// Here we will pass true to show how to get dataVersion

const response = await client.addDocument(json, {"graph_type": "schema"},
  "mydb",
  "add new schema", '',
  true
)
console.log(response);

 // This will output:
 // {
 //   result: [ ...... ],
 //   dataVersion: 'branch:5fs681tlycnn6jh0ceiqcq4qs89pdfs'
 // }

 // Now we can use the data version we recieved as a response in previous
 // function call and used it is next function call as lastDataVersion

const response1 = await client.addDocument(json, {"graph_type": "schema"},
  "mydb",
  "add new schema", response.dataVersion,
)

Use {@link #getDocument} instead.

Parameters

Examples

const query = {
  "type": "Person",
  "query": { "age": 42 },
 }
client.queryDocument(query, {"as_list":true})


// Here we will pass true to show how to get dataVersion
const query = {
  "type": "Person",
  "query": { "age": 42 },
 }

const response = await client.queryDocument(query, {"as_list": true}, '', '','',true);
console.log(response);

 // This will output:
 // {
 //   result: [
 //     {
 //       '@id': 'Person/052d60ffbd114bf5e7331b03f07fcb7',
 //       '@type': 'Person',
 //       age: 42,
 //       name: 'John',
 //     },
 //   ],
 //   dataVersion: 'branch:5fs681tlycnn6jh0ceiqcq4qs89pdfs'
 // }

 // Now we can use the data version we recieved as a response in previous
 // query and used it is next query as lastDataVersion
 const query = {
  "type": "Person",
  "query": { "age": 18 },
 }

 const response1 = await client.queryDocument(query, {"as_list": true}, '',
   '',
   response.dataVersion
 );

Parameters

Examples

//return the schema graph as a json array
client.getDocument({"graph_type":"schema","as_list":true}).then(result={
   console.log(result)
})

//retutn the Country class document from the schema graph
client.getDocument({"graph_type":"schema","as_list":true,"id":"Country"}).then(result={
   console.log(result)
})

//pass a document query template to query the document interface
const queryTemplate = { "name": "Ireland"}
client.getDocument({"as_list":true, "@type":"Country"
           query:queryTemplate}).then(result=>{
   console.log(result)
})


// Here we will pass true to show how to get dataVersion
const response = await client.getDocument({"graph_type":"schema","as_list":true},
  "",
  "",
  "",
  true
)
console.log(response);

 // This will output:
 // {
 //   result: [ ...... ],
 //   dataVersion: 'branch:5fs681tlycnn6jh0ceiqcq4qs89pdfs'
 // }

 // Now we can use the data version we recieved as a response in previous
 // function call and used it is next function call as lastDataVersion

const response1 = await client.getDocument({"graph_type":"schema","as_list":true},
  "",
  "",
  response.dataVersion,
)

Parameters

Examples

client.updateDocument(
{
 "@id": "Person",
   "@key": {
     "@type": "Random",
   },
   "@type": "Class",
   label: "xsd:string",
 },
{ graph_type: "schema" }
);


// Here we will pass true to show how to get dataVersion

    const response = await client.updateDocument(
      {
        "@id": "Person",
        "@key": {
          "@type": "Random",
        },
        "@type": "Class",
        label: "xsd:string",
      },
      { graph_type: "schema" },
      "",
      "",
      "",
      true
    );
console.log(response);

 // This will output:
 // {
 //   result: [ ...... ],
 //   dataVersion: 'branch:5fs681tlycnn6jh0ceiqcq4qs89pdfs'
 // }

 // Now we can use the data version we recieved as a response in previous
 // function call and used it is next function call as lastDataVersion

const response1 = await client.updateDocument(
      {
        "@id": "Person",
        "@key": {
          "@type": "Random",
        },
        "@type": "Class",
        label: "xsd:string",
      },
      { graph_type: "schema" },
      "",
      "",
      response.dataVersion
    );

 // update a document and create the linked document together
 // we are update the document "Person/Person01"
 // and create a new document {"@type": "Person","name": "child01"} at the same time
 const response1 = await client.updateDocument(
     {
      "@id": "Person/Person01",
      "@type": "Person",
      "name": "Person01"
      "children":[{"@type": "Person","name": "child01"}]
    },{create:true})

to delete the document

Parameters

Examples

client.deleteDocument({"graph_type":"schema",id:['Country','Coordinate']})


// Here we will pass true to show how to get dataVersion

const response = await client.deleteDocument({"graph_type":"schema",id:['Country','Coordinate']},
  "",
  "",
  "",
  true
)
console.log(response);

 // This will output:
 // {
 //   result: [ ...... ],
 //   dataVersion: 'branch:5fs681tlycnn6jh0ceiqcq4qs89pdfs'
 // }

 // Now we can use the data version we recieved as a response in previous
 // function call and used it is next function call as lastDataVersion

const response1 = await client.deleteDocument({"graph_type":"schema",
  id:['Country','Coordinate']},
  "",
  "",
  response.dataVersion,
)

The purpose of this method is to quickly discover the supported fields of a particular type.

Parameters

Examples

client.getSchemaFrame("Country")

get the database schema in json format

Parameters

Examples

client.getSchema()

get all the schema classes (documents,subdocuments,abstracts)

Parameters

Examples

client.getClasses()

get all the Enum Objects

Parameters

Examples

client.getEnums()

get all the Document Classes (no abstract or subdocument)

Parameters

Examples

client.getClassDocuments()

get the database collections list

Parameters

Examples

client.getBranches()

get the database collections list

Parameters

Examples

client.getCommitsLog(count=10)

get the database prefixes object

Parameters

Examples

client.getPrefixes()
//return object example
{
'@base': 'terminusdb:///data/',
'@schema': 'terminusdb:///schema#',
'@type': 'Context'}

Get the list of the user's organizations and the database related

Examples

async funtion callGetUserOrganizations(){
     await getUserOrganizations()
     console.log(client.userOrganizations())
}

Get/Set the list of the user's organizations (id, organization, label, comment).

Parameters

Examples

async funtion callGetUserOrganizations(){
     await client.getUserOrganizations()
     console.log(client.userOrganizations())
}

Apply a patch object to another object

Parameters

Examples

client.patch(
     { "@id" : "Person/Jane", "@type" : "Person", "name" : "Jane"},
     { "name" : { "@op" : "ValueSwap", "@before" : "Jane", "@after": "Janine" }}
 ).then(patchResult=>{
 console.log(patchResult)
})
//result example
//{ "@id" : "Person/Jane", "@type" : "Person", "name" : "Jannet"}

Apply a patch object to the current resource

Parameters

Examples

const patch = [
  {
   "@id": "Obj/id1",
    "name": {
     "@op": "SwapValue",
      "@before": "foo",
      "@after": "bar"
    }
  },
 {
   "@id": "Obj/id2",
    "name": {
      "@op": "SwapValue",
      "@before": "foo",
     "@after": "bar"
    }
 }
]
client.db("mydb")
client.checkout("mybranch")
client.patchResource(patch,"apply patch to mybranch").then(patchResult=>{
 console.log(patchResult)
})
// result example
// ["Obj/id1",
// "Obj/id2"]
// or conflict error 409
// {
// "@type": "api:PatchError",
// "api:status": "api:conflict",
// "api:witnesses": [
//  {
//   "@op": "InsertConflict",
//    "@id_already_exists": "Person/Jane"
//  }
//]
//}

Get the patch of difference between two documents.

Parameters

Examples

client.getJSONDiff(
     { "@id": "Person/Jane", "@type": "Person", name: "Jane" },
     { "@id": "Person/Jane", "@type": "Person", name: "Janine" }
 ).then(diffResult=>{
 console.log(diffResult)
})
//result example
//{'@id': 'Person/Jane',
// name: { '@after': 'Janine', '@before': 'Jane', '@op': 'SwapValue' }}

Get the patch of difference between two documents.

Parameters

Examples

const jsonObj =  { "@id": "Person/Jane", "@type": "Person", name: "Janine" }
client.getVersionObjectDiff("main",jsonObj
     "Person/Jane").then(diffResp=>{
   console.log(diffResp)
})

Get the patch of difference between branches or commits.

Parameters

Examples

//This is to view all the changes between two commits
const beforeCommit = "a73ssscfx0kke7z76083cgswszdxy6l"
const afterCommit = "73rqpooz65kbsheuno5dsayh71x7wf4"

client.getVersionDiff( beforeCommit, afterCommit).then(diffResult=>{
 console.log(diffResult)
})

//This is to view the changes between two commits but only for the given document
client.getVersionDiff( beforeCommit, afterCommit, "Person/Tom").then(diffResult=>{
 console.log(diffResult)
})

//This is to view the changes between a branch (head) and a commit for the given document
client.getVersionDiff("main", afterCommit, "Person/Tom" ).then(diffResult=>{
   console.log(diffResult)
})

//This is to view the changes between two branches with the keep options
const options = {"keep":{"@id":true, "name": true}, start:0, count:10}
client.getVersionDiff("main","mybranch",options).then(diffResult=>{
   console.log(diffResult)
})

Diff two different commits and apply changes on the current branch/commit. If you would like to change branch or commit before apply use client.checkout("branchName")

Parameters

Examples

client.checkout("mybranch")
client.apply("mybranch","mybranch_new","merge main").then(result=>{
   console.log(result)
})

Get the document's history for a specific database or branch

Parameters

Examples

//this will return the last 5 commits for the Person/Anna document
client.checkout("mybranch")
client.docHistory("Person/Anna",{start:0,count:5}).then(result=>{
   console.log(result)
})
//this will return the last and the first commit for the Person/Anna document
client.docHistory("Person/Anna",{updated:true,created:true}).then(result=>{
   console.log(result)
})

Call a custom Api endpoit

Parameters

Examples

client.sendCustomRequest("GET", "http://localhost:3030/changes/").then(result=>{
   console.log(result)
})