Skip to content

DOC-12282/release/7.2/Feedback-on-Search-Functions #3785

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

Open
wants to merge 4 commits into
base: release/7.2
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
47 changes: 0 additions & 47 deletions modules/fts/pages/fts-advanced.adoc

This file was deleted.

52 changes: 0 additions & 52 deletions modules/fts/pages/fts-analyzers-search-functions.adoc

This file was deleted.

11 changes: 0 additions & 11 deletions modules/fts/pages/fts-clone-index.adoc

This file was deleted.

51 changes: 51 additions & 0 deletions modules/fts/pages/fts-creating-index-from-UI-classic-editor.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,54 @@ include::partial$fts-user-prerequisites-common.adoc[]
== Quickstart via the Classic Editor

include::partial$fts-creating-indexes-common.adoc[]

image::fts-index-name-and-bucket.png[,450,align=left]

This is all you need to specify in order to create a basic index for test and development. No further configuration is required. Note, however, that such default indexing is not recommended for production environments since it creates indexes that may be unnecessarily large, and therefore insufficiently performant.

To save your index, left-click on the *Create Index* button near the bottom of the screen:

At this point, you are returned to the Full Text Search screen. In the Full Text Indexes panel, a row now appears for the index you have created. When left-clicked on, the row opens as follows:

image::fts-new-index-progress.png[,750,align=left]

NOTE: The percentage figure appears under the indexing progress column and is incremented in correspondence with the build-progress of the index. When 100% is reached, the index build is complete. However, search queries will be allowed as soon as the index is created, meaning partial results can be expected until the index build is complete.

Once the new index has been built, it supports Full Text Searches performed by all available means: the Console UI, the Couchbase REST API, and the Couchbase SDK.

The indexing progress is determined as `index_doc_count` / `source_doc_count`.

The `index_doc_count` is retrieved from the search endpoint. The `source_doc_count` is retrieved from a KV endpoint.

NOTE: If one or more of the nodes in the cluster running data service goes down and/or are failed over, indexing progress may show a value > 100% as the source_doc_count for the bucket would be missing some active partitions.

[#using-non-default-scope-collections]

== Using Non-Default Scope/Collection

Search indexes can be created on non-default scopes and collections, providing the ability to make an index more personal or use case specific and also resulting in a lower index size.

image::fts-select-non-default-scope-collections.png[,250,align=left]

Select this checkbox if you want the index to stream data from a non-default scope and/or non-default collection(s) on the source bucket.

To specify the non-default scope, click the scope drop-down list and select the required scope.

image::fts-non-default-scope-collections1.png[,400,align=left]

The Search service allows you to index as many collections as you want in a scope by using Type Mappings. For further details on creating an index on non-default collection(s), see xref::fts-type-mappings.adoc#Specifying-Type-Mapping-for-Collection[Specifying Type Mapping for Collection]
to review the wide range of available options for creating indexes appropriate for production environments, see xref:fts-creating-indexes.adoc[Creating Indexes].

NOTE: An index can be created only on a single scope. However, within a scope any number of collections can be indexed.

[#using-the-index-definition-preview]
== Using the Index Definition Preview

The _Index Definition Preview_ appears to the right-hand side of the *Edit Index* screen.
Following index-definition, the upper portion may appear as follows:

[#fts_index_definition_preview]
image::fts-index-definition-preview.png[,300,align=left]

The preview consists of the JSON document that describes the current index configuration, as created by means of the user interface.
By left-clicking on the [.ui]*copy to clipboard* tab, the definition can be saved.

This file was deleted.

This file was deleted.

6 changes: 3 additions & 3 deletions modules/fts/pages/fts-custom-filters.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -89,15 +89,15 @@ The following interactive fields are provided:

* *Name*: A suitable, user-defined name for the new token filter.

* *Type*: The type of post-processing to be provided by the new token filter. The default is `length`, which creates tokens whose minimum number of characters is specified by the integer provided in the *Min* field and whose maximum by the integer provided in the *Max*.
* *Type*: The type of post-processing to be provided by the new token filter. The default is `length`, which creates tokens with a minimum number of characters is specified by the integer provided in the *Min* field and with a maximum by the integer provided in the *Max*.
Additional post-processing types can be selected from the pull-down menu at the right of the field:
+
[#fts_custom_filters_token_filter_types]
image::fts-custom-filters-token-filter-types.png[,420,align=left]
+
NOTE: The type-selection determines which interactive fields appear in the *Custom Token Filter* dialog, following *Name* and *Type*.
The pull-down menu displays a list of available types.
For descriptions, see the section xref:fts-analyzers.adoc#Token-Filters[Token Filters], on the page xref:fts-analyzers.adoc#Understanding-Analyzers[Understanding Analyzers].
For descriptions, see the section xref:fts-index-analyzers.adoc#Token-Filters[Token Filters], on the page xref:fts-index-analyzers.adoc#Understanding-Analyzers[Understanding Analyzers].

* *Min*: The minimum length of the token, in characters.
Note that this interactive field is displayed for the `length` type, and may not appear, or be replaced, when other types are specified.
Expand Down Expand Up @@ -142,4 +142,4 @@ To remove a word, select the word within the *Words* panel and left-click on the
To save, left-click on [.ui]*Save*. The new word list is displayed on its own row, with options for further editing and deleting:

[#fts_custom_filters_panel_new_word_list]
image::fts-custom-filters-panel-new-word-list.png[,700,align=left]
image::fts-custom-filters-panel-new-word-list.png[,700,align=left]
11 changes: 0 additions & 11 deletions modules/fts/pages/fts-delete-index.adoc

This file was deleted.

13 changes: 0 additions & 13 deletions modules/fts/pages/fts-edit-index.adoc

This file was deleted.

20 changes: 0 additions & 20 deletions modules/fts/pages/fts-editing-cloning-full-text-indexes.adoc

This file was deleted.

97 changes: 0 additions & 97 deletions modules/fts/pages/fts-flex.adoc

This file was deleted.

This file was deleted.

Loading