Skip to content

Commit 3404b33

Browse files
committed
review docs
1 parent a25ac02 commit 3404b33

22 files changed

+747
-8886
lines changed

docs/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,13 @@ const TerminusClient = require("@terminusdb/terminusdb-client");
5757

5858
// Connect and configure the TerminusClient
5959
const client = new TerminusClient.WOQLClient("https://127.0.0.1:6363/", {
60-
dbid: "banker",
60+
db: "banker",
6161
user: "admin",
6262
key: "root",
6363
});
64-
client.db("banker");
64+
65+
//to change the starting settings
66+
client.db("banker01");
6567
client.organization("admin");
6668

6769
async function postAccount() {
@@ -115,7 +117,7 @@ To initialize `TerminusDB client` with custom options use
115117
const TerminusClient = require("@terminusdb/terminusdb-client");
116118

117119
const client = new TerminusClient.WOQLClient("https://127.0.0.1:6363/", {
118-
dbid: "test_db",
120+
id: "test_db",
119121
user: "admin",
120122
key: "my_secret_key",
121123
});

docs/api/navtest.js.md

Lines changed: 35 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
- [author](api/woqlClient.js?id=author)
1919
- [set](api/woqlClient.js?id=set)
2020
- [resource](api/woqlClient.js?id=resource)
21+
- [connect](api/woqlClient.js?id=connect)
2122
- [createDatabase](api/woqlClient.js?id=createDatabase)
2223
- [deleteDatabase](api/woqlClient.js?id=deleteDatabase)
2324
- [createGraph](api/woqlClient.js?id=createGraph)
@@ -34,6 +35,10 @@
3435
- [info](api/woqlClient.js?id=info)
3536
- [query](api/woqlClient.js?id=query)
3637
- [branch](api/woqlClient.js?id=branch)
38+
- [squashBranch](api/woqlClient.js?id=squashBranch)
39+
- [resetBranch](api/woqlClient.js?id=resetBranch)
40+
- [optimizeBranch](api/woqlClient.js?id=optimizeBranch)
41+
- [deleteBranch](api/woqlClient.js?id=deleteBranch)
3742
- [pull](api/woqlClient.js?id=pull)
3843
- [fetch](api/woqlClient.js?id=fetch)
3944
- [push](api/woqlClient.js?id=push)
@@ -42,6 +47,7 @@
4247
- [clonedb](api/woqlClient.js?id=clonedb)
4348
- [dispatch](api/woqlClient.js?id=dispatch)
4449
- [generateCommitInfo](api/woqlClient.js?id=generateCommitInfo)
50+
- [generateCommitDescriptor](api/woqlClient.js?id=generateCommitDescriptor)
4551
- [prepareRevisionControlArgs](api/woqlClient.js?id=prepareRevisionControlArgs)
4652
- [_load_db_prefixes](api/woqlClient.js?id=_load_db_prefixes)
4753
- [getClassFrame](api/woqlClient.js?id=getClassFrame)
@@ -58,7 +64,6 @@
5864
- [deleteOrganization](api/woqlClient.js?id=deleteOrganization)
5965
- [getRoles](api/woqlClient.js?id=getRoles)
6066
- [updateRoles](api/woqlClient.js?id=updateRoles)
61-
- [connect](api/woqlClient.js?id=connect)
6267
- [WOQL](api/woql.js?id=WOQL)
6368
- [eval](api/woql.js?id=eval)
6469
- [using](api/woql.js?id=using)
@@ -105,46 +110,46 @@
105110
- [like](api/woql.js?id=like)
106111
- [less](api/woql.js?id=less)
107112
- [greater](api/woql.js?id=greater)
108-
- [WOQL.opt](api/woql.js?id=WOQL.opt)
109-
- [WOQL.unique](api/woql.js?id=WOQL.unique)
110-
- [WOQL.idgen](api/woql.js?id=WOQL.idgen)
111-
- [WOQL.upper](api/woql.js?id=WOQL.upper)
112-
- [WOQL.lower](api/woql.js?id=WOQL.lower)
113-
- [WOQL.pad](api/woql.js?id=WOQL.pad)
113+
- [opt](api/woql.js?id=opt)
114+
- [unique](api/woql.js?id=unique)
115+
- [idgen](api/woql.js?id=idgen)
116+
- [upper](api/woql.js?id=upper)
117+
- [lower](api/woql.js?id=lower)
118+
- [pad](api/woql.js?id=pad)
114119
- [split](api/woql.js?id=split)
115120
- [member](api/woql.js?id=member)
116-
- [WOQL.concat](api/woql.js?id=WOQL.concat)
117-
- [WOQL.join](api/woql.js?id=WOQL.join)
121+
- [concat](api/woql.js?id=concat)
122+
- [join](api/woql.js?id=join)
118123
- [sum](api/woql.js?id=sum)
119-
- [WOQL.start](api/woql.js?id=WOQL.start)
120-
- [WOQL.limit](api/woql.js?id=WOQL.limit)
121-
- [WOQL.re](api/woql.js?id=WOQL.re)
122-
- [WOQL.length](api/woql.js?id=WOQL.length)
123-
- [WOQL.not](api/woql.js?id=WOQL.not)
124+
- [start](api/woql.js?id=start)
125+
- [limit](api/woql.js?id=limit)
126+
- [re](api/woql.js?id=re)
127+
- [length](api/woql.js?id=length)
128+
- [not](api/woql.js?id=not)
124129
- [once](api/woql.js?id=once)
125130
- [immediately](api/woql.js?id=immediately)
126131
- [count](api/woql.js?id=count)
127-
- [WOQL.typecast](api/woql.js?id=WOQL.typecast)
132+
- [typecast](api/woql.js?id=typecast)
128133
- [order_by](api/woql.js?id=order_by)
129-
- [WOQL.group_by](api/woql.js?id=WOQL.group_by)
130-
- [WOQL.true](api/woql.js?id=WOQL.true)
131-
- [WOQL.path](api/woql.js?id=WOQL.path)
132-
- [WOQL.size](api/woql.js?id=WOQL.size)
133-
- [WOQL.triple_count](api/woql.js?id=WOQL.triple_count)
134-
- [WOQL.type_of](api/woql.js?id=WOQL.type_of)
135-
- [WOQL.star](api/woql.js?id=WOQL.star)
136-
- [WOQL.all](api/woql.js?id=WOQL.all)
137-
- [WOQL.node](api/woql.js?id=WOQL.node)
134+
- [group_by](api/woql.js?id=group_by)
135+
- [true](api/woql.js?id=true)
136+
- [path](api/woql.js?id=path)
137+
- [size](api/woql.js?id=size)
138+
- [triple_count](api/woql.js?id=triple_count)
139+
- [type_of](api/woql.js?id=type_of)
140+
- [star](api/woql.js?id=star)
141+
- [all](api/woql.js?id=all)
142+
- [node](api/woql.js?id=node)
138143
- [insert](api/woql.js?id=insert)
139144
- [schema](api/woql.js?id=schema)
140145
- [graph](api/woql.js?id=graph)
141-
- [WOQL.add_class](api/woql.js?id=WOQL.add_class)
146+
- [add_class](api/woql.js?id=add_class)
142147
- [add_property](api/woql.js?id=add_property)
143148
- [delete_class](api/woql.js?id=delete_class)
144-
- [WOQL.delete_property](api/woql.js?id=WOQL.delete_property)
145-
- [WOQL.doctype](api/woql.js?id=WOQL.doctype)
146-
- [WOQL.insert_data](api/woql.js?id=WOQL.insert_data)
147-
- [WOQL.insert_class_data](api/woql.js?id=WOQL.insert_class_data)
149+
- [delete_property](api/woql.js?id=delete_property)
150+
- [doctype](api/woql.js?id=doctype)
151+
- [insert_data](api/woql.js?id=insert_data)
152+
- [insert_class_data](api/woql.js?id=insert_class_data)
148153
- [insert_doctype_data](api/woql.js?id=insert_doctype_data)
149154
- [insert_property_data](api/woql.js?id=insert_property_data)
150155
- [nuke](api/woql.js?id=nuke)
@@ -155,6 +160,7 @@
155160
- [iri](api/woql.js?id=iri)
156161
- [vars](api/woql.js?id=vars)
157162
- [client](api/woql.js?id=client)
163+
- [emerge](api/woql.js?id=emerge)
158164
- [update_triple](api/woql.js?id=update_triple)
159165
- [update_quad](api/woql.js?id=update_quad)
160166
- [value](api/woql.js?id=value)

0 commit comments

Comments
 (0)