mapping_rules

Overview

Name	mapping_rules
Type	Resource
Id	google.datamigration.mapping_rules

Fields

Name	Datatype	Description
name	string	Full name of the mapping rule resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}.
displayName	string	Optional. A human readable name
setTablePrimaryKey	object	Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table. The rule filter field can refer to one entity. The rule scope can be one of: Table.
revisionId	string	Output only. The revision ID of the mapping rule. A new revision is committed whenever the mapping rule is changed in any way. The format is an 8-character hexadecimal string.
singlePackageChange	object	Options to configure rule type SinglePackageChange. The rule is used to alter the sql code for a package entities. The rule filter field can refer to one entity. The rule scope can be: Package
conditionalColumnSetValue	object	Options to configure rule type ConditionalColumnSetValue. The rule is used to transform the data which is being replicated/migrated. The rule filter field can refer to one or more entities. The rule scope can be one of: Column.
ruleOrder	string	Required. The order in which the rule is applied. Lower order rules are applied before higher value rules so they may end up being overridden.
ruleScope	string	Required. The rule scope
multiColumnDataTypeChange	object	Options to configure rule type MultiColumnDatatypeChange. The rule is used to change the data type and associated properties of multiple columns at once. The rule filter field can refer to one or more entities. The rule scope can be one of:Column. This rule requires additional filters to be specified beyond the basic rule filter field, which is the source data type, but the rule supports additional filtering capabilities such as the minimum and maximum field length. All additional filters which are specified are required to be met in order for the rule to be applied (logical AND between the fields).
convertRowidColumn	object	Options to configure rule type ConvertROWIDToColumn. The rule is used to add column rowid to destination tables based on an Oracle rowid function/property. The rule filter field can refer to one or more entities. The rule scope can be one of: Table. This rule requires additional filter to be specified beyond the basic rule filter field, which is whether or not to work on tables which already have a primary key defined.
state	string	Optional. The mapping rule state
singleColumnChange	object	Options to configure rule type SingleColumnChange. The rule is used to change the properties of a column. The rule filter field can refer to one entity. The rule scope can be one of: Column. When using this rule, if a field is not specified than the destination column's configuration will be the same as the one in the source column..
revisionCreateTime	string	Output only. The timestamp that the revision was created.
filterTableColumns	object	Options to configure rule type FilterTableColumns. The rule is used to filter the list of columns to include or exclude from a table. The rule filter field can refer to one entity. The rule scope can be: Table Only one of the two lists can be specified for the rule.
sourceSqlChange	object	Options to configure rule type SourceSqlChange. The rule is used to alter the sql code for database entities. The rule filter field can refer to one entity. The rule scope can be: StoredProcedure, Function, Trigger, View
multiEntityRename	object	Options to configure rule type MultiEntityRename. The rule is used to rename multiple entities. The rule filter field can refer to one or more entities. The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT
singleEntityRename	object	Options to configure rule type SingleEntityRename. The rule is used to rename an entity. The rule filter field can refer to only one entity. The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT, Synonym
entityMove	object	Options to configure rule type EntityMove. The rule is used to move an entity to a new schema. The rule filter field can refer to one or more entities. The rule scope can be one of: Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT
filter	object	A filter defining the entities that a mapping rule should be applied to. When more than one field is specified, the rule is applied only to entities which match all the fields.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	conversionWorkspacesId, locationsId, mappingRulesId, projectsId	Gets the details of a mapping rule.
list	SELECT	conversionWorkspacesId, locationsId, projectsId	Lists the mapping rules for a specific conversion workspace.
create	INSERT	conversionWorkspacesId, locationsId, projectsId	Creates a new mapping rule for a given conversion workspace.
delete	DELETE	conversionWorkspacesId, locationsId, mappingRulesId, projectsId	Deletes a single mapping rule.
_list	EXEC	conversionWorkspacesId, locationsId, projectsId	Lists the mapping rules for a specific conversion workspace.
import	EXEC	conversionWorkspacesId, locationsId, projectsId	Imports the mapping rules for a given conversion workspace. Supports various formats of external rules files.