Struct azure_functions::bindings::CosmosDbDocument

pub struct CosmosDbDocument(_);

Represents the input or output binding for a Cosmos DB document.

The following binding attributes are supported:

Name	Description
name	The name of the parameter being bound.
database_name	The database containing the document.
collection_name	The name of the collection that contains the document.
id	The identifier of the document to retrieve. This attribute supports binding expressions. Cannot be used with sql_query. If neither are specified, the entire collection is retrieved.
sql_query	An Azure Cosmos DB SQL query used for retrieving multiple documents. Cannot be used with id. If neither are specified, the entire collection is retrieved.
connection	The name of the app setting containing your Azure Cosmos DB connection string.
partition_key	Specifies the partition key value for the lookup; may include binding parameters (input only). When create_collection is true, defines the partition key path for the created collection (output only).
create_collection	Specifies if the collection should be created (output only).
collection_throughput	When create_collection is true, defines the throughput of the created collection (output only).

Examples

Using CosmosDbDocument as an input binding with a SQL query:

use azure_functions::{
    bindings::{CosmosDbDocument, HttpRequest, HttpResponse},
    func,
};

#[func]
#[binding(
    name = "documents",
    connection = "myconnection",
    database_name = "mydb",
    collection_name = "mycollection",
    sql_query = "select * from mycollection c where startswith(c.name, 'peter')",
)]
pub fn read_documents(_req: HttpRequest, documents: Vec<CosmosDbDocument>) -> HttpResponse {
    documents.into()
}

Using CosmosDbDocument as an input binding for a specific document:

use azure_functions::{
    bindings::{CosmosDbDocument, HttpRequest, HttpResponse},
    func,
};

#[func]
#[binding(name = "_req", route = "read/{id}")]
#[binding(
    name = "document",
    connection = "myconnection",
    database_name = "mydb",
    collection_name = "mycollection",
    id = "{id}",
)]
pub fn read_document(_req: HttpRequest, document: CosmosDbDocument) -> HttpResponse {
    document.into()
}

Using CosmosDbDocument as an output binding:

use azure_functions::{
    bindings::{CosmosDbDocument, HttpRequest, HttpResponse},
    func,
};

#[func]
#[binding(
    name = "output1",
    connection = "myconnection",
    database_name = "mydb",
    collection_name = "mycollection"
)]
pub fn create_document(_req: HttpRequest) -> (HttpResponse, CosmosDbDocument) {
    (
        "Document created.".into(),
        json!({
            "id": "myid",
            "name": "Peter",
            "subject": "example"
        }).into()
    )
}

Methods

impl CosmosDbDocument

pub fn new(value: Value) -> CosmosDbDocument

Creates a new CosmosDbDocument from a JSON object value.

The value must be a JSON object.

pub fn is_null(&self) -> bool

Gets whether or not the Cosmos DB document is null.

A Cosmos DB document can be null as a result of a query that returned no documents.

pub fn as_object(&self) -> Option<&Map<String, Value>>

Gets the JSON object for the Cosmos DB document

Returns None if the document is null.

pub fn as_object_mut(&mut self) -> Option<&mut Map<String, Value>>

Gets a mutable JSON object for the Cosmos DB document

Returns None if the document is null.

Trait Implementations

impl Into<String> for CosmosDbDocument

fn into(self) -> String

Performs the conversion.

impl Into<Value> for CosmosDbDocument

fn into(self) -> Value

Performs the conversion.

impl<'a> Into<Body<'a>> for CosmosDbDocument

fn into(self) -> Body<'a>

Performs the conversion.

impl Clone for CosmosDbDocument

fn clone(&self) -> CosmosDbDocument

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> From<&'a str> for CosmosDbDocument

fn from(json: &'a str) -> Self

Performs the conversion.

impl From<String> for CosmosDbDocument

fn from(json: String) -> Self

Performs the conversion.

impl From<Value> for CosmosDbDocument

fn from(value: Value) -> Self

Performs the conversion.

impl Debug for CosmosDbDocument

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Display for CosmosDbDocument

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.