Class SubsettingPolicy

A subsetting policy defines the approach to subset data in a target database. It's basically a collection of rules applied on tables or schemas, to reduce rows in them. A subsetting policy can be used to subset multiple databases provided that they have the same schema design.

Inheritance

object

SubsettingPolicy

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatasafeService.Models

Assembly: OCI.DotNetSDK.Datasafe.dll

Syntax

public class SubsettingPolicy

Properties

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment that contains the subsetting policy

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	The description of the subsetting policy

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	The display name of the subsetting policy

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the subsetting policy

Remarks

Required

IsRedoLoggingEnabled

Declaration

[Required(ErrorMessage = "IsRedoLoggingEnabled is required.")]
[JsonProperty(PropertyName = "isRedoLoggingEnabled")]
public bool? IsRedoLoggingEnabled { get; set; }

Property Value

Type	Description
bool?	Indicates if redo logging is enabled during a subsetting operation. It's disabled by default. Set this attribute to true to enable redo logging. By default, subsetting disables redo logging and flashback logging to purge any original data from logs. However, in certain circumstances when you only want to test subsetting, rollback changes, and retry subsetting, you could enable logging and use a flashback database to retrieve the original data after it has been subsetted.

Type

Description

bool?

Indicates if redo logging is enabled during a subsetting operation. It's disabled by default. Set this attribute to true to enable redo logging. By default, subsetting disables redo logging and flashback logging to purge any original
data from logs. However, in certain circumstances when you only want to test subsetting, rollback changes, and retry subsetting, you could enable logging and use a flashback database to retrieve the original data after it has been subsetted.

Remarks

Required

IsRefreshStatsEnabled

Declaration

[Required(ErrorMessage = "IsRefreshStatsEnabled is required.")]
[JsonProperty(PropertyName = "isRefreshStatsEnabled")]
public bool? IsRefreshStatsEnabled { get; set; }

Property Value

Type	Description
bool?	Indicates if statistics gathering is enabled. It's enabled by default. Set this attribute to false to disable statistics gathering. The subsetting process gathers statistics on database tables after subsetting completes

Remarks

Required

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SubsettingPolicy.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
SubsettingPolicy.LifecycleStateEnum?	The current state of the subsetting policy

Remarks

Required

MaskingPolicyId

Declaration

[JsonProperty(PropertyName = "maskingPolicyId")]
public string MaskingPolicyId { get; set; }

Property Value

Type	Description
string	The OCID of the masking policy associated with this subsetting policy

ParallelDegree

Declaration

[Required(ErrorMessage = "ParallelDegree is required.")]
[JsonProperty(PropertyName = "parallelDegree")]
public string ParallelDegree { get; set; }

Property Value

Type	Description
string	Specifies options to enable parallel execution when running data subsetting. Allowed values are 'NONE' (no parallelism), 'DEFAULT' (the Oracle Database computes the optimum degree of parallelism) or an integer value to be used as the degree of parallelism. Parallel execution helps effectively use multiple CPUs and improve subsetting performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism

Type

Description

string

Specifies options to enable parallel execution when running data subsetting. Allowed values are 'NONE' (no parallelism), 'DEFAULT' (the Oracle Database computes the optimum degree of parallelism) or an integer value to be used as the degree of parallelism. Parallel execution helps effectively use multiple CPUs and improve subsetting performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism

Remarks

Required

PostSubsettingScript

Declaration

[JsonProperty(PropertyName = "postSubsettingScript")]
public string PostSubsettingScript { get; set; }

Property Value

Type	Description
string	A post-subsetting script, which can contain SQL and PL/SQL statements. It's executed after the core subsetting script generated using the subsetting policy. It's usually used to perform additional transformation or cleanup work after subsetting.

PreSubsettingScript

Declaration

[JsonProperty(PropertyName = "preSubsettingScript")]
public string PreSubsettingScript { get; set; }

Property Value

Type	Description
string	A pre-subsetting script, which can contain SQL and PL/SQL statements. It's executed before the core subsetting script generated using the subsetting policy. It's usually used to perform any preparation or prerequisite work before subsetting data

Recompile

Declaration

[Required(ErrorMessage = "Recompile is required.")]
[JsonProperty(PropertyName = "recompile")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SubsettingPolicy.RecompileEnum? Recompile { get; set; }

Property Value

Type	Description
SubsettingPolicy.RecompileEnum?	Specifies how to recompile invalid objects post data subsetting. Allowed values are 'SERIAL' (recompile in serial), 'PARALLEL' (recompile in parallel), 'NONE' (do not recompile). If it's set to PARALLEL, the value of parallelDegree attribute is used. Use the built-in UTL_RECOMP package to recompile any remaining invalid objects after subsetting completes

Remarks

Required

SchemaSource

Declaration

[JsonProperty(PropertyName = "schemaSource")]
public SchemaSourceDetails SchemaSource { get; set; }

Property Value

Type	Description
SchemaSourceDetails

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the subsetting policy was created, in the format defined by RFC3339

Remarks

Required

TimeUpdated

Declaration

[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the subsetting policy was last updated, in the format defined by RFC3339

Remarks

Required

UnrelatedTablesAction

Declaration

[JsonProperty(PropertyName = "unrelatedTablesAction")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SubsettingPolicy.UnrelatedTablesActionEnum? UnrelatedTablesAction { get; set; }

Property Value

Type	Description
SubsettingPolicy.UnrelatedTablesActionEnum?	Strategy to be applied for tables which are not impacted by any of the subsetting rules