copyIntegrationTableTransformSteps

Replace a target table's transform steps

The "copyIntegrationTableTransformSteps" action causes the server to replace the target table's transform steps with the source table's steps. 

The response contains a full description of the updated target integration table. It also includes a "previousTransformSteps" property that contains the previous value of the target integration table's transform steps.

 

Request examples

Minimal

The following example replaces the transform steps assigned to "myTable2" with those from "myTable1". It uses the database and owner specified in the current JSON action session (see "createSession" and "alterSession".

{
  "action": "copyIntegrationTableTransformSteps",
  "params": {
    "tableName": "myTable1",
    "targetTableName": "myTable2"
  },
  "authToken": "replaceWithAuthTokenFromCreateSession"
}
 
 

Maximal

The following example replaces the transform steps assigned to "myTable2" with those from "myTable1". It uses fully qualified table names that specify the database and owner of each table.

{
  "api": "hub",
  "action": "copyIntegrationTableTransformSteps",
  "params": {
    "databaseName": "myDb1",
    "ownerName": "myOwner1",
    "tableName": "my_source_table",


    "targetDatabaseName": "myDb1",
    "targetOwnerName": "myOwner1",
    "targetTableName": "my_target_table2"
  },
  "authToken": "replaceWithAuthTokenFromCreateSession"
}
 
 

 

Properties

Request properties ("params")

Property Description Default Type Limits (inclusive)

databaseName

The "databaseName" property specifies the database that contains an object, such as a table or code package. If it is set to null or is omitted, it defaults to the default database of the JSON Action session, see "createSession" and the "defaultDatabaseName" property. 

You specify this property when you want to use a different database instead of the default. 

This property is useful because objects, such as tables and code packages, can have the same name in multiple databases. This feature allows you to create multiple environments in the same server and reuse the same JSON actions in each environment. For example, you can create "dev", "test", "stage", and "prod" databases on the same server and use the "defaultDatabaseName" or "databaseName" properties to specify the desired environment.

It is an error to set "databaseName" to the empty string "".

If no default database is specified during "createSession", the server sets the "defaultDatabaseName" to the "defaultDatabaseName" value specified in the services.json file.

 Defaults to the session's "defaultDatabaseName" property string 1 to 64 bytes

ownerName

The "ownerName" property specifies the account that owns an object, such as a table or code package. See "createSession" and the "defaultOwnerName" property for more details. 

You specify this property when you want to use a different account instead of the default. Your session's account must have the appropriate privileges to access the code package. 

This property is useful because objects, such as tables and code packages, can have the same name in the same database as long as different accounts own each object. This feature allows you to create duplicate objects for different users on the same server and reuse the same JSON actions on those objects. For example, an administrator can copy objects from a production environment to her account so she can troubleshoot an issue using the same JSON actions, JavaScript, and SQL code.

It is an error to set "ownerName" to the empty string "".

If no default owner is specified during "createSession", the server sets the "defaultOwnerName" to the "defaultOwnerName" value specified in the services.json file.

 Optional with default of the session's "defaultOwnerName" property string 1 to 64 bytes

tableName

The "tableName" property contains the unique, user-defined name of a table.

See table name in System limits for the table naming requirements and limitations.

 

"params": {
  "tableName": "ctreeTable"
}
 Required - No default value string 1 to 64 bytes

targetDatabaseName

The "targetDatabaseName" property specifies the name of the database that contains the target table. See

"databaseName" for more information.

 Optional with default of "" string 1 to 64 bytes

targetOwnerName

The "targetOwnerName" property specifies the name of the account that owns the target table. See "ownerName" for more information.

 Optional with default of "" string 1 to 64 bytes

targetTableName

The "targetTableName" property specifies the name of the target table that has its transform steps replaced by this action.

Note The fully qualified name of a table includes the database, owner, and table names.

 Optional with default of "" string 1 to 64 bytes

 

Was this article helpful?

Give feedback about this article

Related Articles