Skip to content

Latest commit

 

History

History
93 lines (67 loc) · 3.54 KB

README.md

File metadata and controls

93 lines (67 loc) · 3.54 KB
Raw

go-client-mongodb-atlas

PkgGoDev CI

Warning

go-client-mongodb-atlas is deprecated and doesn't receive feature updates. We recommend migrating to the Atlas Go SDK for the latest changes. To learn how to migrate from go-client-mongodb-atlas to the Atlas Go SDK, see the migration guide.

A Go HTTP client for the MongoDB Atlas API.

Note that go-client-mongodb-atlas only supports the two most recent major versions of Go.

Usage

import "go.mongodb.org/atlas/mongodbatlas"

Construct a new Atlas client, then use the various services on the client to access different parts of the Atlas API. For example:

client := mongodbatlas.NewClient(nil)

The services of a client divide the API into logical chunks and correspond to the structure of the Atlas API documentation at https://docs.atlas.mongodb.com/api/.

NOTE: Using the context package, one can easily pass cancellation signals and deadlines to various services of the client for handling a request. In case there is no context available, then context.Background() can be used as a starting point.

Authentication

The go-client-mongodb-atlas library does not directly handle authentication. Instead, when creating a new client, pass an http.Client that can handle Digest Access authentication for you. The easiest way to do this is using the digest library, but you can always use any other library that provides an http.Client. If you have a private and public API token pair (https://docs.atlas.mongodb.com/configure-api-access), you can use it with the digest library like:

import (
    "context"
    "log"

    "github.com/mongodb-forks/digest"
    "go.mongodb.org/atlas/mongodbatlas"
)

func main() {
    t := digest.NewTransport("your public key", "your private key")
    tc, err := t.Client()
    if err != nil {
        log.Fatalf(err.Error())
    }

    client := mongodbatlas.NewClient(tc)
    projects, _, err := client.Projects.GetAllProjects(context.Background(), nil)
}

Note that when using an authenticated Client, all calls made by the client will include the specified tokens. Therefore, authenticated clients should almost never be shared between different users.

Versioning

Each version of the client is tagged and the version is updated accordingly.

To see the list of past versions, run git tag.

To release a new version, first ensure that Version is updated (i.e., before running git push origin vx.y.z, verify that Version=x.y.z should match the tag being pushed to GitHub)

Roadmap

This library is being initially developed for mongocli, Atlas Terraform Provider, Atlas Vault Plugin, and Atlas Cloudformation Provider so API methods will likely be implemented in the order that they are needed by those projects.

Contributing

See our CONTRIBUTING.md Guide.

License

go-client-mongodb-atlas is released under the Apache 2.0 license. See LICENSE