Skip to content

Latest commit

 

History

History
68 lines (55 loc) · 4.78 KB

TableExtensions.md

File metadata and controls

68 lines (55 loc) · 4.78 KB

Table Extensions

Behaviors

This repository contains the following behaviors:

Processors

This repository contains the following processors:

Commands

Table extensions depend on table commands, which represent the actual extension implementation:

Options

Table extensions are controlled using TableOptions<TMessage>.

The same option can have different requirements within the scope of different commands. Options requirements are as follows:

  • Required: the value is required and an exception will be thrown if one is not supplied
  • Default: the value is required and a default will be provided if one is not supplied
  • Optional: the value is optional and will be used if one is supplied, ignored otherwise
  • Ignored: the value is not used by the command and supplying one will have no effect

Options and their requirements are described in the following table:

Option Description Insert Delete Retrieve
IsEnabled true to enable execution of the extension, false to disable it Default 1 Default 1 Default 1
CloudTable The table against which the operation is executed Required Required Required
TableEntity The table entity that is the target of the operation Default 2 Required 3 Required 3
Retrieved The event that is raised after the entity is retrieved Ignored Ignored Optional

Footnotes

  1. false 2 3

  2. a table entity with auto-generated GUIDs for PartitionKey and RowKey plus properties named Message (full name of the message CLR type) and Content (message content serialized as JSON).

  3. PartitionKey and RowKey are needed to uniquely identify the entity to retrieve/delete 2