Endpoint

Delete a Document by Id

Name

delete_document

Description

Deletes a Document by Id. [API reference]

Related Tables

[Dynamic Table]

Parameters

Parameter

Label

Required

Options

Description

Document Id

YES

Table

Table Name (Case-Sensitive)

YES

Database

Database Name (keep blank to use default) Case-Sensitive

Leave blank to use default DB set on connection screen

EnableCrossPartition

Option	Value
true	true
false	false

PartitionKey

Partition Key Value (default is supplied Id)

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
Id	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
Status	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
Table	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
StatusCode	`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
Id	`DT_WSTR`	`nvarchar(4000)`	4000	`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:

Delete rows from [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]

Delete

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Delete a document by id

SELECT * FROM delete_document
WHERE Id = 'abcd-1234-id'
WITH
(
    "Table" = 'abcd-1234-table'
)

delete_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:

Delete a document by id

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM delete_document
WHERE Id = ''abcd-1234-id''
WITH
(
    "Table" = ''abcd-1234-table''
)';

EXEC (@MyQuery) AT [LS_TO_COSMOS_DB_IN_GATEWAY];

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