Skip to content
Merged
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
2 changes: 1 addition & 1 deletion docs/ai-integration/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"position": 10,
"position": 12,
"label": "AI Integration"
}
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ import CodeBlock from '@theme/CodeBlock';
* Even if your **default auto-index engine** is set to Lucene (via [Indexing.Auto.SearchEngineType](../../../server/configuration/indexing-configuration.mdx#indexingautosearchenginetype)),
performing a vector search using a dynamic query will create a new auto-index based on Corax.

* Normally, new dynamic queries extend existing [auto-indexes](../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index) if they require additional fields.
* Normally, new dynamic queries extend existing [auto-indexes](../../../querying/overview.mdx#queries-always-provide-results-using-an-index) if they require additional fields.
However, a dynamic query with a vector search will not extend an existing Lucene-based auto-index.

<Admonition type="note" title="">
Expand Down Expand Up @@ -1451,8 +1451,8 @@ and (vector.search(embedding.text(Name), $searchTerm, 0.75, 25))
* You can combine multiple vector search statements in the same query using logical operators.
This is useful when you want to retrieve documents that match more than one vector-based criterion.

* This can be done using [DocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery),
[RawQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) or raw [RQL](../../../client-api/session/querying/what-is-rql.mdx).
* This can be done using [DocumentQuery](../../../querying/overview.mdx#session-advanced-documentquery),
[RawQuery](../../../querying/overview.mdx#session-advanced-rawquery) or raw [RQL](../../../client-api/session/querying/what-is-rql.mdx).

* In the example below, the results will include companies that match one of two vector search conditions:
* Companies from European countries with a _Name_ similar to "snack"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ import CodeBlock from '@theme/CodeBlock';
* Even if your **default auto-index engine** is set to Lucene (via [Indexing.Auto.SearchEngineType](../../../server/configuration/indexing-configuration.mdx#indexingautosearchenginetype)),
performing a vector search using a dynamic query will create a new auto-index based on Corax.

* Normally, new dynamic queries extend existing [auto-indexes](../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index) if they require additional fields.
* Normally, new dynamic queries extend existing [auto-indexes](../../../querying/overview.mdx#queries-always-provide-results-using-an-index) if they require additional fields.
However, a dynamic query with a vector search will not extend an existing Lucene-based auto-index.

<Admonition type="note" title="">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ import CodeBlock from '@theme/CodeBlock';
* Even if your **default auto-index engine** is set to Lucene (via [Indexing.Auto.SearchEngineType](../../../server/configuration/indexing-configuration.mdx#indexingautosearchenginetype)),
performing a vector search using a dynamic query will create a new auto-index based on Corax.

* Normally, new dynamic queries extend existing [auto-indexes](../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index) if they require additional fields.
* Normally, new dynamic queries extend existing [auto-indexes](../../../querying/overview.mdx#queries-always-provide-results-using-an-index) if they require additional fields.
However, a dynamic query with a vector search will not extend an existing Lucene-based auto-index.

<Admonition type="note" title="">
Expand Down Expand Up @@ -850,7 +850,7 @@ and (vector.search(embedding.text(Name), $searchTerm, 0.75, 16))
* You can combine multiple vector search statements in the same query using logical operators.
This is useful when you want to retrieve documents that match more than one vector-based criterion.

* This can be done using [raw_query](../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) or raw [RQL](../../../client-api/session/querying/what-is-rql.mdx).
* This can be done using [raw_query](../../../querying/overview.mdx#session-advanced-rawquery) or raw [RQL](../../../client-api/session/querying/what-is-rql.mdx).

* In the example below, the results will include companies that match one of two vector search conditions:
* Companies from European countries with a _Name_ similar to "snack"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ import DataTypesForVectorSearchNodejs from './content/_data-types-for-vector-sea
- [Vector search using a dynamic query](../../ai-integration/vector-search/vector-search-using-dynamic-query)

### Querying
- [Query overview](../../client-api/session/querying/how-to-query)
- [Query overview](../../querying/overview)
- [Full-text search](../../client-api/session/querying/text-search/full-text-search)-
-->
2 changes: 1 addition & 1 deletion docs/client-api/commands/documents/_get-csharp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import CodeBlock from '@theme/CodeBlock';

* Use the low-level `GetDocumentsCommand` to retrieve documents from the database.

* To retrieve documents using a higher-level method, see [loading entities](../../../client-api/session/loading-entities.mdx) or [query for documents](../../../client-api/session/querying/how-to-query.mdx).
* To retrieve documents using a higher-level method, see [loading entities](../../../client-api/session/loading-entities.mdx) or [query for documents](../../../querying/overview.mdx).

* In this page:
- [Get single document](../../../client-api/commands/documents/get.mdx#get-single-document)
Expand Down
2 changes: 1 addition & 1 deletion docs/client-api/commands/documents/_get-nodejs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import CodeBlock from '@theme/CodeBlock';

* Use the low-level `GetDocumentsCommand` to retrieve documents from the database.

* To retrieve documents using a higher-level method, see [loading entities](../../../client-api/session/loading-entities.mdx) or [query for documents](../../../client-api/session/querying/how-to-query.mdx).
* To retrieve documents using a higher-level method, see [loading entities](../../../client-api/session/loading-entities.mdx) or [query for documents](../../../querying/overview.mdx).

* In this page:
- [Get single document](../../../client-api/commands/documents/get.mdx#get-single-document)
Expand Down
2 changes: 1 addition & 1 deletion docs/client-api/how-to/handle-document-relationships.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ import HandleDocumentRelationshipsNodejs from './_handle-document-relationships-
- [Indexing Related Documents](../../indexes/indexing-related-documents)

### Querying
- [Query Overview](../../client-api/session/querying/how-to-query)
- [Query Overview](../../querying/overview)
- [Querying an Index](../../indexes/querying/query-index)

### Document Extensions
Expand Down
2 changes: 1 addition & 1 deletion docs/client-api/operations/common/delete-by-query.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ import DeleteByQueryNodejs from './_delete-by-query-nodejs.mdx';
- [What are Operations](../../../client-api/operations/what-are-operations)

### Client API
- [How to Query](../../../client-api/session/querying/how-to-query)
- [How to Query](../../../querying/overview)
- [Querying: Basics](../../../indexes/querying/query-index)

### Querying
Expand Down
2 changes: 1 addition & 1 deletion docs/client-api/session/_updating-entities-csharp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import CodeBlock from '@theme/CodeBlock';

* To modify existing documents:

* **Retrieve** documents from the database using [Load](../../client-api/session/loading-entities.mdx#load) or by a [Query](../../client-api/session/querying/how-to-query.mdx#sessionquery).
* **Retrieve** documents from the database using [Load](../../client-api/session/loading-entities.mdx#load) or by a [Query](../../querying/overview.mdx#sessionquery).
The entities loaded from the documents are added to the internal entities map that the Session manages.

* **Edit** the properties you wish to change.
Expand Down
2 changes: 1 addition & 1 deletion docs/client-api/session/_updating-entities-nodejs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import CodeBlock from '@theme/CodeBlock';

* To modify existing documents:

* **Retrieve** documents from the database using [load](../../client-api/session/loading-entities.mdx#load) or by a [query](../../client-api/session/querying/how-to-query.mdx#sessionquery).
* **Retrieve** documents from the database using [load](../../client-api/session/loading-entities.mdx#load) or by a [query](../../querying/overview.mdx#sessionquery).
The entities loaded from the documents are added to the internal entities map that the Session manages.

* **Edit** the properties you wish to change.
Expand Down
2 changes: 1 addition & 1 deletion docs/client-api/session/_updating-entities-php.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import CodeBlock from '@theme/CodeBlock';
* To modify existing documents:

* **Retrieve** documents from the database using [load](../../client-api/session/loading-entities.mdx#load)
or by a [query](../../client-api/session/querying/how-to-query.mdx#sessionquery).
or by a [query](../../querying/overview.mdx#session-query).
The entities loaded from the documents are added to the internal entities map that the session manages.

* **Edit** the properties you wish to change.
Expand Down
2 changes: 1 addition & 1 deletion docs/client-api/session/_updating-entities-python.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import CodeBlock from '@theme/CodeBlock';

* To modify existing documents:

* **Retrieve** documents from the database using [load](../../client-api/session/loading-entities.mdx#load) or by a [query](../../client-api/session/querying/how-to-query.mdx#sessionquery).
* **Retrieve** documents from the database using [load](../../client-api/session/loading-entities.mdx#load) or by a [query](../../querying/overview.mdx#session-query).
The entities loaded from the documents are added to the internal entities map that the Session manages.

* **Edit** the properties you wish to change.
Expand Down
2 changes: 1 addition & 1 deletion docs/client-api/session/deleting-entities.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ import DeletingEntitiesNodejs from './_deleting-entities-nodejs.mdx';
- [How To: Enable Optimistic Concurrency](../../client-api/session/configuration/how-to-enable-optimistic-concurrency)

### Querying
- [Query Overview](../../client-api/session/querying/how-to-query)
- [Query Overview](../../querying/overview)
- [Basics](../../indexes/querying/query-index)

### Document Store
Expand Down
2 changes: 1 addition & 1 deletion docs/client-api/session/loading-entities.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ import LoadingEntitiesNodejs from './_loading-entities-nodejs.mdx';
- [Saving Changes](../../client-api/session/saving-changes)

### Querying
- [Query Overview](../../client-api/session/querying/how-to-query)
- [Query Overview](../../querying/overview)
- [Querying an Index](../../indexes/querying/query-index)

### Document Store
Expand Down
2 changes: 1 addition & 1 deletion docs/client-api/session/opening-a-session.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ import OpeningASessionNodejs from './_opening-a-session-nodejs.mdx';
- [What is a Document Store](../../client-api/what-is-a-document-store)

### Querying
- [Query Overview](../../client-api/session/querying/how-to-query)
- [Query Overview](../../querying/overview)
- [Basics](../../indexes/querying/query-index)

### Session
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import CodeBlock from '@theme/CodeBlock';

<Admonition type="note" title="">

* Use `Customize()` to set the following customization options on a specific [Query](../../../client-api/session/querying/how-to-query.mdx).
* Use `Customize()` to set the following customization options on a specific [Query](../../../querying/overview.mdx).
Can be set for both **dynamic** and **index** queries.

* Each such customization can also be implemented via the [DocumentQuery](../../../client-api/session/querying/document-query/what-is-document-query.mdx) API.
Expand Down Expand Up @@ -785,7 +785,7 @@ IDocumentQueryCustomization RandomOrdering(string seed);
## WaitForNonStaleResults

* All queries in RavenDB provide results using an index, even when you don't specify one.
See detailed explanation in [Queries always provide results using an index](../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index).
See detailed explanation in [Queries always provide results using an index](../../../querying/overview.mdx#queries-always-provide-results-using-an-index).

* Use `WaitForNonStaleResults` to instruct the query to wait for non-stale results from the index.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import CodeBlock from '@theme/CodeBlock';

* These methods can be used for both a dynamic-query and an index-query.

* A [query](../../../client-api/session/querying/how-to-query.mdx) can also be customized on the Store or Session level by subscribing to the `beforeQuery` event.
* A [query](../../../querying/overview.mdx) can also be customized on the Store or Session level by subscribing to the `beforeQuery` event.
Learn more in [Subscribing to Events](../../../client-api/session/how-to/subscribe-to-events.mdx).

* Customization methods available:
Expand Down Expand Up @@ -451,7 +451,7 @@ const results = await session.query(\{ collection: "Products" \})
## waitForNonStaleResults

* All queries in RavenDB provide results using an index, even when you don't specify one.
See detailed explanation in [Queries always provide results using an index](../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index).
See detailed explanation in [Queries always provide results using an index](../../../querying/overview.mdx#queries-always-provide-results-using-an-index).

* Use `waitForNonStaleResults` to instruct the query to wait for non-stale results from the index.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import CodeBlock from '@theme/CodeBlock';

<Admonition type="note" title="">

* Use the below methods to set customization options on a specific [query](../../../client-api/session/querying/how-to-query.mdx).
* Use the below methods to set customization options on a specific [query](../../../querying/overview.mdx).
Customizations can be set for both **dynamic** and **index** queries.

* A query can also be customized on the store or session level by
Expand Down Expand Up @@ -287,7 +287,7 @@ public function randomOrdering(?string $seed): DocumentQueryCustomizationInterfa
## `waitForNonStaleResults`

* All queries in RavenDB provide results using an index, even when you don't specify one.
See detailed explanation in [Queries always provide results using an index](../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index).
See detailed explanation in [Queries always provide results using an index](../../../querying/overview.mdx#queries-always-provide-results-using-an-index).

* Use `waitForNonStaleResults` to instruct the query to wait for non-stale results from the index.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import CodeBlock from '@theme/CodeBlock';

<Admonition type="note" title="">

* Use the below customization methods over a specific [query](../../../client-api/session/querying/how-to-query.mdx).
* Use the below customization methods over a specific [query](../../../querying/overview.mdx).

* The customization methods can be set for both **dynamic** and **index** queries.

Expand Down Expand Up @@ -530,7 +530,7 @@ results = list(
## `wait_for_non_stale_results`

* All RavenDB queries provide results using an index, even when an index is not specified.
See detailed explanation in [Queries always provide results using an index](../../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index).
See detailed explanation in [Queries always provide results using an index](../../../querying/overview.mdx#queries-always-provide-results-using-an-index).

* If `wait_for_non_stale_results` is used, the query will wait for non-stale results from the index.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ use the `Not` and `WhereExists` extension methods, accessible from the [Document
as shown below.

This will either create a new auto-index or add the queried field to an existing auto-index.
Learn more about the dynamic query flow [here](../../../client-api/session/querying/how-to-query.mdx#dynamicquery).
Learn more about the dynamic query flow [here](../../../querying/overview.mdx#dynamicquery).

**Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ import CodeBlock from '@theme/CodeBlock';
## Query the collection (dynamic query)

To run a dynamic query over a collection and find which documents are missing a specified field,
use the `not` and `whereExists` extension methods, accessible from the [query](../../../client-api/session/querying/how-to-query.mdx) API,
use the `not` and `whereExists` extension methods, accessible from the [query](../../../querying/overview.mdx) API,
as shown below.

This will either create a new auto-index or add the queried field to an existing auto-index.
Learn more about the dynamic query flow [here](../../../client-api/session/querying/how-to-query.mdx#dynamicquery).
Learn more about the dynamic query flow [here](../../../querying/overview.mdx#dynamicquery).

**Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ use the `not` and `whereExists` extension methods, accessible from the [document
as shown below.

This will either create a new auto-index or add the queried field to an existing auto-index.
Learn more about the dynamic query flow [here](../../../client-api/session/querying/how-to-query.mdx#dynamicquery).
Learn more about the dynamic query flow [here](../../../querying/overview.mdx#dynamicquery).

**Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ use the `not_` and `where_exists` methods, accessible from the [document_query](
API, as demonstrated below.

This will either create a new auto-index or add the queried field to an existing auto-index.
Learn more about the dynamic query flow [here](../../../client-api/session/querying/how-to-query.mdx#dynamicquery).
Learn more about the dynamic query flow [here](../../../querying/overview.mdx#dynamicquery).

**Example**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ IEnumerable<Employee> employees = lazyEmployees.Value; // DocumentQuery is execu
</TabItem>
</Tabs>

* Learn more about queries in this [query overview](../../../client-api/session/querying/how-to-query.mdx).
* Learn more about queries in this [query overview](../../../querying/overview.mdx).



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ const employees = await lazyEmployees.getValue(); // Query is executed here
</CodeBlock>
</TabItem>

* Learn more about queries in this [query overview](../../../client-api/session/querying/how-to-query.mdx).
* Learn more about queries in this [query overview](../../../querying/overview.mdx).



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import CodeBlock from '@theme/CodeBlock';
for general knowledge about RavenDB's lazy behavior and other request types that can be
executed lazily within a session.

* Learn more about queries in this [query overview](../../../client-api/session/querying/how-to-query.mdx).
* Learn more about queries in this [query overview](../../../querying/overview.mdx).

* In this page:
* [Lazy query](../../../client-api/session/querying/how-to-perform-queries-lazily.mdx#lazy-query)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import CodeBlock from '@theme/CodeBlock';
</Admonition>
## Lazy query

To run a [regular query](../../../client-api/session/querying/how-to-query.mdx)
To run a [regular query](../../../querying/overview.mdx)
(not a [suggestions](../../../client-api/session/querying/how-to-work-with-suggestions.mdx)
query or a [faceted search](../../../client-api/session/querying/how-to-perform-a-faceted-search.mdx))
lazily, use `.lazily()` as follows.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -511,7 +511,7 @@ IEnumerator<StreamResult<T>> Stream<T>(IRawDocumentQuery<T> query, out StreamQue

| Parameters | type | description |
| - | - | - |
| **query** | [IQueryable](../../../client-api/session/querying/how-to-query.mdx#sessionquery), [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) | The query for which to stream results |
| **query** | [IQueryable](../../../querying/overview.mdx#session-query), [IDocumentQuery](../../../querying/overview.mdx#session-advanced-documentquery) or [IRawDocumentQuery](../../../querying/overview.mdx#session-advanced-rawquery) | The query for which to stream results |
| `out` **streamQueryStats** | [StreamQueryStatistics](../../../glossary/stream-query-statistics.mdx) | Information about performed query |

| Return Value | |
Expand Down
Loading