Loading...

XML

Word

Printable

JSON

Quarter:
- FY26Q2
Story Points:
3
Upstream Changes Summary:
Hide

DRIVERS-2985:
Summary of necessary driver changes

Add API to MongoClient to support appending metadata (driver name, version, platform) after it’s been created and initialized.

Commits for syncing spec/prose tests
(and/or refer to an existing language POC if needed)

Unified spec tests:

yml

json

Prose tests: README
Show
DRIVERS-2985 : Summary of necessary driver changes Add API to MongoClient to support appending metadata (driver name, version, platform) after it’s been created and initialized. Commits for syncing spec/prose tests (and/or refer to an existing language POC if needed) Unified spec tests: yml json Prose tests: README
Compass/DevTools Changes:
Not Needed
Confidence Status:
None

Investigation Summary:

Hide

Create a copy of the Kickoff Template with the issue key (NODE-XXX) in the filename and share a link to the new doc via this field.

Show
Create a copy of the Kickoff Template with the issue key (NODE-XXX) in the filename and share a link to the new doc via this field.

Documentation Changes:
Needed
Documentation Changes Summary:
Hide

Users can now append driver information to the metadata that will be passed along with the initial handshake on any new connection that gets opened. Fields available are name, version, and platform.

import { MongoClient } from 'mongodb'; const client = new MongoClient(process.env.MONGODB_URI); client.appendMetadata({ name: 'my library', version: '1.0', platform: 'NodeJS' });
Show
Users can now append driver information to the metadata that will be passed along with the initial handshake on any new connection that gets opened. Fields available are name , version , and platform . import { MongoClient } from 'mongodb' ; const client = new MongoClient(process.env.MONGODB_URI); client.appendMetadata({ name: 'my library' , version: '1.0' , platform: 'NodeJS' });

This ticket was split from DRIVERS-2985, please see that ticket for a detailed description.

AC:

Add new DriverInfoOptions interface with name, version, platform properties
Implement appendMetadata on the MongoClient that appends the 3 options to the existing client metadata.

Testing:

Docs:

Document the new API in our API docs and in the MongoDB manual so that extension developers can easily reference it

split from

DRIVERS-2985 Allow Instantiated MongoClients to Send Client Metadata On-Demand

1.	Send on demand client metadata	NODE-7009		Closed	Durran Jordan	6.18.0
2.	Validation	NODE-7010		Closed	Daria Pardue