Skip to content

Commit de2fe13

Browse files
Francesca-BitFrancesca-Bit
committed
public docsify
1 parent bfde60b commit de2fe13

File tree

11 files changed

+2985
-278
lines changed

11 files changed

+2985
-278
lines changed

‎docs/_sidebar.md

Lines changed: 200 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,200 @@
1+
<!-- docs/_sidebar.md -->
2+
- [Getting started](./README.md)
3+
- [Requirements](./README?id=requirements)
4+
- [Installation](./README?id=installation)
5+
- [NPM Module](./README?id=npm-module)
6+
- [Minified Script](README?id=minified-script)
7+
- [Usage](README?id=usage)
8+
- [Report Issues](README?id=report-issues)
9+
- [Contribute](README?id=contribute)
10+
- [Licence](README?id=licence)
11+
- [WOQLClient](./api/woqlClient.js?id=WOQLClient)
12+
- [TerminusDB Client API](./api/woqlClient.js?id=terminusdb-client-api)
13+
- [Connect](./api/woqlClient.js?id=connect)
14+
- [Create Database](./api/woqlClient.js?id=create-database)
15+
- [Delete Database](./api/woqlClient.js?id=delete-database)
16+
- [Create Graph](./api/woqlClient.js?id=create-graph)
17+
- [Delete Graph](./api/woqlClient.js?id=delete-graph)
18+
- [Get Triples](./api/woqlClient.js?id=get-triples)
19+
- [Update Triples](./api/woqlClient.js?id=update-triples)
20+
- [Query](./api/woqlClient.js?id=query)
21+
- [Clonedb](./api/woqlClient.js?id=clonedb)
22+
- [Branch](./api/woqlClient.js?id=branch)
23+
- [Rebase](./api/woqlClient.js?id=rebase)
24+
- [Pull](./api/woqlClient.js?id=pull)
25+
- [Push](./api/woqlClient.js?id=push)
26+
- [Fetch](./api/woqlClient.js?id=fetch)
27+
- [Insert CSV](./api/woqlClient.js?id=insert-csv)
28+
- [Update CSV](./api/woqlClient.js?id=update-csv)
29+
- [Get CSV](./api/woqlClient.js?id=get-csv)
30+
- [Delete CSV](./api/woqlClient.js?id=delete-csv)
31+
- [copy](./api/woqlClient.js?id=copy)
32+
- [server](./api/woqlClient.js?id=server)
33+
- [api](./api/woqlClient.js?id=api)
34+
- [organization](./api/woqlClient.js?id=organization)
35+
- [user](./api/woqlClient.js?id=user)
36+
- [uid](./api/woqlClient.js?id=uid)
37+
- [userOrganization](./api/woqlClient.js?id=userOrganization)
38+
- [databases](./api/woqlClient.js?id=databases)
39+
- [databaseInfo](./api/woqlClient.js?id=databaseInfo)
40+
- [db](./api/woqlClient.js?id=db)
41+
- [setSystemDb](./api/woqlClient.js?id=setSystemDb)
42+
- [repo](./api/woqlClient.js?id=repo)
43+
- [checkout](./api/woqlClient.js?id=checkout)
44+
- [ref](./api/woqlClient.js?id=ref)
45+
- [localAuth](./api/woqlClient.js?id=localAuth)
46+
- [remoteAuth](./api/woqlClient.js?id=remoteAuth)
47+
- [author](./api/woqlClient.js?id=author)
48+
- [set](./api/woqlClient.js?id=set)
49+
- [resource](./api/woqlClient.js?id=resource)
50+
- [insertTriples](./api/woqlClient.js?id=insertTriples)
51+
- [message](./api/woqlClient.js?id=message)
52+
- [action](./api/woqlClient.js?id=action)
53+
- [info](./api/woqlClient.js?id=info)
54+
- [squashBranch](./api/woqlClient.js?id=squashBranch)
55+
- [resetBranch](./api/woqlClient.js?id=resetBranch)
56+
- [optimizeBranch](./api/woqlClient.js?id=optimizeBranch)
57+
- [deleteBranch](./api/woqlClient.js?id=deleteBranch)
58+
- [reset](./api/woqlClient.js?id=reset)
59+
- [dispatch](./api/woqlClient.js?id=dispatch)
60+
- [generateCommitInfo](./api/woqlClient.js?id=generateCommitInfo)
61+
- [generateCommitDescriptor](./api/woqlClient.js?id=generateCommitDescriptor)
62+
- [prepareRevisionControlArgs](./api/woqlClient.js?id=prepareRevisionControlArgs)
63+
- [_load_db_prefixes](./api/woqlClient.js?id=_load_db_prefixes)
64+
- [getClassFrame](./api/woqlClient.js?id=getClassFrame)
65+
- [updateDatabase](./api/woqlClient.js?id=updateDatabase)
66+
- [organizations](./api/woqlClient.js?id=organizations)
67+
- [action_permitted](./api/woqlClient.js?id=action_permitted)
68+
- [createUser](./api/woqlClient.js?id=createUser)
69+
- [getUser](./api/woqlClient.js?id=getUser)
70+
- [updateUser](./api/woqlClient.js?id=updateUser)
71+
- [deleteUser](./api/woqlClient.js?id=deleteUser)
72+
- [createOrganization](./api/woqlClient.js?id=createOrganization)
73+
- [getOrganization](./api/woqlClient.js?id=getOrganization)
74+
- [updateOrganization](./api/woqlClient.js?id=updateOrganization)
75+
- [deleteOrganization](./api/woqlClient.js?id=deleteOrganization)
76+
- [getRoles](./api/woqlClient.js?id=getRoles)
77+
- [updateRoles](./api/woqlClient.js?id=updateRoles)
78+
- [WOQL](./api/woql.js?id=WOQL)
79+
- [eval](./api/woql.js?id=eval)
80+
- [using](./api/woql.js?id=using)
81+
- [comment](./api/woql.js?id=comment)
82+
- [select](./api/woql.js?id=select)
83+
- [distinct](./api/woql.js?id=distinct)
84+
- [and](./api/woql.js?id=and)
85+
- [or](./api/woql.js?id=or)
86+
- [from](./api/woql.js?id=from)
87+
- [into](./api/woql.js?id=into)
88+
- [triple](./api/woql.js?id=triple)
89+
- [added_triple](./api/woql.js?id=added_triple)
90+
- [removed_triple](./api/woql.js?id=removed_triple)
91+
- [quad](./api/woql.js?id=quad)
92+
- [added_quad](./api/woql.js?id=added_quad)
93+
- [removed_quad](./api/woql.js?id=removed_quad)
94+
- [sub](./api/woql.js?id=sub)
95+
- [eq](./api/woql.js?id=eq)
96+
- [substr](./api/woql.js?id=substr)
97+
- [update_object](./api/woql.js?id=update_object)
98+
- [delete_object](./api/woql.js?id=delete_object)
99+
- [read_object](./api/woql.js?id=read_object)
100+
- [get](./api/woql.js?id=get)
101+
- [put](./api/woql.js?id=put)
102+
- [as](./api/woql.js?id=as)
103+
- [remote](./api/woql.js?id=remote)
104+
- [file](./api/woql.js?id=file)
105+
- [post](./api/woql.js?id=post)
106+
- [delete_triple](./api/woql.js?id=delete_triple)
107+
- [delete_quad](./api/woql.js?id=delete_quad)
108+
- [add_triple](./api/woql.js?id=add_triple)
109+
- [add_quad](./api/woql.js?id=add_quad)
110+
- [when](./api/woql.js?id=when)
111+
- [trim](./api/woql.js?id=trim)
112+
- [evaluate](./api/woql.js?id=evaluate)
113+
- [plus](./api/woql.js?id=plus)
114+
- [minus](./api/woql.js?id=minus)
115+
- [times](./api/woql.js?id=times)
116+
- [divide](./api/woql.js?id=divide)
117+
- [div](./api/woql.js?id=div)
118+
- [exp](./api/woql.js?id=exp)
119+
- [floor](./api/woql.js?id=floor)
120+
- [isa](./api/woql.js?id=isa)
121+
- [like](./api/woql.js?id=like)
122+
- [less](./api/woql.js?id=less)
123+
- [greater](./api/woql.js?id=greater)
124+
- [opt](./api/woql.js?id=opt)
125+
- [unique](./api/woql.js?id=unique)
126+
- [idgen](./api/woql.js?id=idgen)
127+
- [upper](./api/woql.js?id=upper)
128+
- [lower](./api/woql.js?id=lower)
129+
- [pad](./api/woql.js?id=pad)
130+
- [split](./api/woql.js?id=split)
131+
- [member](./api/woql.js?id=member)
132+
- [concat](./api/woql.js?id=concat)
133+
- [join](./api/woql.js?id=join)
134+
- [sum](./api/woql.js?id=sum)
135+
- [start](./api/woql.js?id=start)
136+
- [limit](./api/woql.js?id=limit)
137+
- [re](./api/woql.js?id=re)
138+
- [length](./api/woql.js?id=length)
139+
- [not](./api/woql.js?id=not)
140+
- [once](./api/woql.js?id=once)
141+
- [immediately](./api/woql.js?id=immediately)
142+
- [count](./api/woql.js?id=count)
143+
- [typecast](./api/woql.js?id=typecast)
144+
- [order_by](./api/woql.js?id=order_by)
145+
- [group_by](./api/woql.js?id=group_by)
146+
- [true](./api/woql.js?id=true)
147+
- [path](./api/woql.js?id=path)
148+
- [size](./api/woql.js?id=size)
149+
- [triple_count](./api/woql.js?id=triple_count)
150+
- [type_of](./api/woql.js?id=type_of)
151+
- [star](./api/woql.js?id=star)
152+
- [all](./api/woql.js?id=all)
153+
- [node](./api/woql.js?id=node)
154+
- [insert](./api/woql.js?id=insert)
155+
- [schema](./api/woql.js?id=schema)
156+
- [graph](./api/woql.js?id=graph)
157+
- [add_class](./api/woql.js?id=add_class)
158+
- [add_property](./api/woql.js?id=add_property)
159+
- [delete_class](./api/woql.js?id=delete_class)
160+
- [delete_property](./api/woql.js?id=delete_property)
161+
- [doctype](./api/woql.js?id=doctype)
162+
- [insert_data](./api/woql.js?id=insert_data)
163+
- [insert_class_data](./api/woql.js?id=insert_class_data)
164+
- [insert_doctype_data](./api/woql.js?id=insert_doctype_data)
165+
- [insert_property_data](./api/woql.js?id=insert_property_data)
166+
- [nuke](./api/woql.js?id=nuke)
167+
- [query](./api/woql.js?id=query)
168+
- [json](./api/woql.js?id=json)
169+
- [string](./api/woql.js?id=string)
170+
- [literal](./api/woql.js?id=literal)
171+
- [iri](./api/woql.js?id=iri)
172+
- [vars](./api/woql.js?id=vars)
173+
- [client](./api/woql.js?id=client)
174+
- [emerge](./api/woql.js?id=emerge)
175+
- [update_triple](./api/woql.js?id=update_triple)
176+
- [update_quad](./api/woql.js?id=update_quad)
177+
- [value](./api/woql.js?id=value)
178+
- [link](./api/woql.js?id=link)
179+
- [makeEnum](./api/woql.js?id=makeEnum)
180+
- [generateChoiceList](./api/woql.js?id=generateChoiceList)
181+
- [updateChoiceList](./api/woql.js?id=updateChoiceList)
182+
- [deleteChoiceList](./api/woql.js?id=deleteChoiceList)
183+
- [libs](./api/woql.js?id=libs)
184+
- [boxClasses](./api/woql.js?id=boxClasses)
185+
- [GraphRef](./api/typedef.js?id=GraphRef)
186+
- [DataFormatObj](./api/typedef.js?id=DataFormatObj)
187+
- [FuntionType](./api/typedef.js?id=FuntionType)
188+
- [ClassObj](./api/typedef.js?id=ClassObj)
189+
- [PropertyObj](./api/typedef.js?id=PropertyObj)
190+
- [ResourceType](./api/typedef.js?id=ResourceType)
191+
- [GraphType](./api/typedef.js?id=GraphType)
192+
- [CredentialObj](./api/typedef.js?id=CredentialObj)
193+
- [ActionType](./api/typedef.js?id=ActionType)
194+
- [ParamsObj](./api/typedef.js?id=ParamsObj)
195+
- [RolesObj](./api/typedef.js?id=RolesObj)
196+
- [RepoType](./api/typedef.js?id=RepoType)
197+
- [DbDetails](./api/typedef.js?id=DbDetails)
198+
- [RemoteRepoDetails](./api/typedef.js?id=RemoteRepoDetails)
199+
- [CloneSourceDetails](./api/typedef.js?id=CloneSourceDetails)
200+

‎docs/api/typedef.md

Lines changed: 186 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,186 @@
1+
## Typedefs
2+
3+
<dl>
4+
<dt><a href="#GraphRef">GraphRef</a> : <code>&quot;schema/main&quot;</code> | <code>&quot;schema/*&quot;</code> | <code>&quot;instance/main&quot;</code> | <code>&quot;instance/*&quot;</code> | <code>&quot;inference/main&quot;</code> | <code>&quot;inference/*&quot;</code> | <code>string</code></dt>
5+
<dd></dd>
6+
<dt><a href="#DataFormatObj">DataFormatObj</a> : <code>Object</code></dt>
7+
<dd><p>(export/import)</p>
8+
</dd>
9+
<dt><a href="#FuntionType">FuntionType</a> : <code>&quot;add_quad&quot;</code> | <code>&quot;delete_quad&quot;</code> | <code>&quot;add_triple&quot;</code> | <code>&quot;delete_triple&quot;</code> | <code>&quot;quad&quot;</code> | <code>&quot;triple&quot;</code></dt>
10+
<dd></dd>
11+
<dt><a href="#ClassObj">ClassObj</a> : <code>Object</code></dt>
12+
<dd><p>the class details object</p>
13+
</dd>
14+
<dt><a href="#PropertyObj">PropertyObj</a> : <code>Object</code></dt>
15+
<dd><p>an object that describe a property element</p>
16+
</dd>
17+
<dt><a href="#ResourceType">ResourceType</a> : <code>&quot;commits&quot;</code> | <code>&quot;meta&quot;</code> | <code>&quot;branch&quot;</code> | <code>&quot;ref&quot;</code> | <code>&quot;repo&quot;</code> | <code>&quot;db&quot;</code></dt>
18+
<dd></dd>
19+
<dt><a href="#GraphType">GraphType</a> : <code>&quot;inference&quot;</code> | <code>&quot;schema&quot;</code> | <code>&quot;instance&quot;</code></dt>
20+
<dd></dd>
21+
<dt><a href="#CredentialObj">CredentialObj</a> : <code>Object</code></dt>
22+
<dd></dd>
23+
<dt><a href="#ActionType">ActionType</a> : <code>&#x27;graph&#x27;</code> | <code>&#x27;db&#x27;</code> | <code>&#x27;clone&#x27;</code> | <code>&#x27;triples&#x27;</code> | <code>&#x27;woql&#x27;</code> | <code>&#x27;frame&#x27;</code> | <code>&#x27;fetch&#x27;</code> | <code>&#x27;pull&#x27;</code> | <code>&#x27;rebase&#x27;</code> | <code>&#x27;csv&#x27;</code> | <code>&#x27;branch&#x27;</code> | <code>&#x27;reset&#x27;</code> | <code>&#x27;push&#x27;</code> | <code>&#x27;squash&#x27;</code></dt>
24+
<dd></dd>
25+
<dt><a href="#ParamsObj">ParamsObj</a> : <code>Object</code></dt>
26+
<dd></dd>
27+
<dt><a href="#RolesObj">RolesObj</a> : <code>Object</code></dt>
28+
<dd></dd>
29+
<dt><a href="#RepoType">RepoType</a> : <code>&quot;local&quot;</code> | <code>&quot;remote&quot;</code></dt>
30+
<dd></dd>
31+
<dt><a href="#DbDetails">DbDetails</a> : <code>Object</code></dt>
32+
<dd></dd>
33+
<dt><a href="#RemoteRepoDetails">RemoteRepoDetails</a> : <code>Object</code></dt>
34+
<dd><p>{remote: &quot;origin&quot;, &quot;remote_branch&quot;: &quot;main&quot;, &quot;author&quot;: &quot;admin&quot;, &quot;message&quot;: &quot;message&quot;}</p>
35+
</dd>
36+
<dt><a href="#CloneSourceDetails">CloneSourceDetails</a> : <code>Object</code></dt>
37+
<dd></dd>
38+
</dl>
39+
40+
41+
## GraphRef
42+
#### GraphRef : <code>&quot;schema/main&quot;</code> \| <code>&quot;schema/\*&quot;</code> \| <code>&quot;instance/main&quot;</code> \| <code>&quot;instance/\*&quot;</code> \| <code>&quot;inference/main&quot;</code> \| <code>&quot;inference/\*&quot;</code> \| <code>string</code>
43+
44+
## DataFormatObj
45+
#### DataFormatObj : <code>Object</code>
46+
(export/import)
47+
48+
**Properties**
49+
50+
| Name | Type | Description |
51+
| --- | --- | --- |
52+
| [type] | <code>&quot;csv&quot;</code> \| <code>&quot;turtle&quot;</code> | the format type |
53+
| [format_header] | <code>string</code> | header format type |
54+
55+
56+
## FuntionType
57+
#### FuntionType : <code>&quot;add\_quad&quot;</code> \| <code>&quot;delete\_quad&quot;</code> \| <code>&quot;add\_triple&quot;</code> \| <code>&quot;delete\_triple&quot;</code> \| <code>&quot;quad&quot;</code> \| <code>&quot;triple&quot;</code>
58+
59+
## ClassObj
60+
#### ClassObj : <code>Object</code>
61+
the class details object
62+
63+
**Properties**
64+
65+
| Name | Type | Description |
66+
| --- | --- | --- |
67+
| id | <code>string</code> | IRI or variable containing IRI of the class to be inserted |
68+
| [label] | <code>string</code> | |
69+
| [description] | <code>string</code> | |
70+
| [abstract] | <code>boolean</code> | |
71+
| [parent] | <code>array</code> \| <code>string</code> | if not parent the new class will be a class ObjectW |
72+
| [{k:string}] | <code>any</code> | properties |
73+
74+
75+
## PropertyObj
76+
#### PropertyObj : <code>Object</code>
77+
an object that describe a property element
78+
79+
**Properties**
80+
81+
| Name | Type | Description |
82+
| --- | --- | --- |
83+
| id | <code>string</code> | |
84+
| range | <code>string</code> | the type of property (class id or a native type xsd:number etc.. ) |
85+
| [label] | <code>string</code> | |
86+
| [description] | <code>string</code> | |
87+
| domain | <code>string</code> | the ID of the class to which the property belongs |
88+
| [max] | <code>string</code> | the max property's cardinality |
89+
| [min] | <code>string</code> | the min property's cardinality |
90+
| [cardinality] | <code>string</code> | the property cardinality (max and min value) |
91+
92+
93+
## ResourceType
94+
#### ResourceType : <code>&quot;commits&quot;</code> \| <code>&quot;meta&quot;</code> \| <code>&quot;branch&quot;</code> \| <code>&quot;ref&quot;</code> \| <code>&quot;repo&quot;</code> \| <code>&quot;db&quot;</code>
95+
96+
## GraphType
97+
#### GraphType : <code>&quot;inference&quot;</code> \| <code>&quot;schema&quot;</code> \| <code>&quot;instance&quot;</code>
98+
99+
## CredentialObj
100+
#### CredentialObj : <code>Object</code>
101+
**Properties**
102+
103+
| Name | Type | Description |
104+
| --- | --- | --- |
105+
| type | <code>&#x27;basic&#x27;</code> \| <code>&#x27;jwt&#x27;</code> | the authorization type of an TerminusDB connection |
106+
| [user] | <code>string</code> \| <code>boolean</code> | the user id | I don't need the user with the jwt token |
107+
| key | <code>string</code> | the connection key |
108+
109+
110+
## ActionType
111+
#### ActionType : <code>&#x27;graph&#x27;</code> \| <code>&#x27;db&#x27;</code> \| <code>&#x27;clone&#x27;</code> \| <code>&#x27;triples&#x27;</code> \| <code>&#x27;woql&#x27;</code> \| <code>&#x27;frame&#x27;</code> \| <code>&#x27;fetch&#x27;</code> \| <code>&#x27;pull&#x27;</code> \| <code>&#x27;rebase&#x27;</code> \| <code>&#x27;csv&#x27;</code> \| <code>&#x27;branch&#x27;</code> \| <code>&#x27;reset&#x27;</code> \| <code>&#x27;push&#x27;</code> \| <code>&#x27;squash&#x27;</code>
112+
113+
## ParamsObj
114+
#### ParamsObj : <code>Object</code>
115+
**Properties**
116+
117+
| Name | Type | Description |
118+
| --- | --- | --- |
119+
| [key] | <code>string</code> | api key for basic auth |
120+
| [user] | <code>string</code> | basic auth user id |
121+
| [organization] | <code>string</code> | set organization to this id |
122+
| [db] | <code>string</code> | set cursor to this db |
123+
| [repo] | [<code>RepoType</code>](#RepoType) \| <code>string</code> | set cursor to this repo |
124+
| [branch] | <code>string</code> | set branch to this id |
125+
| [ref] | <code>string</code> | set commit ref |
126+
| [jwt] | <code>string</code> | jwt token |
127+
| [jwt_user] | <code>string</code> | jwt user id |
128+
| [default_branch_id] | <code>string</code> | set the default branch id |
129+
130+
131+
## RolesObj
132+
#### RolesObj : <code>Object</code>
133+
**Properties**
134+
135+
| Name | Type | Description |
136+
| --- | --- | --- |
137+
| agent_name | <code>string</code> | the Authorization connection's type |
138+
| [database_name] | <code>string</code> | the user id | I don't need the user with the jwt token |
139+
| [organization_name] | <code>string</code> | the connection key |
140+
| [actions] | <code>array</code> | list of roles |
141+
| [invitation] | <code>string</code> | - |
142+
143+
144+
## RepoType
145+
#### RepoType : <code>&quot;local&quot;</code> \| <code>&quot;remote&quot;</code>
146+
147+
## DbDetails
148+
#### DbDetails : <code>Object</code>
149+
**Properties**
150+
151+
| Name | Type | Description |
152+
| --- | --- | --- |
153+
| [organization] | <code>string</code> | the db organization id |
154+
| id | <code>string</code> | The database identification name |
155+
| label | <code>string</code> | "Textual DB Name" |
156+
| [comment] | <code>string</code> | "Text description of DB" |
157+
| [public] | <code>boolean</code> | |
158+
| [icon] | <code>string</code> | The database's icon |
159+
| [prefixes] | <code>object</code> | {scm: "http://url.to.use/for/scm", doc: "http://url.to.use/for/doc"} |
160+
| [schema] | <code>boolean</code> | if set to true, a schema graph will be created |
161+
162+
163+
## RemoteRepoDetails
164+
#### RemoteRepoDetails : <code>Object</code>
165+
{remote: "origin", "remote_branch": "main", "author": "admin", "message": "message"}
166+
167+
**Properties**
168+
169+
| Name | Type | Description |
170+
| --- | --- | --- |
171+
| [remote] | <code>string</code> | remote server url |
172+
| remote_branch | <code>string</code> | remote branch name |
173+
| [author] | <code>string</code> | if it is undefined it get the current author |
174+
| [message] | <code>string</code> | the update commit message |
175+
176+
177+
## CloneSourceDetails
178+
#### CloneSourceDetails : <code>Object</code>
179+
**Properties**
180+
181+
| Name | Type | Description |
182+
| --- | --- | --- |
183+
| remote_url | <code>string</code> | the remote db source url |
184+
| [label] | <code>string</code> | |
185+
| [comment] | <code>string</code> | |
186+

0 commit comments

Comments
 (0)