[SERVER-48764] Document Server-Internal Data Structures and Views Created: 11/Jun/20  Updated: 06/Dec/22

Status: Backlog
Project: Core Server
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Major - P3
Reporter: Benjamin Caimano (Inactive) Assignee: Backlog - Service Architecture
Resolution: Unresolved Votes: 0
Labels: sa-remove-fv-backlog-22
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Assigned Teams:
Service Arch
Backwards Compatibility: Fully Compatible
Participants:

 Description   

We have a decent handful of unique data structures and views that we have accumulated over our history. Most of them were created to serve specific needs for specific teams, however, they tend to become generally available.

Notable classes include:

  • DataRange (in src/mongo/base)
  • StringData (in src/mongo/base)
  • Timestamp (in src/mongo/bson)
  • OID (in src/mongo/bson)
  • AtomicWord (in src/mongo/platform)
  • Decimal128 (in src/mongo/platform)
  • stdx::unordered_map/stdx::unordered_set (in src/mongo/stdx)
  • BufReader (in src/mongo/util)
  • LRUCache (in src/mongo/util)
  • UUID (in src/mongo/util)

To make it easier for people to discover these types, we should make a new markdown file docs/data_structures_and_views.md. A heading and a few sentences should suffice on each of these types.

This is intended to be abstract documentation, describe relationships and state transitions not code in common language.


Generated at Thu Feb 08 05:18:01 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.