Netzo

🇺🇸 EN

🇪🇸 ES

🇺🇸 EN

🇪🇸 ES

Appearance

On this page
netzo/apis/mongodbatlasdata

MongoDB Atlas Data ​

MongoDB Atlas Data is a cloud-based database service that provides all of the features of the MongoDB database in a simple, easy-to-use platform.

  • labels: database, nosql, cloud, cloud-hosting
  • authentication: apiKey

Usage ​

ts
import { mongodbatlasdata } from 'https://deno.land/x/netzo/apis/mongodbatlasdata/mod.ts'

const { api } = mongodbatlasdata({
  apiKey: Deno.env.get('MONGODBATLASDATA_API_KEY'),
  dataApiAppId: Deno.env.get('MONGODBATLASDATA_DATA_API_APP_ID')
})
import { mongodbatlasdata } from 'https://deno.land/x/netzo/apis/mongodbatlasdata/mod.ts'

const { api } = mongodbatlasdata({
  apiKey: Deno.env.get('MONGODBATLASDATA_API_KEY'),
  dataApiAppId: Deno.env.get('MONGODBATLASDATA_DATA_API_APP_ID')
})

Configuration ​

The mongodbatlasdata factory function expects an object with the following, and returns an object with an HTTP client api.

ParamTypeDefaultDescription
apiKeystringDeno.env.get('MONGODBATLASDATA_API_KEY') the api key to use for authentication
dataApiAppIdstringDeno.env.get('MONGODBATLASDATA_DATA_API_APP_ID')the app id

Refer to the API documentation to get the required information.

Examples ​

The following examples assume you have created an api client instance. Refer to the type definitions for all exported types to pass to the api client for typed responses.

Find documents ​

Find all documents that match a query.

ts
import type { Documents, QueryDocuments } from 'netzo/apis/mongodbatlasdata/types.ts'

const query: QueryDocuments = {
  dataSource: 'mongodb-atlas',
  database: DATABASE_NAME,
  collection: COLLECTION_NAME,
  filter: {
    text: 'Example entry'
  }
}
const result = await api.action.find.post<Documents | null>(query)
const resultData = result.documents
import type { Documents, QueryDocuments } from 'netzo/apis/mongodbatlasdata/types.ts'

const query: QueryDocuments = {
  dataSource: 'mongodb-atlas',
  database: DATABASE_NAME,
  collection: COLLECTION_NAME,
  filter: {
    text: 'Example entry'
  }
}
const result = await api.action.find.post<Documents | null>(query)
const resultData = result.documents

Add document ​

Add a document to a collection.

ts
import type { AddDocumentResult, DataAddDocument } from 'netzo/apis/mongodbatlasdata/types.ts'

const data: DataAddDocument = {
  dataSource: 'mongodb-atlas',
  database: DATABASE_NAME,
  collection: COLLECTION_NAME,
  document: { DATA_TO_ADD },
}
const resultData = await api.action.insertOne.post<AddDocumentResult>(data)
import type { AddDocumentResult, DataAddDocument } from 'netzo/apis/mongodbatlasdata/types.ts'

const data: DataAddDocument = {
  dataSource: 'mongodb-atlas',
  database: DATABASE_NAME,
  collection: COLLECTION_NAME,
  document: { DATA_TO_ADD },
}
const resultData = await api.action.insertOne.post<AddDocumentResult>(data)

Update document ​

Update a specific document.

ts
import type { DataUpdateDocument, UpdateDocumentResult } from 'netzo/apis/mongodbatlasdata/types.ts'

const data: DataUpdateDocument = {
  dataSource: 'mongodb-atlas',
  database: DATABASE_NAME,
  collection: COLLECTION_NAME,
  filter: { FILTERS },
  update: { DATA_TO_UPDATE },
}
const resultData = await api.action.updateOne.post<UpdateDocumentResult>(data)
import type { DataUpdateDocument, UpdateDocumentResult } from 'netzo/apis/mongodbatlasdata/types.ts'

const data: DataUpdateDocument = {
  dataSource: 'mongodb-atlas',
  database: DATABASE_NAME,
  collection: COLLECTION_NAME,
  filter: { FILTERS },
  update: { DATA_TO_UPDATE },
}
const resultData = await api.action.updateOne.post<UpdateDocumentResult>(data)

References ​

Copyright © 2023 Netzo