@gmmurray/mongodb-atlas-data-api

A client library for interacting with the Atlas Data API.

Prerequisites

This library requires the following dependencies:

• axios for making HTTP requests.

1$ npm install axios

Table of Contents

• @gmmurray/mongodb-atlas-data-api
  • Prerequisites
  • Table of Contents
  • Getting Started
  • Installation
  • Usage
    • Creating the Client
    • Find One Document
    • Find Many Documents
    • Insert One Document
    • Insert Many Documents
    • Update One Document
    • Update Many Documents
    • Replace One Document
    • Delete One Document
    • Delete Many Documents
    • Aggregate Documents
  • API Reference
  • Credits

Getting Started

These instructions will help you get started with using the Atlas Data API Client in your project.

Installation

To install the library, run the following command:

1$ npm install atlas-data-api-client

Alternatively, you can use Yarn:

1$ yarn add atlas-data-api-client

Usage

In these examples we use a made up customer interface:

1interface Customer {
2  id: string;
3  name: string;
4  age: number;
5}

Creating the Client

1import AtlasDataApiClient, {
2  AtlasDataApiClientOptions,
3} from '@gmmurray/atlas-data-api-client';
4
5const options: AtlasDataApiClientOptions = {
6  apiKey: 'YOUR_API_KEY',
7  dataApiUrlEndpoint: 'your-app-url-endpoint',
8  defaultDataSource: 'your-default-data-source',
9  defaultDatabase: 'your-default-database',
10};
11
12const apiClient = new AtlasDataApiClient(options);

Find One Document

1const request: FindOneDocumentRequest<Customer> = {
2  collection: 'your-collection',
3  filter: { name: 'John Doe' },
4};
5
6const response: FindOneApiResponse<Customer> = await apiClient.findOneDocument(
7  request,
8);
9
10console.log(response);

Find Many Documents

1const request: FindManyDocumentsRequest<Customer> = {
2  collection: 'your-collection',
3  filter: { age: { $gte: 18 } },
4  sort: { name: 1 },
5  pageSize: 10,
6  pageNumber: 1,
7};
8
9const response: FindManyApiResponse<Customer> = await apiClient.findDocuments(
10  request,
11);
12
13console.log(response);

Insert One Document

1const request: InsertOneDocumentRequest<Customer> = {
2  collection: 'your-collection',
3  document: { name: 'John Doe', age: 25 },
4};
5
6const response: InsertOneApiResponse = await apiClient.insertOneDocument(
7  request,
8);
9
10console.log(response);

Insert Many Documents

1const request: InsertManyDocumentsRequest<Customer> = {
2  collection: 'your-collection',
3  documents: [
4    { name: 'John Doe', age: 25 },
5    { name: 'Jane Smith', age: 30 },
6  ],
7};
8
9const response: InsertManyApiResponse = await apiClient.insertManyDocuments(
10  request,
11);
12
13console.log(response);

Update One Document

1const request: UpdateOneDocumentRequest<Customer> = {
2  collection: 'your-collection',
3  filter: { id: '123' },
4  update: { name: 'John Doe', age: 26 },
5  upsert: true,
6};
7
8const response: UpdateOneApiResponse = await apiClient.updateOneDocument(
9  request,
10);
11
12console.log(response);

Update Many Documents

1const request: UpdateManyDocumentsRequest<Customer> = {
2  collection: 'your-collection',
3  filter: { age: { $gte: 18 } },
4  update: { status: 'active' },
5  upsert: true,
6};
7
8const response: UpdateManyApiResponse = await apiClient.updateManyDocuments(
9  request,
10);
11
12console.log(response);

Replace One Document

1const request: ReplaceOneDocumentRequest<Customer> = {
2  collection: 'your-collection',
3  filter: { id: '123' },
4  replacement: { id: '123', name: 'John Doe', age: 27 },
5  upsert: true,
6};
7
8const response: ReplaceOneApiResponse = await apiClient.replaceOneDocument(
9  request,
10);
11
12console.log(response);

Delete One Document

1const request: DeleteOneDocumentRequest<Customer> = {
2  collection: 'your-collection',
3  filter: { id: '123' },
4};
5
6const response: DeleteOneApiResponse = await apiClient.deleteOneDocument(
7  request,
8);
9
10console.log(response);

Delete Many Documents

1const request: DeleteManyDocumentsRequest<Customer> = {
2  collection: 'your-collection',
3  filter: { age: { $gte: 18 } },
4};
5
6const response: DeleteManyApiResponse = await apiClient.deleteManyDocuments(
7  request,
8);
9
10console.log(response);

Aggregate Documents

1const request: AggregateDocumentsRequest = {
2  collection: 'your-collection',
3  pipeline: [
4    { $match: { age: { $gte: 18 } } },
5    { $group: { _id: '$gender', count: { $sum: 1 } } },
6  ],
7};
8
9const response: AggregateApiResponse = await apiClient.aggregateDocuments(
10  request,
11);
12
13console.log(response);

API Reference

Method	Description
findOneDocument(request: FindOneDocumentRequest): Promise<FindOneApiResponse>	Finds a single document in the specified collection.
findDocuments(request: FindManyDocumentsRequest): Promise<FindManyApiResponse>	Finds multiple documents in the specified collection.
insertOneDocument(request: InsertOneDocumentRequest): Promise	Inserts a single document into the specified collection.
insertManyDocuments(request: InsertManyDocumentsRequest): Promise	Inserts multiple documents into the specified collection.
updateOneDocument(request: UpdateOneDocumentRequest): Promise	Updates a single document in the specified collection.
updateManyDocuments(request: UpdateManyDocumentsRequest): Promise	Updates multiple documents in the specified collection.
replaceOneDocument(request: ReplaceOneDocumentRequest): Promise	Replaces a single document in the specified collection.
deleteOneDocument(request: DeleteOneDocumentRequest): Promise	Deletes a single document from the specified collection.
deleteManyDocuments(request: DeleteManyDocumentsRequest): Promise	Deletes multiple documents from the specified collection.
aggregateDocuments(request: AggregateDocumentsRequest): Promise	Performs an aggregation on the specified collection.

For more details on each method and their request/response types, please refer to the source code documentation.

Credits

• Axios
• README template