Struct Table

pub struct Table(/* private fields */);

Represents an Azure Storage table input or output binding.

The following binding attributes are supported:

Name	Description
name	The name of the parameter being bound.
table_name	The name of the table.
partition_key	The partition key of the table entity to read or write.
row_key	The row key of the table entity to read or write.
filter	The maximum number of entities to read (optional; input only).
take	The OData filter expression of entities to read (optional; input only).
connection	The name of an app setting that contains the Storage connection string to use for this binding. Defaults to AzureWebJobsStorage.

Examples

Read a table storage row based on a key posted to the example queue:

use azure_functions::bindings::{QueueTrigger, Table};
use azure_functions::func;
use log::info;

#[func]
#[binding(name = "trigger", queue_name = "example")]
#[binding(name = "table", table_name = "MyTable", partition_key = "MyPartition", row_key = "{queueTrigger}")]
pub fn log_row(trigger: QueueTrigger, table: Table) {
    info!("Row: {:?}", table.rows().nth(0));
}

Run an Azure Storage table query based on a HTTP request:

use azure_functions::bindings::{HttpRequest, Table};
use azure_functions::func;
use log::info;

#[func]
#[binding(name = "table", table_name = "MyTable", filter = "{filter}")]
pub fn log_rows(req: HttpRequest, table: Table) {
    for row in table.rows() {
        info!("Row: {:?}", row);
    }
}

Implementations

impl Table

pub fn new() -> Table

Creates a new table binding.

The new table binding can be used for output.

pub fn is_empty(&self) -> bool

Gets whether or not the table binding is empty (no rows).

pub fn len(&self) -> usize

Gets the current length of the rows stored in the table binding.

pub fn rows(&self) -> impl Iterator<Item = &Row>

Gets the iterator over the rows stored in the table binding.

For input bindings, this will be the rows returned from either a single entity lookup or a filter query.

For output bindings, this will be the rows that have been added to the table binding.

pub fn add_row(&mut self, partition_key: &str, row_key: &str) -> &mut Row

Adds a new row to the table binding with the specified partition and row keys.

pub fn add_row_value(&mut self, value: Value)

Adds a row as a value to the table.

pub fn as_value(&self) -> &Value

Gets the table as a JSON value.

Trait Implementations

impl Clone for Table

fn clone(&self) -> Table

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Table

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

Formats the value using the given formatter.

impl Default for Table

fn default() -> Table

Returns the “default value” for a type.

impl Display for Table

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

Formats the value using the given formatter.

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

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

Converts this type into the (usually inferred) input type.

impl Into<Value> for Table

fn into(self) -> Value

Converts this type into the (usually inferred) input type.