mongodbatlasdata
MongoDB Atlas Data API provides a programmatic interface to your Atlas clusters.
Usage
import { mongodbatlasdata } from 'netzo/apis/mongodbatlasdata.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 API client api.
| Param | Type | Default | Description |
|---|---|---|---|
apiKey | string | Deno.env.get('MONGODBATLASDATA_API_KEY') | the api key to use for authentication |
dataApiAppId | string | Deno.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.
Find documents
Find all documents that match a query.
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.
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.
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)