• Documentation: https://github.com/documentdb/docs/
• Website: https://documentdb.io
• Discord: https://discord.gg/vH7bYu524D

DocumentDB offers a native implementation of document-oriented NoSQL database, enabling seamless CRUD operations on BSON data types within a PostgreSQL framework. Beyond basic operations, DocumentDB empowers you to execute complex workloads, including full-text searches, geospatial queries, and vector embeddings on your dataset, delivering robust functionality and flexibility for diverse data management needs.

The project comprises two primary components, which work together to support document operations:

• pg_documentdb_core: PostgreSQL extension introducing BSON datatype support and operations for native Postgres.
• pg_documentdb: The public API surface for DocumentDB providing CRUD functionality on documents in the store.

Learn more by visiting the Components page.

• Ensure Docker is installed on your system.
• For contributing to either of the extensions:
  • VSCode with extensions:
    • C/C++ (From Microsoft)
    • Remote Development

1. Pull the DocumentDB Image

   docker pull ghcr.io/microsoft/documentdb/documentdb-local:latest

2. Tag the Image (Optional but Recommended)

   docker tag ghcr.io/microsoft/documentdb/documentdb-local:latest documentdb

3. Run DocumentDB Container

   docker run -dt -p 10260:10260 \
     -e USERNAME=YourUsername \
     -e PASSWORD=YourPassword \
     --name documentdb-container \
     documentdb

Important Notes:

• Replace YourUsername and YourPassword with your desired credentials
• The port 10260 can be changed if needed
• The -dt flags run the container in detached mode (background)

4. Verify the Container is Running

   docker ps

You should see your documentdb-container in the list of running containers.

For detailed information on the available functions, please refer to the Functions page.