TableInput Interface

Definition

Place this on a parameter whose value would come from storage table. The parameter type can be one of the following:

  • Any native Java types such as int, String, byte[]
  • Nullable values using Optional
  • Any POJO type

The following example shows an HTTP trigger which returned the total count of the items in a table storage:

@FunctionName("getallcount")
 public int run(
    @HttpTrigger(name = "req",
                  methods = {"get"},
                  authLevel = AuthorizationLevel.ANONYMOUS) Object dummyShouldNotBeUsed,
    @TableInput(name = "items",
                 tableName = "mytablename",
                 partitionKey = "myparkey",
                 connection = "myconnvarname") MyItem[] items
 ) {
     return items.length;
 }
public interface TableInput implements Annotation
Implements
java.lang.annotation.Annotation

Methods

connection()

Defines the app setting name that contains the Azure Storage connection string.

dataType()

Defines how Functions runtime should treat the parameter value. Possible values are:

  • "": get the value as a string, and try to deserialize to actual parameter type like POJO
  • string: always get the value as a string
  • binary: get the value as a binary data, and try to deserialize to actual parameter type byte[]
filter()

Defines the filter of the storage table to which to bind.

name()

The variable name used in function.json.

partitionKey()

Defines the partition key of the storage table to which to bind.

rowKey()

Defines the row key of the storage table to which to bind.

tableName()

Defines the name of the storage table to which to bind.

take()

Defines the number of rows to be retrieved from the storage table to which to bind.

Applies to