Cosmos DB Connector for Alteryx : Delete a document by ID via SQL

Learn how to delete a document by ID using the Cosmos DB Connector for Alteryx. This connector enables you to read and write Azure Cosmos DB data effortlessly. Query, integrate, and manage databases, containers, documents, and users — almost no coding required. We'll walk you through the exact setup.

Let's dive in!

Create data source using Cosmos DB ODBC Driver

1. Download and install ODBC PowerPack (if you haven't already).

2. Search for odbc and open the ODBC Data Sources (64-bit):

   

3. Create a User data source (User DSN) based on the ZappySys API Driver driver:

   ZappySys API Driver

   
   • Create and use a User DSN if the client application runs under a User Account. This is the ideal option at design time (e.g., when developing in Visual Studio). Use it for both types of applications (64-bit and 32-bit).
   • Create and use a System DSN if the client application runs under a System Account (e.g., as a Windows Service). This is usually the required option in a production environment. If your Windows Service is a 32-bit application, you must use the 32-bit ODBC Data Source Administrator to configure this

4. When the Configuration window appears give your data source a name if you haven't done that already, then select "Cosmos DB" from the list of Popular Connectors. If "Cosmos DB" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

   CosmosDbDSN

   Cosmos DB

   

5. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

   API Key

   Cosmos DB authentication

   Connecting to your Azure Cosmos DB data requires you to authenticate your REST API access. Follow the instructions below:

   1. Go to your Azure portal homepage: https://portal.azure.com/.
   2. In the search bar at the top of the homepage, enter Azure Cosmos DB. In the dropdown that appears, select Azure Cosmos DB.
   3. Click on the name of the database account you want to connect to (also copy and paste the name of the database account for later use).
   4. On the next page where you can see all of the database account information, look along the left side and select Keys:
   5. On the Keys page, you will have two tabs: Read-write Keys and Read-only Keys. If you are going to write data to your database, you need to remain on the Read-write Keys tab. If you are only going to read data from your database, you should select the Read-only Keys tab.
   6. On the Keys page, copy the PRIMARY KEY value and paste it somewhere for later use (the SECONDARY KEY value may also be copied and used).
   7. Now go to SSIS package or ODBC data source and use this PRIMARY KEY in API Key authentication configuration.
   8. Enter the primary or secondary key you recorded in step 6 into the Primary or Secondary Key field.
   9. Then enter the database account you recorded in step 3 into the Database Account field.
   10. Next, enter or select the default database you want to connect to using the Default Database field.
   11. Continue by entering or selecting the default table (i.e. container/collection) you want to connect to using the Default Table (Container/Collection) field.
   12. Select the Test Connection button at the bottom of the window to verify proper connectivity with your Azure Cosmos DB account.
   13. If the connection test succeeds, select OK.
   14. Done! Now you are ready to use Cosmos DB Connector!

   API Connection Manager configuration

   Just perform these simple steps to finish authentication configuration:

   1. Set Authentication Type to API Key [Http]
   2. Optional step. Modify API Base URL if needed (in most cases default will work).
   3. Fill in all the required parameters and set optional parameters if needed.
   4. Finally, hit OK button:

   CosmosDbDSN

   Cosmos DB

   API Key [Http]

   https://[$Account$].documents.azure.com

   Required Parameters
   Primary or Secondary Key	Fill-in the parameter...
   Account Name (Case-Sensitive)	Fill-in the parameter...
   Database Name (keep blank to use default) Case-Sensitive	Fill-in the parameter...
   API Version	Fill-in the parameter...
   Optional Parameters
   Default Table (needed to invoke #DirectSQL)

   

6. Then go to Preview tab to start building a SQL query.

7. Once you do that, proceed by opening Query Builder:

   

   ZappySys API Driver - Cosmos DB

   Read and write Azure Cosmos DB data effortlessly. Query, integrate, and manage databases, containers, documents, and users — almost no coding required.

   CosmosDbDSN

   

8. Then simply select the Delete a Document by Id endpoint (action).

9. Continue by configuring the Required parameters. You can also set optional parameters too.

10. Move on by hitting Preview Data button to preview the results.

11. If you see the results you need, simply copy the generated query:

    Delete a Document by Id

    Required Parameters
    Document Id	Select the value from the dropdown
    Table Name (Case-Sensitive)	Select the value from the dropdown
    Optional Parameters
    Database Name (keep blank to use default) Case-Sensitive
    EnableCrossPartition	true
    Partition Key Value (default is supplied Id)
    Advanced Properties
    RawOutputDataRowTemplate
    EnableRawOutputModeSingleRow	True
    ContineOnErrorForStatusCode	True
    ErrorStatusCodeToMatchRegex	404|405

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

    

12. Click OK to use built SQL query and close the Query Builder.

13. Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in Alteryx:

    

    ZappySys API Driver - Cosmos DB

    Read and write Azure Cosmos DB data effortlessly. Query, integrate, and manage databases, containers, documents, and users — almost no coding required.

    CosmosDbDSN

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

    
    You can also access data quickly from the tables dropdown by selecting <Select table>.
    A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the Cosmos DB API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Cosmos DB servers).

Let's not stop here and explore SQL query examples, including how to use them in Stored Procedures and Views (virtual tables) in the next steps.

Cosmos DB SQL query examples

Use these SQL queries in your Alteryx data source:

Delete a document by id

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

Create SQL view in ODBC data source

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
   

2. Enter the desired Table name and click on OK:
   

3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
   Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
   

   SELECT
     "ShipCountry",
     "OrderID",
     "CustomerID",
     "EmployeeID",
     "OrderDate",
     "RequiredDate",
     "ShippedDate",
     "ShipVia",
     "Freight",
     "ShipName",
     "ShipAddress",
     "ShipCity",
     "ShipRegion",
     "ShipPostalCode"
   FROM "Orders"
   Where "ShipCountry"='USA'

   
   

5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:

   SELECT * FROM "vt__usa_orders_only"

   

Delete a document by ID in Alteryx via SQL view

1. Open Alteryx Designer.

2. First, verify your DCM Settings to ensure you can access ODBC drivers. Go to Options > User Settings > Edit User Settings.

   If DCM Mode is set to DCM Only, change it to DCM Optional if you would like to access the legacy Generic ODBC Connection.

   
   After changing this setting, you may need to click Save and restart the connection window for the "Generic ODBC" icon to appear.

3. Drag an Input Data tool onto your Alteryx canvas.

   

4. In the Configuration pane, click Set Up a Connection.

   

5. Note for DCM Users: If your environment has DCM (Data Connection Manager) enabled, the classic "Generic ODBC" icon may be hidden. To find it, select Data sources on the left and type "ODBC" in the search bar.

6. Once the ODBC window opens, click Connect Asset and select your CosmosDbDSN DSN from the list.

   
   Ensure you have configured a 64-bit System DSN in the Windows ODBC Data Source Administrator before this step.

7. After selecting your DSN, configure your SQL Query in the Input Data tool configuration:

   

8. To save your data, drag an Output Data tool and connect it to the Input Data tool.

9. Configure the Output Data tool to write to a CSV file:

   

10. Press Run (Ctrl+R) to execute the workflow. Verify the results in the Results Window at the bottom.

    

Advanced topics

Creating SQL stored procedures

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
   

2. Enter the desired Procedure name and click on OK:
   

3. Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver. Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

   CREATE PROCEDURE [usp_get_orders]
       @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
    AS
       SELECT * FROM Orders where OrderDate >= '<@fromdate>';
   

   

4. That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:

   Exec usp_get_orders '1996-01-01';

   

Conclusion

And there you have it — a complete guide on how to delete a document by ID in Alteryx without writing complex code. All of this was powered by Cosmos DB ODBC Driver, which handled the REST API pagination and authentication for us automatically.

Download the trial now or ping us via chat if you have any questions or are looking for a specific feature (you can also reach out to us by submitting a ticket):

More actions supported by Cosmos DB Connector

Got another use case in mind? We've documented the exact setups for a variety of essential Cosmos DB operations directly in Alteryx, so you can skip the trial and error. Find your next step-by-step guide below:

• Create a document in the container
• Create Permission Token for a User (One Table)
• Create User for Database
• Get All Documents for a Table
• Get All Users for a Database
• Get Database Information by Id or Name
• Get Document by Id
• Get List of Databases
• Get List of Tables
• Get table information by Id or Name
• Get table partition key ranges
• Get User by Id or Name
• Query documents using Cosmos DB SQL query language
• Update Document in the Container
• Upsert a document in the container
• Make Generic REST API Request
• Make Generic REST API Request (Bulk Write)

More Cosmos DB integrations

SSIS

SQL Server

Microsoft Fabric

Power BI

SSRS

Informatica PowerCenter

MS Access

Excel

SSAS

C#

Python

Java

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

UiPath

PowerShell

ODBC