fix: #78 updated woql schema #79

Neelterminusdb · 2021-11-30T10:29:04Z

Signed-off-by: NeelParihar neel@terminusdb.com

Signed-off-by: NeelParihar <neel@terminusdb.com>

Neelterminusdb · 2021-11-30T10:32:31Z

You can probably just delete the commented code.

We should add DeleteDocument and UpdateDocument as well - I can help if you have any questions.

Oh okay will do that and let you know if i need anything

Neelterminusdb · 2021-11-30T11:21:02Z

Should i keep the name of the functions as delete_document or delete_objects @GavinMendelGleason

spl · 2021-11-30T11:27:00Z

Should is keep the name of the functions as delete_document or delete_objects

Can you create new names and keep the old ones for backwards-compatibility? The new ones should have the documentation (if there is any), but the old ones don't need to go.

spl · 2021-11-30T11:29:39Z

Would this work?

WOQLQuery.prototype.read_document = function ... {
  ...
}

WOQLQuery.prototype.read_object = WOQLQuery.prototype.read_document

Neelterminusdb · 2021-11-30T11:30:34Z

I dont think there is already a function in WOQL for delete document and update document, so i dont think it will create any type of problem

Neelterminusdb · 2021-11-30T11:31:38Z

Would this work?

WOQLQuery.prototype.read_document = function ... {
  ...
}

WOQLQuery.prototype.read_object = WOQLQuery.prototype.read_document

Oh you are talking about the read_object yes it is already there but do we need to rename it as well ?

Neelterminusdb · 2021-11-30T11:35:28Z

I see that in #75 gavin has referenced it as delete_document so i will go with this name for now

spl · 2021-11-30T11:42:23Z

Oh you are talking about the read_object yes it is already there but do we need to rename it as well ?

I don't know. I'm always for consistent naming, and I see read_object throughout the code here and ReadDocument in the schema, so, since we're changing things, it makes sense to me to rename, as long as we're not also breaking things.

spl · 2021-11-30T11:43:33Z

I see that in #75 gavin has referenced it as delete_document so i will go with this name for now

Yep, so you can fix #75 and #78 in this PR.

Neelterminusdb · 2021-11-30T11:45:07Z

Oh okay i will create a new function called as read_document and depreciate the old one in documentation

spl · 2021-12-01T08:02:38Z

See #78 (comment).

Signed-off-by: NeelParihar <neel@terminusdb.com>

spl

I don't suppose we have any tests for things like this, do we? Otherwise, there are just a few simple changes.

spl · 2021-12-03T12:27:35Z

lib/query/woqlQuery.js

 }

+WOQLQuery.prototype.read_document = function(IRI, OutputVar, Format) {
+    //if (IRI && IRI == 'args') return ['document_uri', 'document']


Remove comment.

Actually that was already commented in the earlier read_object funtion i thought there will be a reason it is like that, i will uncomment it

spl · 2021-12-03T12:27:42Z

lib/query/woqlQuery.js

+}
+
+WOQLQuery.prototype.insert_document = function(docjson, IRI) {
+    //if (IRI && IRI == 'args') return ['document_uri', 'document']


Remove comment.

spl · 2021-12-03T12:30:54Z

lib/query/woqlQuery.js

+    this.cursor['@type'] = 'InsertDocument'
+    if(typeof IRI !== 'undefined') this.cursor['identifier'] = this.cleanNodeValue(IRI)
+
+    let doc;


Instead of declaring doc here, can you just do the assignment to this.cursor['document'] directly in each block of the if/else?

Ohh didn't look it that way

spl · 2021-12-03T12:31:01Z

lib/query/woqlQuery.js

+}
+
+WOQLQuery.prototype.update_document = function(docjson, IRI) {
+    //if (IRI && IRI == 'args') return ['document_uri', 'document']


Remove comment.

spl · 2021-12-03T12:31:37Z

lib/query/woqlQuery.js

+    this.cursor['@type'] = 'UpdateDocument'
+    if(typeof IRI !== 'undefined') this.cursor['identifier'] = this.cleanNodeValue(IRI)
+
+    let doc;


See comment above about assigning this.cursor['document'] directly.

spl · 2021-12-03T12:31:51Z

lib/query/woqlQuery.js

+}
+
+WOQLQuery.prototype.delete_document = function(IRI) {
+    //if (IRI && IRI == 'args') return ['document_uri', 'document']


Remove comment.

spl · 2021-12-03T12:38:21Z

lib/query/woqlQuery.js

    return this.wform(Format)
 }

+WOQLQuery.prototype.read_document = function(IRI, OutputVar, Format) {


The definition of WOQLQuery.prototype.read_object no longer works, so, in the goal of keeping things working and compatible, can you delete the definition and add this?

WOQLQuery.prototype.read_object = WOQLQuery.prototype.read_document

For clarity, that should probably go after the WOQLQuery.prototype.read_document definition.

Rather than adding this here i think it would be better if i add this

return new WOQLQuery().read_document(IRI, output, formatObj)

in here

terminusdb-client-js/lib/woql.js

Line 104 in 6d56272

return new WOQLQuery().read_object(IRI, output, formatObj)

Okay, but isn't WOQLQuery.prototype.read_object still wrong? We don't have ReadObject anymore.

Yup so should i just remove it ? 😅

Yep, just remove it. I confirmed with @Francesca-Bit that it's no longer accessible.

spl · 2021-12-03T12:41:12Z

lib/woql.js


 /**
- * Read a node identified by an IRI as a JSON-LD document
+ * [Instead use read_document] Read a node identified by an IRI as a JSON-LD document


Rather than add this, can you add a message to @deprecated?

I have added it but it was not adding the text after the @deprecated so i added the tag and wrote the line here

I see! Fine then.

I learned from @Francesca-Bit that you can @link another name. So I suggest removing all documentation for read_object and adding something like this:

/** * Use {@link WOQL.read_document} instead. * @deprecated */

Just check the link to make sure it's correct. I haven't tested it.

spl · 2021-12-03T12:44:22Z

lib/woql.js

+/**
+ * Insert a document in the graph.
+ * @param {object} docjson -  The document to insert. Must either have an '@id' or have a class specified key.
+ * @param {string} [IRI] - An optional returned identifier specifying the documentation location.


An optional identifier specifying the document location. I realize that this is wrong in the woql.json.

spl · 2021-12-03T12:44:29Z

lib/woql.js

+/**
+ * Update a document identified by an IRI
+ * @param {object} docjson -  The document to update. Must either have an '@id' or have a class specified key.
+ * @param {string} [IRI] - An optional returned identifier specifying the documentation location.


An optional identifier specifying the document location.

Signed-off-by: NeelParihar <neel@terminusdb.com>

spl · 2021-12-06T11:16:04Z

lib/woql.js


 /**
- * Read a node identified by an IRI as a JSON-LD document
+ * [Instead use read_document] Read a node identified by an IRI as a JSON-LD document


I learned from @Francesca-Bit that you can @link another name. So I suggest removing all documentation for read_object and adding something like this:

/** * Use {@link WOQL.read_document} instead. * @deprecated */

Just check the link to make sure it's correct. I haven't tested it.

Signed-off-by: NeelParihar <neel@terminusdb.com>

spl

Thanks for adding tests!

Neelterminusdb · 2021-12-07T16:06:52Z

Thank you so much @spl for the detailed review of the PR 😄

fix: #78 updated woql schema

14b4c22

Signed-off-by: NeelParihar <neel@terminusdb.com>

Neelterminusdb requested review from GavinMendelGleason and spl November 30, 2021 10:29

Neelterminusdb marked this pull request as draft November 30, 2021 15:22

Neelterminusdb added 2 commits December 2, 2021 12:29

added new document modification functions for WOQL

b962e0b

Signed-off-by: NeelParihar <neel@terminusdb.com>

updated ready_object

6d56272

Signed-off-by: NeelParihar <neel@terminusdb.com>

Neelterminusdb marked this pull request as ready for review December 2, 2021 07:03

spl suggested changes Dec 3, 2021

View reviewed changes

Neelterminusdb added 3 commits December 5, 2021 12:35

updated schema documentation

ca9b5de

Signed-off-by: NeelParihar <neel@terminusdb.com>

updated document schma logic

393d183

Signed-off-by: NeelParihar <neel@terminusdb.com>

added tests for document woql schema queries

6d99597

Signed-off-by: NeelParihar <neel@terminusdb.com>

Neelterminusdb requested a review from spl December 5, 2021 07:37

spl suggested changes Dec 6, 2021

View reviewed changes

updated documentation for read_object

67174c2

Signed-off-by: NeelParihar <neel@terminusdb.com>

Neelterminusdb requested a review from spl December 6, 2021 12:37

spl added 4 commits December 6, 2021 19:45

Minor fixes

2873cc3

Remove extra WOQL.read_object

df00759

Merge branch 'main' into updateWOQLSchema

2a80a26

Fix space

570098e

spl approved these changes Dec 6, 2021

View reviewed changes

spl merged commit 42dc6f6 into main Dec 6, 2021

spl deleted the updateWOQLSchema branch December 6, 2021 17:57

fix: #78 updated woql schema #79

fix: #78 updated woql schema #79

Uh oh!

Conversation

Neelterminusdb commented Nov 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Neelterminusdb commented Nov 30, 2021

Uh oh!

Neelterminusdb commented Nov 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

spl commented Nov 30, 2021

Uh oh!

spl commented Nov 30, 2021

Uh oh!

Neelterminusdb commented Nov 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Neelterminusdb commented Nov 30, 2021

Uh oh!

Neelterminusdb commented Nov 30, 2021

Uh oh!

spl commented Nov 30, 2021

Uh oh!

spl commented Nov 30, 2021

Uh oh!

Neelterminusdb commented Nov 30, 2021

Uh oh!

spl commented Dec 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

spl left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Neelterminusdb Dec 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Neelterminusdb Dec 4, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Neelterminusdb Dec 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

spl Dec 6, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Neelterminusdb commented Nov 30, 2021 •

edited

Loading

Neelterminusdb commented Nov 30, 2021 •

edited

Loading

Neelterminusdb commented Nov 30, 2021 •

edited

Loading

spl commented Dec 1, 2021 •

edited

Loading

Neelterminusdb Dec 3, 2021 •

edited

Loading

Neelterminusdb Dec 4, 2021 •

edited

Loading

Neelterminusdb Dec 3, 2021 •

edited

Loading

spl Dec 6, 2021 •

edited

Loading

spl Dec 6, 2021 •

edited

Loading