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 11
22# TypeDef
33##### TypeDef
4- Type definations
4+ Type definitions
55
66
77## DocParamsGet
@@ -150,6 +150,20 @@ the DELETE document interface query parameters
150150| [ schema] | <code >boolean</code > | if set to true, a schema graph will be created |
151151
152152
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+
153167## RemoteRepoDetails
154168##### RemoteRepoDetails: ` Object `
155169{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")
550550` ` `
551551
552552## updateDatabase
553- ##### woqlClient.updateDatabase(dbId, dbDetails, [orgId] ) ⇒ <code>Promise</code>
553+ ##### woqlClient.updateDatabase(dbDoc ) ⇒ <code>Promise</code>
554554Update a database in TerminusDB server
555555
556556**Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.
557557
558558| Param | Type | Description |
559559| --- | --- | --- |
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 |
563561
564562**Example**
565563` ` ` javascript
You can’t perform that action at this time.
0 commit comments