TableInput Interface

  • Reference
Package:
com.microsoft.azure.functions.annotation
Maven Artifact:
com.microsoft.azure.functions:azure-functions-java-library:1.3.1

Implements

java.lang.annotation.Annotation

public interface TableInput
implements java.lang.annotation.Annotation

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;
 }

Method Summary

Modifier and Type Method and Description
abstract java.lang.String connection()

Defines the app setting name that contains the Azure Storage connection string.
abstract java.lang.String dataType()

Defines how Functions runtime should treat the parameter value.
abstract java.lang.String filter()

Defines the filter of the storage table to which to bind.
abstract java.lang.String name()

The variable name used in function.json.
abstract java.lang.String partitionKey()

Defines the partition key of the storage table to which to bind.
abstract java.lang.String rowKey()

Defines the row key of the storage table to which to bind.
abstract java.lang.String tableName()

Defines the name of the storage table to which to bind.
abstract java.lang.String take()

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

Method Details

connection

public abstract String connection()

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

Returns:

The app setting name of the connection string.

dataType

public abstract 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[]

Returns:

The dataType which will be used by the Functions runtime.

filter

public abstract String filter()

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

Returns:

The storage table filter string.

name

public abstract String name()

The variable name used in function.json.

Returns:

The variable name used in function.json.

partitionKey

public abstract String partitionKey()

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

Returns:

The storage table partition key string.

rowKey

public abstract String rowKey()

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

Returns:

The storage table row key string.

tableName

public abstract String tableName()

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

Returns:

The storage table name string.

take

public abstract String take()

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

Returns:

The storage table retrieving rows number string.

Applies to