File tree Expand file tree Collapse file tree 2 files changed +17
-5
lines changed Expand file tree Collapse file tree 2 files changed +17
-5
lines changed Original file line number Diff line number Diff line change 1
1
2
2
# TypeDef
3
3
##### TypeDef
4
- Type definations
4
+ Type definitions
5
5
6
6
7
7
## DocParamsGet
@@ -150,6 +150,20 @@ the DELETE document interface query parameters
150
150
| [ schema] | <code >boolean</code > | if set to true, a schema graph will be created |
151
151
152
152
153
+ ## DbDoc
154
+ ##### DbDoc: ` Object `
155
+ ** Properties**
156
+
157
+ | Name | Type | Description |
158
+ | --- | --- | --- |
159
+ | id | <code >string</code > | "Database ID" |
160
+ | [ label] | <code >string</code > | "Textual DB Name" |
161
+ | [ comment] | <code >string</code > | "Text description of DB" |
162
+ | [ organization] | <code >string</code > | "Organization to which the db belongs" |
163
+ | [ public] | <code >boolean</code > | - |
164
+ | [ schema] | <code >boolean</code > | if set to true, a schema graph will be created |
165
+
166
+
153
167
## RemoteRepoDetails
154
168
##### RemoteRepoDetails: ` Object `
155
169
{remote: "origin", "remote_branch": "main", "author":
Original file line number Diff line number Diff line change @@ -550,16 +550,14 @@ const branch_resource = client.resource("branch")
550
550
` ` `
551
551
552
552
## updateDatabase
553
- ##### woqlClient.updateDatabase(dbId, dbDetails, [orgId] ) ⇒ <code>Promise</code>
553
+ ##### woqlClient.updateDatabase(dbDoc ) ⇒ <code>Promise</code>
554
554
Update a database in TerminusDB server
555
555
556
556
**Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.
557
557
558
558
| Param | Type | Description |
559
559
| --- | --- | --- |
560
- | dbId | <code>string</code> | The id of the database to be updated |
561
- | dbDetails | <code>typedef.DbDetails</code> | object containing details about the database to be updated |
562
- | [orgId] | <code>string</code> | optional organization id - if absent default local organization id is used |
560
+ | dbDoc | <code>typedef.DbDoc</code> | object containing details about the database to be updated |
563
561
564
562
**Example**
565
563
` ` ` javascript
You can’t perform that action at this time.
0 commit comments