Skip to content

JS-Reference-Updates-1672834269 #202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 4, 2023
Merged

JS-Reference-Updates-1672834269 #202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion guides/reference-guides/javascript-client-reference/typedef.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# TypeDef
##### TypeDef
Type definations
Type definitions


## DocParamsGet
Expand Down Expand Up @@ -150,6 +150,20 @@ the DELETE document interface query parameters
| [schema] | <code>boolean</code> | if set to true, a schema graph will be created |


## DbDoc
##### DbDoc: ` Object`
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| id | <code>string</code> | "Database ID" |
| [label] | <code>string</code> | "Textual DB Name" |
| [comment] | <code>string</code> | "Text description of DB" |
| [organization] | <code>string</code> | "Organization to which the db belongs" |
| [public] | <code>boolean</code> | - |
| [schema] | <code>boolean</code> | if set to true, a schema graph will be created |


## RemoteRepoDetails
##### RemoteRepoDetails: ` Object`
{remote: "origin", "remote_branch": "main", "author":
Expand Down
6 changes: 2 additions & 4 deletions guides/reference-guides/javascript-client-reference/woqlclient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -550,16 +550,14 @@ const branch_resource = client.resource("branch")
```

## updateDatabase
##### woqlClient.updateDatabase(dbId, dbDetails, [orgId]) ⇒ <code>Promise</code>
##### woqlClient.updateDatabase(dbDoc) ⇒ <code>Promise</code>
Update a database in TerminusDB server

**Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.

| Param | Type | Description |
| --- | --- | --- |
| dbId | <code>string</code> | The id of the database to be updated |
| dbDetails | <code>typedef.DbDetails</code> | object containing details about the database to be updated |
| [orgId] | <code>string</code> | optional organization id - if absent default local organization id is used |
| dbDoc | <code>typedef.DbDoc</code> | object containing details about the database to be updated |

**Example**
```javascript
Expand Down