• Stars
    star
    383
  • Rank 111,995 (Top 3 %)
  • Language
    Python
  • License
    Other
  • Created over 10 years ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Specifications related to MongoDB

MongoDB Specifications

This repository holds in progress and completed specification for features of MongoDB, Drivers, and associated products. Also contained is a rudimentary system for producing these documents.

Driver Mantras

When developing specifications -- and the drivers themselves -- we follow the following principles:

Strive to be idiomatic, but favor consistency

Drivers attempt to provide the easiest way to work with MongoDB in a given language ecosystem, while specifications attempt to provide a consistent behavior and experience across all languages. Drivers should strive to be as idiomatic as possible while meeting the specification and staying true to the original intent.

No Knobs

Too many choices stress out users. Whenever possible, we aim to minimize the number of configuration options exposed to users. In particular, if a typical user would have no idea how to choose a correct value, we pick a good default instead of adding a knob.

Topology agnostic

Users test and deploy against different topologies or might scale up from replica sets to sharded clusters. Applications should never need to use the driver differently based on topology type.

Where possible, depend on server to return errors

The features available to users depend on a server's version, topology, storage engine and configuration. So that drivers don't need to code and test all possible variations, and to maximize forward compatibility, always let users attempt operations and let the server error when it can't comply. Exceptions should be rare: for cases where the server might not error and correctness is at stake.

Minimize administrative helpers

Administrative helpers are methods for admin tasks, like user creation. These are rarely used and have maintenance costs as the server changes the administrative API. Don't create administrative helpers; let users rely on "RunCommand" for administrative commands.

Check wire version, not server version

When determining server capabilities within the driver, rely only on the maxWireVersion in the hello response, not on the X.Y.Z server version. An exception is testing server development releases, as the server bumps wire version early and then continues to add features until the GA.

When in doubt, use "MUST" not "SHOULD" in specs

Specs guide our work. While there are occasionally valid technical reasons for drivers to differ in their behavior, avoid encouraging it with a wishy-washy "SHOULD" instead of a more assertive "MUST".

Defy augury

While we have some idea of what the server will do in the future, don't design features with those expectations in mind. Design and implement based on what is expected in the next release.

Case Study: In designing OP_MSG, we held off on designing support for Document Sequences in Replies in drivers until the server would support it. We subsequently decided not to implement that feature in the server.

The best way to see what the server does is to test it

For any unusual case, relying on documentation or anecdote to anticipate the server's behavior in different versions/topologies/etc. is error-prone. The best way to check the server's behavior is to use a driver or the shell and test it directly.

Drivers follow semantic versioning

Drivers should follow X.Y.Z versioning, where breaking API changes require a bump to X. See semver.org for more.

Backward breaking behavior changes and semver

Backward breaking behavior changes can be more dangerous and disruptive than backward breaking API changes. When thinking about the implications of a behavior change, ask yourself what could happen if a user upgraded your library without carefully reading the changelog and/or adequately testing the change.

Writing Documents

Write documents using reStructuredText, following the MongoDB Documentation Style Guidelines.

Store all source documents in the source/ directory.

Prose test numbering

When numbering prose tests, always use relative numbered bullets (#.). New tests must be appended at the end of the test list, since drivers may refer to existing tests by number.

Outdated tests must not be removed completely, but may be marked as such (e.g. by striking through or replacing the entire test with a note (e.g. Removed).

Building Documents

To build documents issue the make command in a local copy of this repository. The output PDFs end up in the build/ directory. The build depends on:

make all will build all documents in the source/ folder. The system builds all targets in build/.

Run make setup to generate (or regenerate) a makefile.generated file which provides specific targets for all files in the source file so you can choose to compile only some of the files that you need. Once generated, running "make [file-name-without-extension]" will rebuild only those files (if needed.)

Use make clean to remove the build/ directory and "make cleanup" to remove the LaTeX by-products from build/.

Converting to JSON

There are many YAML to JSON converters. There are even several converters called yaml2json in NPM. Alas, we are not using yaml2json anymore, but instead the js-yaml package. Use only that converter, so that JSON is formatted consistently.

Run npm install -g js-yaml, then run make in the source directory at the top level of this repository to convert all YAML test files to JSON.

Licensing

All the specs in this repository are available under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 United States License.

More Repositories

1

mongo

The MongoDB Database
C++
26,192
star
2

node-mongodb-native

The official MongoDB Node.js driver
TypeScript
10,030
star
3

mongo-go-driver

The Official Golang driver for MongoDB
Go
8,135
star
4

laravel-mongodb

A MongoDB based Eloquent model and Query builder for Laravel (Moloquent)
PHP
6,997
star
5

mongo-python-driver

PyMongo - the Official MongoDB Python driver
Python
4,129
star
6

mongoid

The Official Ruby Object Mapper for MongoDB
Ruby
3,922
star
7

mongo-csharp-driver

The Official C# .NET Driver for MongoDB
C#
3,038
star
8

mongo-java-driver

The official MongoDB drivers for Java, Kotlin, and Scala
Java
2,568
star
9

motor

Motor - the async Python driver for MongoDB and Tornado or asyncio
Python
2,410
star
10

mongo-php-library

The Official MongoDB PHP library
PHP
1,594
star
11

mongo-hadoop

MongoDB Connector for Hadoop
Java
1,519
star
12

mongo-ruby-driver

The Official MongoDB Ruby Driver
Ruby
1,422
star
13

mongo-rust-driver

The official MongoDB Rust Driver
Rust
1,268
star
14

mongodb-kubernetes-operator

MongoDB Community Kubernetes Operator
Go
1,218
star
15

js-bson

BSON Parser for node and browser
TypeScript
1,130
star
16

mongo-php-driver-legacy

Legacy MongoDB PHP driver
PHP
1,093
star
17

mongo-cxx-driver

C++ Driver for MongoDB
C++
1,040
star
18

mongo-tools

Go
994
star
19

homebrew-brew

The Official MongoDB Software Homebrew Tap
Ruby
924
star
20

mongo-php-driver

The Official MongoDB PHP driver
PHP
838
star
21

mongo-c-driver

The Official MongoDB driver for C language
C
815
star
22

docs

The MongoDB Documentation Project Source.
Java
738
star
23

mongo-spark

The MongoDB Spark Connector
Java
706
star
24

casbah

Casbah is now officially end-of-life (EOL).
Scala
514
star
25

bson-rust

Encoding and decoding support for BSON in Rust
Rust
402
star
26

mongo-snippets

snippets of code that might be useful for your mongodb deployment
C++
381
star
27

cookbook

MongoDB recipes.
Ruby
354
star
28

pymodm

A Pythonic, object-oriented interface for working with MongoDB.
Python
351
star
29

mongo-perf

performance tools for mongodb
JavaScript
350
star
30

libbson

ARCHIVED - libbson has moved to https://github.com/mongodb/mongo-c-driver/tree/master/src/libbson
C
347
star
31

mongo-kafka

MongoDB Kafka Connector
Java
342
star
32

mongo-efcore-provider

MongoDB Entity Framework Core Provider
C#
329
star
33

mongo-swift-driver

The official MongoDB driver for Swift
Swift
325
star
34

mongodb-enterprise-kubernetes

MongoDB Enterprise Kubernetes Operator
Dockerfile
325
star
35

mongo-scala-driver

Scala
286
star
36

terraform-provider-mongodbatlas

Terraform MongoDB Atlas Provider: Deploy, update, and manage MongoDB Atlas infrastructure as code through HashiCorp Terraform
Go
242
star
37

leafygreen-ui

LeafyGreen UI – LeafyGreen's React UI Kit
TypeScript
219
star
38

mongodb-atlas-cli

MongoDB Atlas CLI and MongoDB CLI enable you to manage your MongoDB in the Cloud
Go
161
star
39

mongodb-atlas-kubernetes

MongoDB Atlas Kubernetes Operator - Manage your MongoDB Atlas clusters from Kubernetes
Go
148
star
40

stitch-examples

MongoDB Stitch Examples
Java
138
star
41

chatbot

MongoDB Chatbot Framework. Powered by MongoDB and Atlas Vector Search.
TypeScript
135
star
42

support-tools

For support tools to be shared publicly
Go
127
star
43

stitch-js-sdk

MongoDB Stitch JavaScript SDK
TypeScript
113
star
44

mongo-bi-connector-odbc-driver

ODBC driver for MongoDB Connector for Business Intelligence
C
110
star
45

mongo-azure

C#
103
star
46

amboy

Amboy -- A Go(lang) Job Queue Tool
Go
98
star
47

helm-charts

Smarty
94
star
48

libmongocrypt

Required C library for Client Side and Queryable Encryption in MongoDB
C
94
star
49

bsonspec.org

site for bsonspec.org
HTML
92
star
50

terraform-aws-ecs-task-definition

A Terraform module for creating Amazon ECS Task Definitions
HCL
85
star
51

go-client-mongodb-atlas

Go Client for MongoDB Atlas
Go
79
star
52

docs-ecosystem

MongoDB Ecosystem Documentation
Python
77
star
53

bson-ruby

Ruby Implementation of the BSON Specification (2.0.0+)
Ruby
77
star
54

mongo-java-driver-reactivestreams

The Java Reactive Stream driver for MongoDB
Java
73
star
55

mongodbatlas-cloudformation-resources

MongoDB Atlas CloudFormation Resources: Deploy, update, and manage MongoDB Atlas infrastructure as code through AWS CloudFormation
Go
59
star
56

stitch-android-sdk

MongoDB Stitch Android SDK
Java
57
star
57

genny

🧞‍♀️ Grants 3 wishes. As long as those wishes are to generate load 🧞‍♂️
C++
49
star
58

winkerberos

A native Kerberos client implementation for Python on Windows
C
47
star
59

docs-realm

Realm Database SDK documentation
Kotlin
44
star
60

bson-numpy

This project has been superseded by PyMongoArrow - https://github.com/mongodb-labs/mongo-arrow/tree/main/bindings/python
C
43
star
61

stitch-ios-sdk

Swift
42
star
62

docs-tools

Common tools and content for MongoDB documentation projects.
Python
42
star
63

swift-bson

pure Swift BSON library
Swift
41
star
64

signal-processing-algorithms

Python
41
star
65

mongo-jdbc-driver

JDBC Driver for MongoDB Atlas SQL interface
Java
38
star
66

design

Source code for MongoDB.design, LeafyGreen's official documentation site.
TypeScript
36
star
67

mongo-hhvm-driver

MongoDB HHVM driver **Note, this driver is no longer maintained**
PHP
35
star
68

awscdk-resources-mongodbatlas

MongoDB Atlas AWS CDK Resources
TypeScript
35
star
69

mongodb-vapor

MongoDB + Vapor integration
Swift
34
star
70

atlas-billing

JavaScript
33
star
71

atlas-app-services-examples

Example use cases for Atlas App Services
JavaScript
32
star
72

mongo-java-driver-rx

The MongoDB Java RX driver is now officially end-of-life (EOL)
Java
30
star
73

snooty

MongoDB Documentation front end
JavaScript
29
star
74

mongo-csharp-analyzer

The MongoDB Analyzer is a free tool that helps you understand how your code translates into the MongoDB Query API.
C#
27
star
75

realm-practice

realm-node-practice & realm-swift-practice
Swift
24
star
76

charts-embedding-examples

charts-embedding-examples
HTML
23
star
77

ftdc

utils for working with mongodb full-time diagnostic data capture files
Go
23
star
78

mongo-csharp-driver-jsondotnet

The C#/.NET driver will have a new component to integrate with JSON.NET that needs to live separately from the .NET driver itself.
C#
22
star
79

template-app-react-native-todo

Atlas Template Starter App - Use Device Sync from a React Native client application. This repo is generated from source code in https://github.com/mongodb-university/realm-template-apps
TypeScript
21
star
80

mongo-odbc-driver

Rust
20
star
81

marian

A search engine focused on documentation.
JavaScript
20
star
82

curator

Curator -- a build and package automation tool
Go
19
star
83

mongo-qa

General QA materials for Mongo
Java
19
star
84

anser

Data Transformation/Migration Tool
Go
19
star
85

snooty-parser

Python
19
star
86

academia-mongodb-lab-python

Lab using MongoDB with Python (PyMongo driver). Created for educational use by the MongoDB for Academia program.
Jupyter Notebook
19
star
87

kbson

Kotlin Multiplatform Bson Library
Kotlin
18
star
88

docs-compass

Python
18
star
89

docs-bi-connector

Makefile
17
star
90

atlas-sdk-go

MongoDB Atlas Golang SDK
Go
17
star
91

snooty-vscode

TypeScript
17
star
92

terraform-provider-mongodbatlas-archive

ARCHIVED ---- Hashicorp Terraform Provider for MongoDB Atlas - please use https://github.com/terraform-providers/terraform-provider-mongodbatlas
Go
17
star
93

mongo-aspnetcore-odata

Adds MongoDB support to Microsoft ASP.NET Core oData.
C#
16
star
94

template-app-swiftui-todo

Atlas Template Starter App - Use Device Sync from a SwiftUI client application. This repo is generated from source code in https://github.com/mongodb-university/realm-template-apps
Swift
16
star
95

docs-worker-pool

TypeScript
15
star
96

jasper

Jasper is a Process Management Framework
Go
15
star
97

grip

Go
15
star
98

go-client-mongodb-ops-manager

An HTTP client for Ops Manager and Cloud Manager Public API endpoints.
Go
15
star
99

vault-plugin-secrets-mongodbatlas

ARCHIVED - Hashicorp Vault MongoDB Atlas Secrets Engine - Now hosted at https://github.com/hashicorp/vault-plugin-secrets-mongodbatlas/
Go
15
star
100

docs-java

MongoDB Java driver documentation
Java
14
star