AzureCosmosR (version 1.0.0)

get_stored_procedure: Methods for working with Azure Cosmos DB stored procedures

Description

Methods for working with Azure Cosmos DB stored procedures

Usage

get_stored_procedure(object, ...)
# S3 method for cosmos_container
get_stored_procedure(object, procname, ...)
list_stored_procedures(object, ...)
create_stored_procedure(object, ...)
# S3 method for cosmos_container
create_stored_procedure(object, procname, body, ...)
exec_stored_procedure(object, ...)
# S3 method for cosmos_container
exec_stored_procedure(object, procname, parameters = list(), ...)
# S3 method for cosmos_stored_procedure
exec_stored_procedure(object, ...)
replace_stored_procedure(object, ...)
# S3 method for cosmos_container
replace_stored_procedure(object, procname, body, ...)
# S3 method for cosmos_stored_procedure
replace_stored_procedure(object, body, ...)
delete_stored_procedure(object, ...)
# S3 method for cosmos_container
delete_stored_procedure(object, procname, confirm = TRUE, ...)
# S3 method for cosmos_stored_procedure
delete_stored_procedure(object, ...)

Arguments

object

A Cosmos DB container object, as obtained by get_cosmos_container or create_cosmos_container, or for delete_stored_procedure.cosmos_stored_procedure, the stored procedure object.

...

Optional arguments passed to lower-level functions.

procname

The name of the stored procedure.

body

For create_stored_procedure and replace_stored_procedure, the body of the stored procedure. This can be either a character string containing the source code, or the name of a source file.

parameters

For exec_stored_procedure, a list of parameters to pass to the procedure.

confirm

For delete_stored_procedure, whether to ask for confirmation before deleting.

Value

For get_stored_procedure and create_stored_procedure, an object of class cosmos_stored_procedure. For list_stored_procedures, a list of such objects.

Details

These are methods for working with stored procedures in Azure Cosmos DB using the core (SQL) API. In the Cosmos DB model, stored procedures are written in JavaScript and associated with a container.

See Also

cosmos_container, get_udf

Examples

# NOT RUN {
endp <- cosmos_endpoint("https://myaccount.documents.azure.com:443/", key="mykey")
db <- get_cosmos_database(endp, "mydatabase")
cont <- create_cosmos_container(db, "mycontainer", partition_key="sex")

# a simple stored procedure
src <- 'function helloworld() {
   var context = getContext();
    var response = context.getResponse();
    response.setBody("Hello, World");
}'
create_stored_procedure(cont, "helloworld", src)
sproc <- get_stored_procedure(cont, "helloworld")
exec_stored_procedure(sproc)

# more complex example: uploading data
sproc2 <- create_stored_procedure(cont, "myBulkUpload",
    body=system.file("srcjs/bulkUpload.js", package="AzureCosmosR"))

list_stored_procedures(cont)

sw_male <- dplyr::filter(dplyr::starwars, sex == "male")
exec_stored_procedure(sproc2, parameters=list(sw_male))

delete_stored_procedure(sproc)
delete_stored_procedure(sproc2)

# }