Skip to content
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

Jump to bottom

RDoc-3052 Document breaking change for search query with wildcards #1919

Merged
merged 6 commits into from
Oct 14, 2024
Merged

RDoc-3052 Document breaking change for search query with wildcards #1919

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a07b9fc
RDoc-3052 small text fixes
Danielle9897 Sep 25, 2024
435e03a
RDoc-3052 The breaking changes page for 6.0
Danielle9897 Sep 25, 2024
60f972c
RDoc-3052 Add text & examples to the Full-Text Search page (C#)
Danielle9897 Oct 6, 2024
3b21089
RDoc-3052 Add text & examples to the Full-Text Search page (Node.js)
Danielle9897 Oct 7, 2024
fea3001
RDoc-3052 small fix
Danielle9897 Oct 7, 2024
3616dca
RDoc-3052 fix review comments
Danielle9897 Oct 10, 2024
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
2 changes: 1 addition & 1 deletion ...tation/5.2/Raven.Documentation.Pages/indexes/querying/searching.dotnet.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

{NOTE: }

* __Prior to this article__, please refer to article [Full-Text search with dynamic queries](../../client-api/session/querying/text-search/full-text-search)
* __Prior to this article__, please refer to [Full-Text search with dynamic queries](../../client-api/session/querying/text-search/full-text-search)
to learn about the `Search` method.

* __All capabilities__ provided by `Search` with a dynamic query can also be used when querying a static-index.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/5.2/Raven.Documentation.Pages/indexes/querying/searching.js.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

{NOTE: }

* __Prior to this article__, please refer to article [Full-Text search with dynamic queries](../../client-api/session/querying/text-search/full-text-search)
* __Prior to this article__, please refer to [Full-Text search with dynamic queries](../../client-api/session/querying/text-search/full-text-search)
to learn about the `search` method.

* __All capabilities__ provided by `search` with a dynamic query can also be used when querying a static-index.
Expand Down
2 changes: 1 addition & 1 deletion ...tion/5.2/Raven.Documentation.Pages/indexes/querying/suggestions.dotnet.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

{NOTE: }

* Prior to this article, please refer to article [Query for Suggestions](../../client-api/session/querying/how-to-work-with-suggestions)
* Prior to this article, please refer to [Query for Suggestions](../../client-api/session/querying/how-to-work-with-suggestions)
for general knowledge about Suggestions, and for dynamic-queries examples.

* In addition to getting suggested terms when making a dynamic-query,
Expand Down
2 changes: 1 addition & 1 deletion ...entation/5.2/Raven.Documentation.Pages/indexes/querying/suggestions.js.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

{NOTE: }

* Prior to this article, please refer to article [Query for Suggestions](../../client-api/session/querying/how-to-work-with-suggestions)
* Prior to this article, please refer to [Query for Suggestions](../../client-api/session/querying/how-to-work-with-suggestions)
for general knowledge about Suggestions, and for dynamic-queries examples.

* In addition to getting suggested terms when making a dynamic-query,
Expand Down
6 changes: 3 additions & 3 deletions ...sharp/Raven.Documentation.Samples/ClientApi/Session/Querying/TextSearch/FullTextSearch.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -598,7 +598,7 @@ public async Task Examples()
#region fts_33
List<Employee> employees = session
.Query<Employee>()
// Use '*' to replace one ore more characters
// Use '*' to replace one or more characters
.Search(x => x.Notes, "art*")
.Search(x => x.Notes, "*logy")
.Search(x => x.Notes, "*mark*")
Expand All @@ -618,7 +618,7 @@ public async Task Examples()
#region fts_34
List<Employee> employees = await asyncSession
.Query<Employee>()
// Use '*' to replace one ore more characters
// Use '*' to replace one or more characters
.Search(x => x.Notes, "art*")
.Search(x => x.Notes, "*logy")
.Search(x => x.Notes, "*mark*")
Expand All @@ -638,7 +638,7 @@ public async Task Examples()
#region fts_35
List<Employee> employees = session.Advanced
.DocumentQuery<Employee>()
// Use '*' to replace one ore more characters
// Use '*' to replace one or more characters
.Search(x => x.Notes, "art*")
.Search(x => x.Notes, "*logy")
.Search(x => x.Notes, "*mark*")
Expand Down
5 changes: 2 additions & 3 deletions ...ion/5.4/Raven.Documentation.Pages/indexes/querying/highlighting.dotnet.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@
also request to get a list of text fragments that highlight the searched terms.

* This article provides examples of highlighting search results when querying a static-index.
Prior to reading this article, it is recommended to take a look at the
[Highlight search results](../../client-api/session/querying/text-search/highlight-query-results)
article for general knowledge about Highlighting and for dynamic-queries examples.
Prior to reading this article, please refer to [Highlight search results](../../client-api/session/querying/text-search/highlight-query-results)
for general knowledge about Highlighting and for dynamic-queries examples.

* To search and get fragments with highlighted terms when querying a static-index,
the index field on which you search must be configured for highlighting. See examples below.
Expand Down
5 changes: 2 additions & 3 deletions ...ntation/5.4/Raven.Documentation.Pages/indexes/querying/highlighting.js.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@
also request to get a list of text fragments that highlight the searched terms.

* This article provides examples of highlighting search results when querying a static-index.
Prior to reading this article, it is recommended to take a look at the
[Highlight search results](../../client-api/session/querying/text-search/highlight-query-results)
article for general knowledge about Highlighting and for dynamic-queries examples.
Prior to reading this article, please refer to [Highlight search results](../../client-api/session/querying/text-search/highlight-query-results)
for general knowledge about Highlighting and for dynamic-queries examples.

* To search and get fragments with highlighted terms when querying a static-index,
the index field on which you search must be configured for highlighting. See examples below.
Expand Down
5 changes: 2 additions & 3 deletions ...ion/5.4/Raven.Documentation.Pages/indexes/querying/highlighting.python.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@
also request to get a list of text fragments that highlight the searched terms.

* This article provides examples of highlighting search results when querying a static-index.
Prior to reading this article, it is recommended to take a look at the
[Highlight search results](../../client-api/session/querying/text-search/highlight-query-results)
article for general knowledge about Highlighting and for dynamic-queries examples.
Prior to reading this article, please refer to [Highlight search results](../../client-api/session/querying/text-search/highlight-query-results)
for general knowledge about Highlighting and for dynamic-queries examples.

* To search and get fragments with highlighted terms when querying a static-index,
the index field on which you search must be configured for highlighting. See examples below.
Expand Down
3 changes: 1 addition & 2 deletions ...tion/5.4/Raven.Documentation.Pages/indexes/querying/projections.python.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@

* This article provides examples of projecting query results when querying a **static-index**.

* Prior to reading this article, it is recommended to take a look at the
[query results projection Overview](../../client-api/session/querying/how-to-project-query-results)
* Prior to reading this article, please refer to [query results projection overview](../../client-api/session/querying/how-to-project-query-results)
for general knowledge about Projections and for dynamic-queries examples.

* Projections can be applied using the `select_fields` and `select_fields_query_data` methods.
Expand Down
3 changes: 1 addition & 2 deletions ...tion/5.4/Raven.Documentation.Pages/indexes/querying/query-index.dotnet.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@

{NOTE: }

* Prior to reading this article, it is recommended to take a look at the
[Query Overview](../../client-api/session/querying/how-to-query).
* Prior to this article, it is recommended that you first read this [Query Overview](../../client-api/session/querying/how-to-query).

* For a basic indexes overview, see the [Indexes Overview](../../studio/database/indexes/indexes-overview).

Expand Down
5 changes: 2 additions & 3 deletions ...entation/5.4/Raven.Documentation.Pages/indexes/querying/query-index.js.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@

{NOTE: }

* Prior to reading this article, it is recommended to take a look at the
[Query Overview](../../client-api/session/querying/how-to-query).

* Prior to this article, it is recommended that you first read this [Query Overview](../../client-api/session/querying/how-to-query).

* For a basic indexes overview, see the [Indexes Overview](../../studio/database/indexes/indexes-overview).

---
Expand Down
5 changes: 2 additions & 3 deletions ...tion/5.4/Raven.Documentation.Pages/indexes/querying/query-index.python.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@

{NOTE: }

* Prior to reading this article, it is recommended to take a look at the
[Query Overview](../../client-api/session/querying/how-to-query).

* Prior to this article, it is recommended that you first read this [Query Overview](../../client-api/session/querying/how-to-query).

* For a basic indexes overview, see the [Indexes Overview](../../studio/database/indexes/indexes-overview).

---
Expand Down
4 changes: 1 addition & 3 deletions ...tation/5.4/Raven.Documentation.Pages/indexes/querying/searching.dotnet.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@

{NOTE: }

* Prior to reading this article, it is recommended to take a look at the
[Full-Text search with dynamic queries](../../client-api/session/querying/text-search/full-text-search)
article to learn about the `Search` method.
* Prior to this article, please refer to [Full-Text search with dynamic queries](../../client-api/session/querying/text-search/full-text-search) to learn about the `Search` method.

* **All capabilities** provided by `Search` with a dynamic query can also be used when querying a static-index.

Expand Down
5 changes: 2 additions & 3 deletions Documentation/5.4/Raven.Documentation.Pages/indexes/querying/searching.js.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@

{NOTE: }

* Prior to reading this article, it is recommended to take a look at the
[Full-Text search with dynamic queries](../../client-api/session/querying/text-search/full-text-search)
article to learn about the `search` method.
* Prior to reading this article, please refer to [full-Text search with dynamic queries](../../client-api/session/querying/text-search/full-text-search)
to learn about the `search` method.

* **All capabilities** provided by `search` with a dynamic query can also be used when querying a static-index.

Expand Down
5 changes: 2 additions & 3 deletions ...tation/5.4/Raven.Documentation.Pages/indexes/querying/searching.python.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@

{NOTE: }

* Prior to reading this article, it is recommended to take a look at the
[Full-Text search with dynamic queries](../../client-api/session/querying/text-search/full-text-search)
article to learn about the `search` method.
* Prior to reading this article, please refer to [full-Text search with dynamic queries](../../client-api/session/querying/text-search/full-text-search)
to learn about the `search` method.

* **All capabilities** provided by `search` with a dynamic query can also be used when querying a static-index.

Expand Down
5 changes: 2 additions & 3 deletions ...tion/5.4/Raven.Documentation.Pages/indexes/querying/suggestions.dotnet.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@

{NOTE: }

* Prior to reading this article, it is recommended to take a look at the
[Query for Suggestions](../../client-api/session/querying/how-to-work-with-suggestions)
article for general knowledge about Suggestions and for dynamic-queries examples.
* Prior to reading this article, please refer to [query for suggestions](../../client-api/session/querying/how-to-work-with-suggestions)
for general knowledge about Suggestions and for dynamic-queries examples.

* In addition to getting suggested terms when making a dynamic-query,
you can query for similar terms when querying an index.
Expand Down
5 changes: 2 additions & 3 deletions ...entation/5.4/Raven.Documentation.Pages/indexes/querying/suggestions.js.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@

{NOTE: }

* Prior to reading this article, it is recommended to take a look at the
[Query for Suggestions](../../client-api/session/querying/how-to-work-with-suggestions)
article for general knowledge about Suggestions and for dynamic-queries examples.
* Prior to reading this article, please refer to [query for suggestions](../../client-api/session/querying/how-to-work-with-suggestions)
for general knowledge about Suggestions and for dynamic-queries examples.

* In addition to getting suggested terms when making a dynamic-query,
you can query for similar terms when querying an index.
Expand Down
5 changes: 2 additions & 3 deletions ...tion/5.4/Raven.Documentation.Pages/indexes/querying/suggestions.python.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@

{NOTE: }

* Prior to reading this article, it is recommended to take a look at the
[Query for Suggestions](../../client-api/session/querying/how-to-work-with-suggestions)
article for general knowledge about Suggestions and for dynamic-queries examples.
* Prior to reading this article, please refer to [query for suggestions](../../client-api/session/querying/how-to-work-with-suggestions)
for general knowledge about Suggestions and for dynamic-queries examples.

* In addition to getting suggested terms when making a dynamic-query,
you can query for similar terms when querying an index.
Expand Down
6 changes: 3 additions & 3 deletions ...sharp/Raven.Documentation.Samples/ClientApi/Session/Querying/TextSearch/FullTextSearch.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -598,7 +598,7 @@ public async Task Examples()
#region fts_33
List<Employee> employees = session
.Query<Employee>()
// Use '*' to replace one ore more characters
// Use '*' to replace one or more characters
.Search(x => x.Notes, "art*")
.Search(x => x.Notes, "*logy")
.Search(x => x.Notes, "*mark*")
Expand All @@ -618,7 +618,7 @@ public async Task Examples()
#region fts_34
List<Employee> employees = await asyncSession
.Query<Employee>()
// Use '*' to replace one ore more characters
// Use '*' to replace one or more characters
.Search(x => x.Notes, "art*")
.Search(x => x.Notes, "*logy")
.Search(x => x.Notes, "*mark*")
Expand All @@ -638,7 +638,7 @@ public async Task Examples()
#region fts_35
List<Employee> employees = session.Advanced
.DocumentQuery<Employee>()
// Use '*' to replace one ore more characters
// Use '*' to replace one or more characters
.Search(x => x.Notes, "art*")
.Search(x => x.Notes, "*logy")
.Search(x => x.Notes, "*mark*")
Expand Down
3 changes: 1 addition & 2 deletions ...tion/6.0/Raven.Documentation.Pages/indexes/querying/projections.dotnet.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@

* This article provides examples of projecting query results when querying a **static-index**.

* Prior to reading this article, it is recommended to take a look at the
[query results projection Overview](../../client-api/session/querying/how-to-project-query-results)
* Prior to reading this article, please refer to [query results projection overview](../../client-api/session/querying/how-to-project-query-results)
for general knowledge about Projections and for dynamic-queries examples.

* In this page:
Expand Down
3 changes: 1 addition & 2 deletions ...entation/6.0/Raven.Documentation.Pages/indexes/querying/projections.js.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@

* This article provides examples of projecting query results when querying a **static-index**.

* Prior to reading this article, it is recommended to take a look at the
[query results projection Overview](../../client-api/session/querying/how-to-project-query-results)
* Prior to reading this article, please refer to [query results projection overview](../../client-api/session/querying/how-to-project-query-results)
for general knowledge about Projections and for dynamic-queries examples.

* In this page:
Expand Down
Loading
Loading