EndPoint Update Document in the Container
Name
update_document
Description
Update full or part of the document in Cosmos DB Container. [API reference]
Parameters
| Parameter | Label | Required | Options | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Table | Table Name (Case-Sensitive) | YES | ||||||||||
| Id | Document Id | 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 | Full Document if RequestMethod=PUT else Partial Document [API reference] | |||||||||
| PartitionKey | Partition Key Value (default is supplied Id) | NO |
|
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 |
Input Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Raw | Description |
|---|---|---|---|---|---|
| RequestMethod |
DT_WSTR
|
nvarchar(4000)
|
4000 | False |
|
| PartitionKey |
DT_WSTR
|
nvarchar(4000)
|
4000 | False |
|
| Id |
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:
Update rows in [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]
Update
