Skip to content

DOC-10400-db-config-schema-description-rewrite - #1002

Merged
iamfortune merged 3 commits into
release/4.1from
DOC-10400-db-config-schema-description-rewrite
Jul 28, 2026
Merged

DOC-10400-db-config-schema-description-rewrite#1002
iamfortune merged 3 commits into
release/4.1from
DOC-10400-db-config-schema-description-rewrite

Conversation

@iamfortune

@iamfortune iamfortune commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Docs Issue: DOC-10400

PR to update the DB configuration page and describe the organization and mapping of Buckets, scopes and collection between SGW and CBS and CBL

Preview URL:
https://preview.docs-test.couchbase.com/docs-sync-gateway-DOC-10400-db-config-schema-description-rewrite

You will need the Docs Team credentials on Confluence.

@iamfortune
iamfortune requested a review from gregns1 July 22, 2026 12:25
=== Scope and collection limits

You can define 1 custom scope per database with up to 1000 custom collections.
This limit reflects current {svr} indexing capacity rather than an independently configurable {sgw} setting: {sgw} typically creates around 5 indexes per collection to support mobile replication, and indexing capacity is the constraint that governs how many collections mobile workloads can use.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should remove the why here. Just state that the current limits are:

  • 1 scope per database
  • 1000 collections across the cluster

Drop anything mentioning this is down to indexing capacity.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated this, good looking out, thank you!

Comment thread modules/configuration/pages/configuration-schema-database.adoc Outdated
=== The system collection

{sgw} uses a reserved system collection, `_system._mobile`, to store its internal metadata separately from user application data.
This collection is owned by {sgw} and is not a user-configurable scope or collection.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given this is an opt in feature to use we should state that here something like "{sgw} uses a reserved system collection, _system._mobile, to store its internal metadata separately from user application data if opted in to do so."

You sort of mention this below in separate paragraph so you could just remove this bit or update it to mention the opt in i'll leave that up to you to see what looks/read best.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated this, thank you

iamfortune and others added 2 commits July 24, 2026 14:26
Co-authored-by: Gregory Newman-Smith <109068393+gregns1@users.noreply.github.com>
@iamfortune
iamfortune requested a review from gregns1 July 24, 2026 13:42
@iamfortune
iamfortune merged commit e89c50f into release/4.1 Jul 28, 2026
@iamfortune
iamfortune deleted the DOC-10400-db-config-schema-description-rewrite branch July 28, 2026 16:41
@iamfortune iamfortune changed the title DOC-10400-db-config-shcema-description-rewrite DOC-10400-db-config-schema-description-rewrite Jul 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants