CosmosDB

Overview

Note: Please contact us at [e-mail] to enable this Destination Connector.

CosmosDB is a NoSQL document store which stores data in a JSON-like format without a specified schema. This Destination Connector allows you to write documents to a single collection from Osmos. We require you to define a destination schema, and all the data written to your Cosmos instance will adhere to this schema.

This Destination Connector can write to a CosmosDB table using your CosmosDB username and password, so you can ingest clean data into your CosmosDB table.

We use the Azure Cosmos DB API for MongoDB. More information can be found here.

Prerequisites

You need to have a CosmosDB instance that will accept connection attempts from the following fixed IP addresses: 35.222.106.198/32, 35.232.180.174/32.

You must have a connection string provided by the database from which to connect your DB.

Creating a CosmosDB Source Connector

Step 1: After selecting + New Connector, under the System prompt, click CosmosDB.

Step 2: Provide a name for this Destination Connector.

Step 3: Select Destination Connector. Selecting this allows you to send data to CosmosDB.

Step 4: Provide the connection string leaving out the username and password.

For more information about formatting the connection string, visit: https://docs.microsoft.com/en-us/azure/cosmos-db/mongodb/connect-mongodb-account.

Step 5: Provide your username.

Step 6: Provide the password associated with the username above.

Step 7: Provide the name of the database that contains the collections you want to write to.

If you are trying to access a database that is behind a firewall, please ensure that the following Osmos IP addresses are allowed to access the database. Osmos uses these fixed IP addresses to access your sources and destinations:

35.222.106.198/32

35.232.180.174/32

Step 8: Provide the name of the collection that you want to write to.

The schema for this Destination Connector is defined by the collection schema.

For any fields that have a primary key, foreign key, or other constraints, you may either (1) ensure that the source data mapped to the field satisfies those constraints or (2) leave that filed empty and ensure that your database is set up to auto populate those fields with appropriate constraint-satisfying data.

Step 9: Use the schema designer to build the output schema for this Destination Connector.

Field name: Provide a field name for the output fields. These names will be used as the column headers or field names in the output file you are writing to.

Type: Define the type of each field. The field types will be used to enforce rules when you send data to this Destination Connector.

Nullable: Check this box if the field is nullable. If the field id not nullable, you will be required to provide values for this field when sending data to this Destination Connector.

The schema cannot be changed after saving the Destination Connector, so please confirm it is accurate before proceeding.

Advanced Options

Validation Webhook

We support the use of Validation Webhooks to prevent bad data from being written to your systems, adding another layer of protection to the built-in validations that Osmos provides. The Webhook URL can be posted here.

For more information on Validation Webhook configuration, see Server Side Validation Webhooks