MongoDB Basics: Naming Conventions

Why Naming Conventions Matter in MongoDB

MongoDB is a flexible NoSQL database that allows dynamic schemas. However, without consistent naming, managing collections and documents can become confusing.

Proper naming conventions improve collaboration among teams and make it easier to write queries, maintain indexes, and integrate with applications.

• Enhances code readability and maintainability.
• Prevents conflicts and errors in queries and indexes.
• Facilitates easier onboarding of new developers.
• Supports better documentation and tooling.

General Naming Guidelines

MongoDB imposes some restrictions and recommendations on naming databases, collections, and fields.

Following these general guidelines ensures compatibility and avoids unexpected issues.

• Use lowercase letters to avoid case sensitivity issues.
• Avoid spaces and special characters like $, ., and null characters.
• Keep names concise but descriptive.
• Do not start collection names with system. as it is reserved.
• Avoid using MongoDB reserved words as names.

Naming Databases

Database names should be simple and reflect the purpose or domain of the data.

MongoDB database names have a maximum length of 64 characters.

• Use lowercase letters and numbers.
• Avoid special characters and spaces.
• Choose meaningful names like salesdb, inventory, or user_data.

Naming Collections

Collections store documents and are similar to tables in relational databases.

Naming collections clearly helps identify the type of data stored.

• Use plural nouns to represent multiple documents, e.g., users, orders.
• Use camelCase or underscores to separate words, e.g., userProfiles or user_profiles.
• Avoid dots (.) and dollar signs ($) in collection names.
• Do not prefix with system. as it is reserved for internal collections.

Naming Fields

Fields represent attributes of documents and should be named to clearly describe the data they hold.

Consistent field naming improves query clarity and schema understanding.

• Use camelCase or underscores for multi-word field names, e.g., firstName or first_name.
• Avoid spaces and special characters.
• Keep field names short but descriptive.
• Avoid using reserved MongoDB operators like $ or starting field names with $.

Examples of Good and Bad Naming

Here are some examples illustrating recommended naming conventions.