MongoDB Swift Driver

Introduction

Welcome to the documentation site for the official MongoDB Swift driver. You can add the driver to your application to work with MongoDB in Swift. Download it with the Swift Package Manager or set up a runnable project with examples from our Usage Guide.

• Usage Guide

• API Reference

• Changelog

• Source Code

Installation

See Installation

Connect to MongoDB Atlas

To connect to a MongoDB Atlas cluster, use the Atlas connection string for your cluster:

import MongoSwiftSync
defer {
    // free driver resources
    cleanupMongoSwift()
}
// replace the following string with your connection uri
let uri = "mongodb+srv://<username>:<password>@<cluster-address>/test?w=majority"
let client = try MongoClient(uri)
// print a list of database names
print (try client.listDatabaseNames())
// your application logic

import MongoSwift
import NIO
let elg = MultiThreadedEventLoopGroup(numberOfThreads: 4)
// replace the following string with your connection uri
let uri = "mongodb+srv://<username>:<password>@<cluster-address>/test?w=majority"
let client = try MongoClient(
    uri,
    using: elg
)
defer {
    // clean up driver resources
    try? client.syncClose()
    cleanupMongoSwift()
    // shut down EventLoopGroup
    try? elg.syncShutdownGracefully()
}
// print a list of database names
print(try client.listDatabaseNames().wait())
// your application logic

Connect to a MongoDB Server on Your Local Machine

If you need to run a MongoDB server on your local machine for development purposes instead of using an Atlas cluster, you need to complete the following:

1. Download the Community or Enterprise version of MongoDB Server.

2. Install and configure MongoDB Server.

3. Start the server.

After you successfully start your MongoDB server, specify your connection string in your driver connection code.

If your MongoDB Server is running locally, you can use the connection string "mongodb://localhost:<port>" where <port> is the port number you configured your server to listen for incoming connections.

If you need to specify a different hostname or IP address, see our Server Manual entry on Connection Strings.

To test whether you can connect to your server, replace the connection string in the Connect to MongoDB Atlas code example and run it.

Compatibility