Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
MongoDB.ServerDescriptions
Fetches an server descroptions for all known servers in the topology.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
MongoDB | 12.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "MongoDB.ServerDescriptions"; MongoDBRef ) More
Parameters
Parameter | Description | Example |
---|---|---|
MongoDBRef | The reference number for the mongo connection. | $MongoDB |
Result
Returns JSON array or error.
Description
Fetches an server descroptions for all known servers in the topology.Returns no servers until the client connects. Returns a single server if the client is directly connected, or all members of a replica set if the client’s MongoDB URI includes a “replicaSet” option, or all known mongos servers if the MongoDB URI includes a list of them.
See also
Example Databases
Blog Entries
This function checks for a license.
Created 19th June 2022, last changed 19th June 2022