RDoc-4065 + RDoc-4074 Developer access: Overview + Access via RavenDB.Client by Danielle9897 · Pull Request #2607 · ravendb/docs

Danielle9897 · 2026-08-26T07:16:58Z

Issue links

https://issues.hibernatingrhinos.com/issue/RDoc-4065/Quill-documentation-Access-the-mirrored-database-with-RavenDB.Client
https://issues.hibernatingrhinos.com/issue/RDoc-4074/Quill-documentation-Developer-access-overview

Additional description

Developer Access overview article:
Explain the two ways to work with data mirrored by a Quill app.
Access the mirrored database with RavenDB.Client article:
Document how an external application can query or process a Quill app's mirrored data directly in RavenDB,
without passing through a Quill agent, an LLM, a channel, or the Quill API.

Type of change

Changes in docs URLs

No changes in docs URLs
Articles are restructured, URLs will change, mapping is required (update /scripts/redirects.json file, set Documents Moved PR label)

Changes in UX/UI

No changes in UX/UI
Changes in UX/UI (include screenshots and description)

Lwiel · 2026-08-31T10:57:30Z

+  * Changes made directly in RavenDB are not written back to the source database.
+
+`RavenDB.Client` connects to RavenDB through `https://db.<domain>` without passing through the Quill web application.  
+For details about this connection path and its TLS handling, see [Direct database access](../../quill/security-and-architecture/network-architecture.mdx#direct-database-access).


Link doesn't work

Lwiel · 2026-08-31T10:59:16Z

+
+With `RavenDB.Client`, your application accesses the **mirrored data in RavenDB**, not the source relational database:
+
+  * The source database remains the system of record.


I had to search what it means, can we use a different wording? Source of truth would probably be better, though I may have a personal bias towards it

Lwiel · 2026-08-31T11:04:37Z

+For a standard Quill domain, RavenDB presents a publicly trusted wildcard server certificate,   
+so the application needs no additional server-certificate trust configuration.  
+Client certificates are registered separately by thumbprint,  
+so renewing the Quill server certificate does not invalidate them.


I wouldn't manually add newlines here, looks odd

removed the extra line breaks

Lwiel · 2026-08-31T11:10:20Z

+Each app in the response includes both `slug` and `database`.  
+Set `DocumentStore.Database` to the value of `database`; do not derive it from the app's display name.
+
+For more information about authenticating this Quill API request, see [Operator Authentication](../../quill/security-and-architecture/operator-authentication.mdx).


Link doesn't work

Lwiel · 2026-08-31T11:12:42Z

+<Panel heading="Understand the mirrored document structure">    
+
+The source relational schema is not mirrored one-to-one as a separate RavenDB collection for every table.  
+The CDC mapping defined for the app determines:


There is no prior introduction what CDC is, so I wouldn't mention it this way

=>
The way Quill maps data from the source relational database to RavenDB determines:

Lwiel · 2026-08-31T11:14:28Z

+```text
+Products/1
+```


I'd rather just inline it in the sentence

Lwiel · 2026-08-31T11:18:17Z

+The following .NET 9 or later example loads the `.pfx`, connects to the app's RavenDB database,  
+and queries the mapped `Products` collection:
+
+```csharp


Maybe we should consider samples in all supported languages?

sure, can do that in a separate issue once we're good with the initial Quill documentation batch.

Lwiel · 2026-08-31T11:23:34Z

+
+<Panel heading="Inspect the CDC task">
+
+Quill creates a CDC Sink task in each app database to keep its mapped documents synchronized with the source relational database.


We should at least link the CDC task documentation here

@Lwiel
The only way I could make this link navigate from the Quill documentation to the RavenDB documentation was to use: [CDC Sink task](/7.2/server/ongoing-tasks/cdc-sink/overview)
However, this hardcodes the RavenDB version.
Is there a version-independent way to link to this page from the Quill documentation?

What about https://docs.ravendb.net/server/ongoing-tasks/cdc-sink/overview?

will use this - it works - thanks

Lwiel · 2026-08-31T11:31:48Z

+<br/>
+
+Configure `DisableTopologyUpdates` before calling `Initialize()`.  
+For more information, see [The `a` hostname](../../quill/networking-and-dns.mdx#the-a-hostname).


Link doesn't work

Lwiel · 2026-08-31T11:32:17Z

+
+If the Quill host moves to another IP address, update all Quill DNS records so that `db.<domain>`, `a.<domain>`,  
+and the other Quill hostnames resolve to the new address.
+See [Moving your Quill to a new IP](../../quill/networking-and-dns.mdx#moving-your-quill-to-a-new-ip).


Link doesn't work

Lwiel · 2026-08-31T11:44:10Z

+Most collections containing these internal documents begin with `@`, but not all of them do.  
+For example, the `WidgetThemeDefaults` collection contains Quill's `widget-theme-defaults/config` document and has no `@` prefix.


That's something I'll change, we have to be consistent with this

Changed in this PR - ravendb/ravendb#23502

Now all internal documents are either in configuration database, or in the per-app database collections prefixed with @

Danielle9897 requested review from Lwiel and TheGoldenPlatypus August 26, 2026 07:19

Lwiel reviewed Aug 31, 2026

View reviewed changes

Danielle9897 added 4 commits August 31, 2026 17:23

RDoc-4065 Access the mirrored database with RavenDB.Client

4db714c

RDoc-4074 [Quill documentation] Developer access overview

4cde24d

Trigger build

4414b98

RDoc-4065 fix review comments

1bbcc61

Danielle9897 force-pushed the RDoc-4065-quill-access-mirrored-database branch from fbeb361 to 1bbcc61 Compare August 31, 2026 16:10

Danielle9897 requested a review from Lwiel August 31, 2026 16:10


		With `RavenDB.Client`, your application accesses the mirrored data in RavenDB, not the source relational database:

		* The source database remains the system of record.


		<Panel heading="Inspect the CDC task">

		Quill creates a CDC Sink task in each app database to keep its mapped documents synchronized with the source relational database.

		Most collections containing these internal documents begin with `@`, but not all of them do.
		For example, the `WidgetThemeDefaults` collection contains Quill's `widget-theme-defaults/config` document and has no `@` prefix.

Uh oh!

Conversation

Danielle9897 commented Aug 26, 2026

Issue links

Additional description

Type of change

Changes in docs URLs

Changes in UX/UI

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants