com.microsoft.azure.functions.annotation

Annotation Type TableInput

@Retention(value=RUNTIME)
 @Target(value=PARAMETER)
public @interface TableInput

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

Since:

1.0.0

See Also:

HttpTrigger

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The variable name used in function.json.
String	tableName Defines the name of the storage table to which to bind.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	connection Defines the app setting name that contains the Azure Storage connection string.
String	dataType Defines how Functions runtime should treat the parameter value.
String	filter Defines the filter of the storage table to which to bind.
String	partitionKey Defines the partition key of the storage table to which to bind.
String	rowKey Defines the row key of the storage table to which to bind.
String	take Defines the number of rows to be retrieved from the storage table to which to bind.

Element Detail

name

public abstract String name

The variable name used in function.json.

Returns:

The variable name used in function.json.

tableName

public abstract String tableName

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

Returns:

The storage table name 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.

Default:

""

partitionKey

public abstract String partitionKey

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

Returns:

The storage table partition key string.

Default:

""

rowKey

public abstract String rowKey

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

Returns:

The storage table row key string.

Default:

""

filter

public abstract String filter

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

Returns:

The storage table filter string.

Default:

""

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.

Default:

""

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.

Default:

""