Skip to content

added create query parameter for update document #189

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 2 commits into from
May 13, 2022
Merged

added create query parameter for update document #189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8d22d7
added create query parameter for update document
Neelterminusdb May 13, 2022
96bfa82
Apply docs changes
Neelterminusdb May 13, 2022
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
3 changes: 2 additions & 1 deletion docs/api/woqlclient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -856,7 +856,7 @@ const response1 = await client.getDocument({"graph_type":"schema","as_list":true
```

## updateDocument
##### woqlClient.updateDocument(json, [params], [dbId], [message], [lastDataVersion], [getDataVersion]) ⇒ <code>Promise</code>
##### woqlClient.updateDocument(json, [params], [dbId], [message], [lastDataVersion], [getDataVersion], [create]) ⇒ <code>Promise</code>
**Returns**: <code>Promise</code> - A promise that returns the call response object or object having *result*
and *dataVersion* object if ***getDataVersion*** parameter is true, or an Error if rejected.

Expand All @@ -868,6 +868,7 @@ and *dataVersion* object if ***getDataVersion*** parameter is true, or an Error
| [message] | <code>\*</code> | the update commit message |
| [lastDataVersion] | <code>string</code> | the last data version tracking id. |
| [getDataVersion] | <code>boolean</code> | If true the function will return object having result and dataVersion. |
| [create] | <code>boolean</code> | If true, the function will create a new document if it doesn't exist. |

**Example**
```javascript
Expand Down
4 changes: 3 additions & 1 deletion lib/woqlClient.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1150,6 +1150,7 @@ WOQLClient.prototype.getDocument = function (params, dbId, branch, lastDataVersi
* @param {string} [lastDataVersion] the last data version tracking id.
* @param {boolean} [getDataVersion] If true the function will return object having result
* and dataVersion.
* @param {boolean} [create] If true, the function will create a new document if it doesn't exist.
* @returns {Promise} A promise that returns the call response object or object having *result*
* and *dataVersion* object if ***getDataVersion*** parameter is true, or an Error if rejected.
* @example
Expand Down Expand Up @@ -1210,10 +1211,11 @@ WOQLClient.prototype.getDocument = function (params, dbId, branch, lastDataVersi
);
*/

WOQLClient.prototype.updateDocument = function (json, params, dbId, message = 'update document', lastDataVersion = '', getDataVersion = false, compress = false) {
WOQLClient.prototype.updateDocument = function (json, params, dbId, message = 'update document', lastDataVersion = '', getDataVersion = false, compress = false, create = false) {
const docParams = params || {};
docParams.author = this.author();
docParams.message = message;
docParams.create = create;
if (dbId) {
this.db(dbId);
}
Expand Down