Skip to content

RDoc-3778 Query overview: Enhance section "Query by document ID" #2392

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

Merged
ppekrol merged 1 commit into from
Apr 9, 2026
+39 −47
Merged

RDoc-3778 Query overview: Enhance section "Query by document ID" #2392

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 12 additions & 14 deletions docs/querying/content/_overview-csharp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,17 +58,16 @@ import Panel from '@site/src/components/Panel';

We differentiate between the following **3 query scenarios**:

1. [Index query](../../querying/overview.mdx#indexquery)
2. [Dynamic query](../../querying/overview.mdx#dynamicquery)
3. [Full collection query](../../querying/overview.mdx#collectionquery)
1. [Query an existing index](../../querying/overview.mdx#1-query-an-existing-index)
2. [Query a collection - with filtering](../../querying/overview.mdx#2-query-a-collection---with-filtering)
3. [Query a collection - query full collection | query by ID](../../querying/overview.mdx#3-query-a-collection---query-full-collection--query-by-id)

For each scenario, a different index type is used, as described below.

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

<a id="indexQuery"/>
**1. Query an existing index**:

### 1. Query an existing index

* **Query type**: Index query
**Index used**: Static-index
Expand All @@ -83,9 +82,8 @@ For each scenario, a different index type is used, as described below.

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

<a id="dynamicQuery"/>
**2. Query a collection - with filtering**:

### 2. Query a collection - with filtering

* **Query type**: Dynamic Query
**Index used**: Auto-index
Expand Down Expand Up @@ -119,9 +117,8 @@ For each scenario, a different index type is used, as described below.

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

<a id="collectionQuery"/>
**3. Query a collection - query full collection | query by ID**:

### 3. Query a collection - query full collection | query by ID

* **Query type**: Full collection Query
**Index used**: The raw collection (internal storage indexes)
Expand All @@ -138,10 +135,11 @@ For each scenario, a different index type is used, as described below.

* Query by document ID:

* When querying a collection only by document ID or IDs,
* When querying a collection filtering only by document ID or IDs,
then similar to the full collection query, no auto-index is created.

* RavenDB uses the raw collection documents as the source for this query.
* On the server side, this type of query opens a single read transaction and extracts the documents directly from the raw collection storage.
No search engine index (Lucene or Corax) is involved in this process.

* Example RQL: &nbsp; `from Employees where id() == "employees/1-A"`
See more examples [below](../../querying/overview.mdx#session-query).
Expand Down
20 changes: 9 additions & 11 deletions docs/querying/content/_overview-nodejs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,18 +55,17 @@ import Panel from '@site/src/components/Panel';

We differentiate between the following **3 query scenarios**:

1. [Index query](../../querying/overview.mdx#indexquery)
2. [Dynamic query](../../querying/overview.mdx#dynamicquery)
3. [Full collection query](../../querying/overview.mdx#collectionquery)
1. [Query an existing index](../../querying/overview.mdx#1-query-an-existing-index)
2. [Query a collection - with filtering](../../querying/overview.mdx#2-query-a-collection---with-filtering)
3. [Query a collection - query full collection | query by ID](../../querying/overview.mdx#3-query-a-collection---query-full-collection--query-by-id)

For each scenario, a different index type is used, as described below.

</Admonition>

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

<a id="indexQuery"/>
**1. Query an existing index**:
### 1. Query an existing index

* **Query type**: Index query
**Index used**: Static-index
Expand All @@ -83,8 +82,7 @@ For each scenario, a different index type is used, as described below.

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

<a id="dynamicQuery"/>
**2. Query a collection - with filtering (Dynamic Query)**:
### 2. Query a collection - with filtering

* **Query type**: Dynamic Query
**Index used**: Auto-index
Expand Down Expand Up @@ -120,8 +118,7 @@ For each scenario, a different index type is used, as described below.

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

<a id="collectionQuery"/>
**3. Query a collection - no filtering**:
### 3. Query a collection - query full collection | query by ID

* **Query type**: Full collection Query
**Index used**: The raw collection (internal storage indexes)
Expand All @@ -138,10 +135,11 @@ For each scenario, a different index type is used, as described below.

* Query by document ID:

* When querying a collection only by document ID or IDs,
* When querying a collection filtering only by document ID or IDs,
then similar to the full collection query, no auto-index is created.

* RavenDB uses the raw collection documents as the source for this query.
* On the server side, this type of query opens a single read transaction and extracts the documents directly from the raw collection storage.
No search engine index (Lucene or Corax) is involved in this process.

* Example RQL: &nbsp; `from Employees where id() == "employees/1-A"`
See more examples [below](../../querying/overview.mdx#session-query).
Expand Down
20 changes: 9 additions & 11 deletions docs/querying/content/_overview-php.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,17 +60,16 @@ import Panel from '@site/src/components/Panel';

We differentiate between the following **3 query scenarios**:

1. [Index query](../../querying/overview.mdx#indexquery)
2. [Dynamic query](../../querying/overview.mdx#dynamicquery)
3. [Full collection query](../../querying/overview.mdx#collectionquery)
1. [Query an existing index](../../querying/overview.mdx#1-query-an-existing-index)
2. [Query a collection - with filtering](../../querying/overview.mdx#2-query-a-collection---with-filtering)
3. [Query a collection - query full collection | query by ID](../../querying/overview.mdx#3-query-a-collection---query-full-collection--query-by-id)

For each scenario, a different index type is used, as described below.

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

<a id="indexQuery"/>
**1. Query an existing index**:
### 1. Query an existing index

* **Query type**: Index query
**Index used**: Static-index
Expand All @@ -86,8 +85,7 @@ For each scenario, a different index type is used, as described below.
</Admonition>
<Admonition type="note" title="">

<a id="dynamicQuery"/>
**2. Query a collection - with filtering**:
### 2. Query a collection - with filtering

* **Query type**: Dynamic Query
**Index used**: Auto-index
Expand Down Expand Up @@ -123,8 +121,7 @@ For each scenario, a different index type is used, as described below.
</Admonition>
<Admonition type="note" title="">

<a id="collectionQuery"/>
**3. Query a collection - query full collection | query by ID**:
### 3. Query a collection - query full collection | query by ID

* **Query type**: Full collection Query
**Index used**: The raw collection (internal storage indexes)
Expand All @@ -141,10 +138,11 @@ For each scenario, a different index type is used, as described below.

* Query by document ID:

* When querying a collection only by document ID or IDs,
* When querying a collection filtering only by document ID or IDs,
then similar to the full collection query, no auto-index is created.

* RavenDB uses the raw collection documents as the source for this query.
* On the server side, this type of query opens a single read transaction and extracts the documents directly from the raw collection storage.
No search engine index (Lucene or Corax) is involved in this process.

* Example RQL: &nbsp; `from Employees where id() == "employees/1-A"`
See more examples [below](../../querying/overview.mdx#session-query).
Expand Down
20 changes: 9 additions & 11 deletions docs/querying/content/_overview-python.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,17 +58,16 @@ import Panel from '@site/src/components/Panel';

We differentiate between the following **3 query scenarios**:

1. [Index query](../../querying/overview.mdx#indexquery)
2. [Dynamic query](../../querying/overview.mdx#dynamicquery)
3. [Full collection query](../../querying/overview.mdx#collectionquery)
1. [Query an existing index](../../querying/overview.mdx#1-query-an-existing-index)
2. [Query a collection - with filtering](../../querying/overview.mdx#2-query-a-collection---with-filtering)
3. [Query a collection - query full collection | query by ID](../../querying/overview.mdx#3-query-a-collection---query-full-collection--query-by-id)

For each scenario, a different index type is used, as described below.

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

<a id="indexQuery"/>
**1. Query an existing index**:
### 1. Query an existing index

* **Query type**: Index query
**Index used**: Static-index
Expand All @@ -84,8 +83,7 @@ For each scenario, a different index type is used, as described below.
</Admonition>
<Admonition type="note" title="">

<a id="dynamicQuery"/>
**2. Query a collection - with filtering**:
### 2. Query a collection - with filtering

* **Query type**: Dynamic Query
**Index used**: Auto-index
Expand Down Expand Up @@ -120,8 +118,7 @@ For each scenario, a different index type is used, as described below.
</Admonition>
<Admonition type="note" title="">

<a id="collectionQuery"/>
**3. Query a collection - query full collection | query by ID**:
### 3. Query a collection - query full collection | query by ID

* **Query type**: Full collection Query
**Index used**: The raw collection (internal storage indexes)
Expand All @@ -138,10 +135,11 @@ For each scenario, a different index type is used, as described below.

* Query by document ID:

* When querying a collection only by document ID or IDs,
* When querying a collection filtering only by document ID or IDs,
then similar to the full collection query, no auto-index is created.

* RavenDB uses the raw collection documents as the source for this query.
* On the server side, this type of query opens a single read transaction and extracts the documents directly from the raw collection storage.
No search engine index (Lucene or Corax) is involved in this process.

* Example RQL: &nbsp; `from Employees where id() == "employees/1-A"`
See more examples [below](../../querying/overview.mdx#session-query).
Expand Down
Loading