ADO.NET Provider for Azure Cosmos DB

Build 24.0.9060

DELETE Statements

To delete information from a table, use DELETE statements.

DELETE Syntax

The DELETE statement requires the table name in the FROM clause and the row's primary key in the WHERE clause, as shown in the following example:

<delete_statement> ::= DELETE FROM <table_name> WHERE { _id = <expression> } [ { AND | OR } ... ]

<expression> ::=
  | @ <parameter> 
  | ?
  | <literal>

You can use the ExecuteNonQuery method to execute data manipulation commands and retrieve the number of affected rows, as shown in the following example:

C#

String connectionString = "AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;";
using (CosmosDBConnection connection = new CosmosDBConnection(connectionString)) {
  int rowsAffected;
  CosmosDBCommand cmd = new CosmosDBCommand("DELETE FROM [CData].[Entities].Customers WHERE _id = @my_id", connection);
  cmd.Parameters.Add(new CosmosDBParameter("my_id","22"));
  rowsAffected = cmd.ExecuteNonQuery();
}

VB.NET

  
Dim connectionString As [String] = "AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;"
Using connection As New CosmosDBConnection(connectionString)
  Dim rowsAffected As Integer
  Dim cmd As New CosmosDBCommand("DELETE FROM [CData].[Entities].Customers WHERE _id = @my_id", connection)
  cmd.Parameters.Add(New CosmosDBParameter("my_id", "22"))
  rowsAffected = cmd.ExecuteNonQuery()
End Using

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060