Skip to content

MongoDB Replica set support - needs documentation update #800

Closed

Description

This PR (microsoft/aspire#16698) updates the Aspire MongoDB Builder to add support for building a single node replica set. This will allow applications using transactions or change streams to use MongoDB in Aspire.

The documentation should be updated to explain when this should be used, and how to use it.

The usage itself is simple, when adding a mongo database, add the .WithReplicaSet() call to the builder as follows:

var mongo = builder.AddMongoDB("mongo")
    .WithReplicaSet();

Activity

  1. IEvangelist commented on Jun 2, 2026

    @IEvangelist
    Member

    Triage → @Copilot

    Upstream: microsoft/aspire#16698 — adds single-node replica set support to the Aspire MongoDB hosting builder so apps can use transactions and change streams locally.

    File(s): under src/frontend/src/content/docs/integrations/databases/mongodb/ — locate the MongoDB hosting integration page that currently documents AddMongoDB(...).

    Scope

    • Document the new API for enabling a single-node replica set.
    • Explain when to use it (transactions, change streams) and when not to (everyday CRUD).
    • Show a copy-pasteable AppHost snippet plus what changes in the connection string the client receives (replica set name appears).
    • Add a short note on emulator/container behavior so users know the local container is initialized as a 1-node RS.

    Acceptance

    • Confirms API signature by reading the merged PR's diff before writing examples.
    • New section is discoverable from the integration's TOC and from the page's intro.
    • No unrelated edits.
  2. IEvangelist commented on Oct 18, 2026

    @IEvangelist
    Member

    Addressed by #1730 (release/13.6, content now on main via #1599). The content is now on main, so closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions