deleteCollection: Deletes a collection.

In timoklimmer/documentdbr: Use Azure DocumentDB from R

Description

Deletes a collection.

Usage

deleteCollection(connectionInfo, collectionId, databaseId = "",
  consistencyLevel = "", sessionToken = "", userAgent = "")

Arguments

connectionInfo	A DocumentDB connection info object generated with getDocumentDBConnectionInfo().
collectionId	The ID of the collection to delete.
databaseId	Optional. The ID of the database in which to delete. If no database ID is specified, the ID will be taken from the connection info.
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)

# setup connection infos
myDocDB <- getDocumentDBConnectionInfo(
  accountUrl = "https://somedocumentdbaccount.documents.azure.com",
  primaryOrSecondaryKey = "t0C36UstTJ4c6vdkFyImkaoB6L1yeQidadg6wasSwmaK2s8JxFbEXQ0e3AW9KE1xQqmOn0WtOi3lxloStmSeeg==",
  databaseId = "MyDatabase"
)

# deletes the MyCollection collection (within MyDatabase as specified in the connection info)
# note: alternatively, the database id can be specified as parameter
deleteCollection(myDocDB, "MyCollection")

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