Skip to content

minor xref fixes for fts #2493

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.

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 4 commits into from
Feb 24, 2022
Merged

minor xref fixes for fts #2493

merged 4 commits into from
Feb 24, 2022

Conversation

jon-strabala
Copy link
Contributor

bad syntax extra fts-
nav.adoc needs to be xref:fts:fts-cluster-options.adoc

update dead reference from
xref:fts:fts-response-object-schema.adoc#request[maximum number of full text search results]
to
xref:fts:fts-advanced-settings-bleveMaxResultWindow.adoc[bleveMaxResultWindow]
Copy link
Contributor Author

@jon-strabala jon-strabala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@abhinavdangeti can you pay close attention to the change in searchfun.adoc

@@ -142,7 +142,7 @@ For more details, refer to xref:fts:fts-sorting.adoc[Sorting Query Results].

[NOTE]
====
When specifying a complete full text search request with the N1QL SEARCH() function, if the value of the `size` parameter is greater than the xref:fts:fts-response-object-schema.adoc#request[maximum number of full text search results], the query ignores the `size` parameter and returns all matching results.
When specifying a complete full text search request with the N1QL SEARCH() function, if the value of the `size` parameter is greater than the xref:fts:fts-advanced-settings-bleveMaxResultWindow.adoc[bleveMaxResultWindow], the query ignores the `size` parameter and returns all matching results.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not entirely accurate.

  • If size/from (pagination) settings aren't set, the search index will "stream" all qualifying results to N1QL which can perform further filtering.
  • If size/limit, from/offset are set within the search request within the SEARCH function, FTS handles the pagination.
  • N1QL can hand down LIMIT/OFFSET settings to FTS. If this limit+offset <= bleveMaxResultWindow - then the FTS index is deemed pageable and N1QL hands down these settings to FTS. If not, then FTS will stream results to N1QL and N1QL will be responsible for pagination and ordering.

I'll let you fix the content here based on the above.

As per Abhinav corrections
@@ -243,7 +243,7 @@
*** xref:fts:fts-architecture-scatter-gather.adoc[Scatter Gather]
*** xref:fts:fts-architecture-ports-used.adoc[Ports Used By FTS]
*** xref:fts:fts-rebalance-failover.adoc[Rebalance/Failover]
** xref:fts:fts-cluster-operations.adoc[Cluster Level Options]
** xref:fts:fts-cluster-options.adoc[Cluster Level Options]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you're doing this, you'll be breaking the link without updating the adoc from fts-cluster-operations to fts-cluster-options

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah nevermind, I was on an older fork of release/7.0.

@@ -243,7 +243,7 @@
*** xref:fts:fts-architecture-scatter-gather.adoc[Scatter Gather]
*** xref:fts:fts-architecture-ports-used.adoc[Ports Used By FTS]
*** xref:fts:fts-rebalance-failover.adoc[Rebalance/Failover]
** xref:fts:fts-cluster-operations.adoc[Cluster Level Options]
** xref:fts:fts-cluster-options.adoc[Cluster Level Options]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah nevermind, I was on an older fork of release/7.0.

@jon-strabala jon-strabala merged commit 1f26a9a into couchbase:release/7.0 Feb 24, 2022
RayOffiah pushed a commit that referenced this pull request Feb 21, 2025
* fix syntax error in xref

* fix xref to fts-cluster-options.adoc

* resolve dead fts link to bleveMaxResultWindow

update dead reference from
xref:fts:fts-response-object-schema.adoc#request[maximum number of full text search results]
to
xref:fts:fts-advanced-settings-bleveMaxResultWindow.adoc[bleveMaxResultWindow]

* informational update

As per Abhinav corrections
RayOffiah pushed a commit that referenced this pull request Feb 21, 2025
* fix syntax error in xref

* fix xref to fts-cluster-options.adoc

* resolve dead fts link to bleveMaxResultWindow

update dead reference from
xref:fts:fts-response-object-schema.adoc#request[maximum number of full text search results]
to
xref:fts:fts-advanced-settings-bleveMaxResultWindow.adoc[bleveMaxResultWindow]

* informational update

As per Abhinav corrections

(cherry picked from commit 1f26a9a)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants