deleteDocument: Deletes a single document from a collection.

In timoklimmer/documentdbr: Use Azure DocumentDB from R

Description

Deletes a single document from a collection.

Usage

deleteDocument(connectionInfo, documentId, partitionKey = "",
  consistencyLevel = "", sessionToken = "", userAgent = "")

Arguments

connectionInfo	A DocumentDB connection info object generated with getDocumentDBConnectionInfo().
documentId	The ID of the document to delete.
partitionKey	Optional. The partition key value for the document to be deleted. Must be included if and only if the collection is created with a partitionKey definition.
consistencyLevel	Optional. The consistency level override. The valid values are: Strong, Bounded, Session, or Eventual (in order of strongest to weakest). The override must be the same or weaker than the account's configured consistency level.
sessionToken	Optional. A string token used with session level consistency. For more information, see Using consistency levels in DocumentDB.
userAgent	Optional. A string that specifies the client user agent performing the request. The recommended format is user agent name/version. For example, the official DocumentDB .NET SDK sets the User-Agent string to Microsoft.Document.Client/1.0.0.0. A custom user-agent could be something like ContosoMarketingApp/1.0.0.

Value

Some information extracted from the REST API response such as request charge and session token.

Examples

# load the documentdbr package
library(documentdbr)

# get a DocumentDBConnectionInfo object
myCollection <- getDocumentDBConnectionInfo(
  accountUrl = "https://somedocumentdbaccount.documents.azure.com",
  primaryOrSecondaryKey = "t0C36UstTJ4c6vdkFyImkaoB6L1yeQidadg6wasSwmaK2s8JxFbEXQ0e3AW9KE1xQqmOn0WtOi3lxloStmSeeg==",
  databaseId = "MyDatabaseId",
  collectionId = "MyCollectionId"
)

# delete the document with id fe7718ad-0000-4f42-cf5a-e2d79d2156df
deleteResult <- deleteDocument(myCollection, documentId = "fe7718ad-0000-4f42-cf5a-e2d79d2156df")

# print the request charge
print(deleteResult$requestCharge)

timoklimmer/documentdbr documentation built on May 31, 2019, 2:29 p.m.