PutTaskTableSelection

Overrides the list of tables selected for inclusion in a specific Replicate task.

Required user role

See Required Enterprise Manager permissions.

Syntax

public void PutTaskTableSelection(

TableSelectionDefinition payload,

string server,

string task

)

Call parameters

Payload attributes

The following attributes can be included in the payload:

• List<TableSelection> IncludedPattern: Tables matching this pattern will be included.
• List<TableSelection> ExcludedPattern: Tables matching this pattern will be excluded.
• List<TableSelection> ExplicitIncludedTables: Tables matching this name will be included.

Payload class

The following are part of the TableSelection class:

• Owner (string): The table schema or owner
• Name (string): Tables to include or exclude according to the attribute: IncludedPattern, ExcludedPattern, or ExplicitIncludedTables
• LoadOrder (long): The order in which the tables will be loaded to the target. "0" means random order. See Load order for additional enums that can be used to define the load order. You can also set the value to StandardLoadOrder.LOWEST, StandardLoadOrder.LOW, StandardLoadOrder.NORMAL, StandardLoadOrder.HIGH, or StandardLoadOrder.HIGHEST.
• TableType (TableType): The entity type. Can be view or table.

Example payload

var tableSelectionDefinition = new TableSelectionDefinition
{
	IncludedPattern = new List<TableSelection>
	{
	 new TableSelection
	 {
	   Owner = "schema%",
	   Name="ab%yz%",
	   LoadOrder = (int)StandardLoadOrder.LOWEST
	 }
	},
	 ExcludedPattern = new List<TableSelection>
	 {
	  new TableSelection
	  {
		Owner = "schema3",
		Name="abcd%",
	  }
	 },
	 ExplicitIncludedTables = new List<TableSelection>
	 {
	 new TableSelection
	 {
	  Owner = "schema1",
	  Name = "tbl1",
	 },
	 new TableSelection
	 {
	  Owner = "schema1",
	  Name = "view1",
	  LoadOrder = (int)StandardLoadOrder.HIGH,
	  TableType = TableType.VIEW
	 }
    }
};
_client.PutTaskTableSelection(tableSelectionDefinition, "server1", "task1");

Errors

All of the general errors as well as the errors listed in the table below.