/// <summary> /// Creates a stored procedure as an asynchronous operation in the Azure Cosmos DB service. /// </summary> /// <param name="id">The cosmos stored procedure id</param> /// <param name="body">The JavaScript function that is the body of the stored procedure</param> /// <param name="requestOptions">(Optional) The options for the stored procedure request <see cref="CosmosRequestOptions"/></param> /// <param name="cancellationToken">(Optional) <see cref="CancellationToken"/> representing request cancellation.</param> /// <returns>The <see cref="CosmosStoredProcedureSettings"/> that was created contained within a <see cref="Task"/> object representing the service response for the asynchronous operation.</returns> /// <exception cref="ArgumentNullException">If either <paramref name="id"/> or <paramref name="body"/> is not set.</exception> /// <exception cref="System.AggregateException">Represents a consolidation of failures that occurred during async processing. Look within InnerExceptions to find the actual exception(s)</exception> /// <exception cref="CosmosException">This exception can encapsulate many different types of errors. To determine the specific error always look at the StatusCode property. Some common codes you may get when creating a Document are: /// <list type="table"> /// <listheader> /// <term>StatusCode</term><description>Reason for exception</description> /// </listheader> /// <item> /// <term>400</term><description>BadRequest - This means something was wrong with the request supplied. It is likely that an Id was not supplied for the stored procedure or the Body was malformed.</description> /// </item> /// <item> /// <term>403</term><description>Forbidden - You have reached your quota of stored procedures for the collection supplied. Contact support to have this quota increased.</description> /// </item> /// <item> /// <term>409</term><description>Conflict - This means a <see cref="CosmosStoredProcedureSettings"/> with an id matching the id you supplied already existed.</description> /// </item> /// <item> /// <term>413</term><description>RequestEntityTooLarge - This means the body of the <see cref="CosmosStoredProcedureSettings"/> you tried to create was too large.</description> /// </item> /// </list> /// </exception> /// <example> /// This creates and executes a stored procedure that appends a string to the first item returned from the query. /// <code language="c#"> /// <![CDATA[ /// string sprocBody = @"function simple(prefix) /// { /// var collection = getContext().getCollection(); /// /// // Query documents and take 1st item. /// var isAccepted = collection.queryDocuments( /// collection.getSelfLink(), /// 'SELECT * FROM root r', /// function(err, feed, options) { /// if (err)throw err; /// /// // Check the feed and if it's empty, set the body to 'no docs found', /// // Otherwise just take 1st element from the feed. /// if (!feed || !feed.length) getContext().getResponse().setBody(""no docs found""); /// else getContext().getResponse().setBody(prefix + JSON.stringify(feed[0])); /// }); /// /// if (!isAccepted) throw new Error(""The query wasn't accepted by the server. Try again/use continuation token between API and script.""); /// }"; /// /// CosmosStoredProcedure cosmosStoredProcedure = await this.container.StoredProcedures.CreateStoredProcedureAsync( /// id: "appendString", /// body: sprocBody); /// /// // Execute the stored procedure /// CosmosItemResponse<string> sprocResponse = await storedProcedure.ExecuteAsync<string, string>(testPartitionId, "Item as a string: "); /// Console.WriteLine("sprocResponse.Resource"); /// ]]> /// </code> /// </example> public virtual Task <CosmosStoredProcedureResponse> CreateStoredProcedureAsync( string id, string body, CosmosRequestOptions requestOptions = null, CancellationToken cancellationToken = default(CancellationToken)) { if (string.IsNullOrEmpty(id)) { throw new ArgumentNullException(nameof(id)); } if (string.IsNullOrEmpty(body)) { throw new ArgumentNullException(nameof(body)); } CosmosStoredProcedureSettings storedProcedureSettings = new CosmosStoredProcedureSettings(); storedProcedureSettings.Id = id; storedProcedureSettings.Body = body; Task <CosmosResponseMessage> response = ExecUtils.ProcessResourceOperationStreamAsync( this.container.Database.Client, this.container.LinkUri, ResourceType.StoredProcedure, OperationType.Create, requestOptions, partitionKey: null, streamPayload: storedProcedureSettings.GetResourceStream(), requestEnricher: null, cancellationToken: cancellationToken); return(this.client.ResponseFactory.CreateStoredProcedureResponse(this[id], response)); }
/// <summary> /// Replaces a <see cref="CosmosStoredProcedureSettings"/> in the Azure Cosmos service as an asynchronous operation. /// </summary> /// <param name="body">The JavaScript function to replace the existing resource with.</param> /// <param name="requestOptions">(Optional) The options for the stored procedure request <see cref="CosmosStoredProcedureRequestOptions"/></param> /// <param name="cancellationToken">(Optional) <see cref="CancellationToken"/> representing request cancellation.</param> /// <returns> /// A <see cref="Task"/> containing a <see cref="CosmosStoredProcedureResponse"/> which wraps a <see cref="CosmosStoredProcedureSettings"/> containing the updated resource record. /// </returns> /// <exception cref="ArgumentNullException">If <paramref name="body"/> is not set.</exception> /// <exception cref="DocumentClientException">This exception can encapsulate many different types of errors. To determine the specific error always look at the StatusCode property. Some common codes you may get when creating a Document are: /// <list type="table"> /// <listheader> /// <term>StatusCode</term><description>Reason for exception</description> /// </listheader> /// <item> /// <term>404</term><description>NotFound - This means the resource you tried to delete did not exist.</description> /// </item> /// </list> /// </exception> /// <example> /// This examples replaces an existing stored procedure. /// <code language="c#"> /// <![CDATA[ /// //Updated settings /// CosmosStoredProcedureSettings settings = new CosmosStoredProcedureSettings /// { /// Id = "testTriggerId", /// Body = @"function AddTax() { /// var item = getContext().getRequest().getBody(); /// /// // Validate/calculate the tax. /// item.tax = item.cost* .15; /// /// // Update the request -- this is what is going to be inserted. /// getContext().getRequest().setBody(item); /// }" /// }; /// /// CosmosStoredProcedureResponse response = await this.cosmosStoredProcedure.ReplaceAsync(settings); /// ]]> /// </code> /// </example> public virtual Task <CosmosStoredProcedureResponse> ReplaceAsync( string body, CosmosRequestOptions requestOptions = null, CancellationToken cancellationToken = default(CancellationToken)) { if (string.IsNullOrEmpty(body)) { throw new ArgumentNullException(nameof(body)); } CosmosStoredProcedureSettings storedProcedureSettings = new CosmosStoredProcedureSettings() { Id = this.Id, Body = body, }; return(this.ProcessAsync( partitionKey: null, streamPayload: storedProcedureSettings.GetResourceStream(), operationType: OperationType.Replace, requestOptions: requestOptions, cancellationToken: cancellationToken)); }