Story #15380

Document that @@ is deprecated (and doesn't index all filenames)

Added by Tom Morris 3 months ago. Updated 2 months ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
-
Target version:
Start date:
07/01/2019
Due date:
% Done:

100%

Estimated time:
(Total: 0.00 h)
Story points:
-

Subtasks

Task #15386: ReviewResolvedPeter Amstutz

Associated revisions

Revision 917c3ca2
Added by Eric Biagiotti 2 months ago

Merge branch '15380-full-text-search-docs'

refs #15380

Arvados-DCO-1.1-Signed-off-by: Eric Biagiotti <>

History

#1 Updated by Eric Biagiotti 3 months ago

  • Assigned To set to Eric Biagiotti

#2 Updated by Eric Biagiotti 3 months ago

  • Status changed from New to In Progress

#3 Updated by Eric Biagiotti 3 months ago

Unless I am missing it, it doesn't look like we document @@ anywhere in the documentation. The best place I see to write a section about full text search is here: https://doc.arvados.org/sdk/cli/reference.html.

I can write up how to use full text search with ilike and %%, but I'm not sure it makes sense to add mention of @@ since we are deprecating it.

Also, if we are officially deprecating @@ should we switch the text search of workbench?

#4 Updated by Peter Amstutz 3 months ago

Eric Biagiotti wrote:

Unless I am missing it, it doesn't look like we document @@ anywhere in the documentation. The best place I see to write a section about full text search is here: https://doc.arvados.org/sdk/cli/reference.html.

That's the command line client. You could include a discussion of search but where it needs to go is the generic API documentation which is here:

https://doc.arvados.org/v1.4/api/methods.html

I can write up how to use full text search with ilike and %%, but I'm not sure it makes sense to add mention of @@ since we are deprecating it.

I agree.

Also, if we are officially deprecating @@ should we switch the text search of workbench?

You mean workbench1? Probably, yes.

#5 Updated by Eric Biagiotti 3 months ago

Latest at b2ce5b37b621a38ddeb958daaec027d6fefd7213

Also added an issue https://dev.arvados.org/issues/15430 for deprecating @@ and a related issue for Workbench 1.

#6 Updated by Peter Amstutz 3 months ago

Eric Biagiotti wrote:

Latest at b2ce5b37b621a38ddeb958daaec027d6fefd7213

Also added an issue https://dev.arvados.org/issues/15430 for deprecating @@ and a related issue for Workbench 1.

Instead of "text search" maybe call it "substring search" ?

Clarify that client can use "like" to pattern match individual columns, it just isn't indexed.

Clarify this is the recommended way to do keyword and filename search across the whole database.

Clarify that it only supports exact matches, and results an unranked (they are returned in the order specified by the "order" clause).

#7 Updated by Eric Biagiotti 3 months ago

  • Target version changed from 2019-07-03 Sprint to 2019-07-17 Sprint

#8 Updated by Eric Biagiotti 3 months ago

Latest at e87851be1b0e2a14d71aa31a73e0227fa10b799e

Peter Amstutz wrote:

Instead of "text search" maybe call it "substring search" ?

I agree, I updated it.

Clarify that client can use "like" to pattern match individual columns, it just isn't indexed.

This is described on the same page here: https://doc.arvados.org/v1.4/api/methods.html#filters. I think it is clear that you can match per column/attribute, but I can add more detail in the new section if you want.

Clarify this is the recommended way to do keyword and filename search across the whole database.

Clarify that it only supports exact matches, and results an unranked (they are returned in the order specified by the "order" clause).

Done.

#9 Updated by Peter Amstutz 2 months ago

Eric Biagiotti wrote:

Latest at e87851be1b0e2a14d71aa31a73e0227fa10b799e

LGTM.

#10 Updated by Eric Biagiotti 2 months ago

  • Status changed from In Progress to Resolved

Also available in: Atom PDF