Cosmos DB Connector
Documentation
Version: 2
Documentation
Endpoint

Upsert a document in the container


Name

upsert_document

Description

Insert JSON document in Cosmos DB Container. [API reference]

Related Tables

[Dynamic Table]

Parameters

Parameter Label Required Options Description
Table Table Name (Case-Sensitive) YES
Upsert Upsert NO
Database Database Name (keep blank to use default) Case-Sensitive NO Leave blank to use default DB set on connection screen
Document Document NO
PartitionKey Partition Key Value (default is supplied Id) NO
Option Value
Default .
SingleKeyValue ["someValue1"]
MultiKeyValue ["some_value1","some_value2" ]
The partition key value for the document. Must be included if and only if the collection is created with a partitionKey definition

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
id DT_WSTR nvarchar(4000) 4000 False
_rid DT_WSTR nvarchar(4000) 4000 False
_ts DT_I8 bigint False
http_status DT_I4 int False
If the column you are looking for is missing, consider customizing Cosmos DB Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
PartitionKey DT_WSTR nvarchar(4000) 4000 False
Document DT_NTEXT nvarchar(MAX) False
Required columns that you need to supply are bolded.

Examples

SSIS

Use Cosmos DB Connector in API Source component to read data or in API Destination component to read/write data:

Upsert rows into [Dynamic Table] table using API Destination

This Endpoint belongs to [Dynamic Table] table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Cosmos DB
[Dynamic Table]
Upsert
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Upsert a document in the container

SELECT * FROM upsert_document

upsert_document endpoint belongs to [Dynamic Table] table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Upsert a document in the container

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM upsert_document';

EXEC (@MyQuery) AT [LS_TO_COSMOS_DB_IN_GATEWAY];

upsert_document endpoint belongs to [Dynamic Table] table(s), and can therefore be used via those table(s).