Struct OracleSettings

Source

#[non_exhaustive]
pub struct OracleSettings {Show 44 fields
    pub add_supplemental_logging: Option<bool>,
    pub archived_log_dest_id: Option<i32>,
    pub additional_archived_log_dest_id: Option<i32>,
    pub extra_archived_log_dest_ids: Option<Vec<i32>>,
    pub allow_select_nested_tables: Option<bool>,
    pub parallel_asm_read_threads: Option<i32>,
    pub read_ahead_blocks: Option<i32>,
    pub access_alternate_directly: Option<bool>,
    pub use_alternate_folder_for_online: Option<bool>,
    pub oracle_path_prefix: Option<String>,
    pub use_path_prefix: Option<String>,
    pub replace_path_prefix: Option<bool>,
    pub enable_homogenous_tablespace: Option<bool>,
    pub direct_path_no_log: Option<bool>,
    pub archived_logs_only: Option<bool>,
    pub asm_password: Option<String>,
    pub asm_server: Option<String>,
    pub asm_user: Option<String>,
    pub char_length_semantics: Option<CharLengthSemantics>,
    pub database_name: Option<String>,
    pub direct_path_parallel_load: Option<bool>,
    pub fail_tasks_on_lob_truncation: Option<bool>,
    pub number_datatype_scale: Option<i32>,
    pub password: Option<String>,
    pub port: Option<i32>,
    pub read_table_space_name: Option<bool>,
    pub retry_interval: Option<i32>,
    pub security_db_encryption: Option<String>,
    pub security_db_encryption_name: Option<String>,
    pub server_name: Option<String>,
    pub spatial_data_option_to_geo_json_function_name: Option<String>,
    pub standby_delay_time: Option<i32>,
    pub username: Option<String>,
    pub use_b_file: Option<bool>,
    pub use_direct_path_full_load: Option<bool>,
    pub use_logminer_reader: Option<bool>,
    pub secrets_manager_access_role_arn: Option<String>,
    pub secrets_manager_secret_id: Option<String>,
    pub secrets_manager_oracle_asm_access_role_arn: Option<String>,
    pub secrets_manager_oracle_asm_secret_id: Option<String>,
    pub trim_space_in_char: Option<bool>,
    pub convert_timestamp_with_zone_to_utc: Option<bool>,
    pub open_transaction_window: Option<i32>,
    pub authentication_method: Option<OracleAuthenticationMethod>,
}

Expand description

Provides information that defines an Oracle endpoint.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

§add_supplemental_logging: Option<bool>

Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute enables PRIMARY KEY supplemental logging on all tables selected for a migration task.

If you use this option, you still need to enable database-level supplemental logging.

§archived_log_dest_id: Option<i32>

Specifies the ID of the destination for the archived redo logs. This value should be the same as a number in the dest_id column of the v$archived_log view. If you work with an additional redo log destination, use the AdditionalArchivedLogDestId option to specify the additional destination ID. Doing this improves performance by ensuring that the correct logs are accessed from the outset.

§additional_archived_log_dest_id: Option<i32>

Set this attribute with ArchivedLogDestId in a primary/ standby setup. This attribute is useful in the case of a switchover. In this case, DMS needs to know which destination to get archive redo logs from to read changes. This need arises because the previous primary instance is now a standby instance after switchover.

Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use RESETLOGS unless necessary. For additional information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.

§extra_archived_log_dest_ids: Option<Vec<i32>>

Specifies the IDs of one more destinations for one or more archived redo logs. These IDs are the values of the dest_id column in the v$archived_log view. Use this setting with the archivedLogDestId extra connection attribute in a primary-to-single setup or a primary-to-multiple-standby setup.

This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this case, DMS needs information about what destination to get archive redo logs from to read changes. DMS needs this because after the switchover the previous primary is a standby instance. For example, in a primary-to-single standby setup you might apply the following settings.

archivedLogDestId=1; ExtraArchivedLogDestIds=\[2\]

In a primary-to-multiple-standby setup, you might apply the following settings.

archivedLogDestId=1; ExtraArchivedLogDestIds=\[2,3,4\]

Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use RESETLOGS unless it's necessary. For more information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.

§allow_select_nested_tables: Option<bool>

Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.

§parallel_asm_read_threads: Option<i32>

Set this attribute to change the number of threads that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 2 (the default) and 8 (the maximum). Use this attribute together with the readAheadBlocks attribute.

§read_ahead_blocks: Option<i32>

Set this attribute to change the number of read-ahead blocks that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 1000 (the default) and 200,000 (the maximum).

§access_alternate_directly: Option<bool>

Set this attribute to false in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This tells the DMS instance to not access redo logs through any specified path prefix replacement using direct file access.

§use_alternate_folder_for_online: Option<bool>

Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This tells the DMS instance to use any specified prefix replacement to access all online redo logs.

§oracle_path_prefix: Option<String>

Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the default Oracle root used to access the redo logs.

§use_path_prefix: Option<String>

Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the path prefix used to replace the default Oracle root to access the redo logs.

§replace_path_prefix: Option<bool>

Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This setting tells DMS instance to replace the default Oracle root with the specified usePathPrefix setting to access the redo logs.

§enable_homogenous_tablespace: Option<bool>

Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.

§direct_path_no_log: Option<bool>

When set to true, this attribute helps to increase the commit rate on the Oracle target database by writing directly to tables and not writing a trail to database logs.

§archived_logs_only: Option<bool>

When this field is set to True, DMS only accesses the archived redo logs. If the archived redo logs are stored on Automatic Storage Management (ASM) only, the DMS user account needs to be granted ASM privileges.

§asm_password: Option<String>

For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value from the asm_user_password value. You set this value as part of the comma-separated value that you set to the Password request parameter when you create the endpoint to access transaction logs using Binary Reader. For more information, see Configuration for change data capture (CDC) on an Oracle source database.

§asm_server: Option<String>

For an Oracle source endpoint, your ASM server address. You can set this value from the asm_server value. You set asm_server as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.

§asm_user: Option<String>

For an Oracle source endpoint, your ASM user name. You can set this value from the asm_user value. You set asm_user as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.

§char_length_semantics: Option<CharLengthSemantics>

Specifies whether the length of a character column is in bytes or in characters. To indicate that the character column length is in characters, set this attribute to CHAR. Otherwise, the character column length is in bytes.

Example: charLengthSemantics=CHAR;

§database_name: Option<String>

Database name for the endpoint.

§direct_path_parallel_load: Option<bool>

When set to true, this attribute specifies a parallel load when useDirectPathFullLoad is set to Y. This attribute also only applies when you use the DMS parallel load feature. Note that the target table cannot have any constraints or indexes.

§fail_tasks_on_lob_truncation: Option<bool>

When set to true, this attribute causes a task to fail if the actual size of an LOB column is greater than the specified LobMaxSize.

If a task is set to limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.

§number_datatype_scale: Option<i32>

Specifies the number scale. You can select a scale up to 38, or you can select FLOAT. By default, the NUMBER data type is converted to precision 38, scale 10.

Example: numberDataTypeScale=12

§password: Option<String>

Endpoint connection password.

§port: Option<i32>

Endpoint TCP port.

§read_table_space_name: Option<bool>

When set to true, this attribute supports tablespace replication.

§retry_interval: Option<i32>

Specifies the number of seconds that the system waits before resending a query.

Example: retryInterval=6;

§security_db_encryption: Option<String>

For an Oracle source endpoint, the transparent data encryption (TDE) password required by AWM DMS to access Oracle redo logs encrypted by TDE using Binary Reader. It is also the TDE_Password part of the comma-separated value you set to the Password request parameter when you create the endpoint. The SecurityDbEncryptian setting is related to this SecurityDbEncryptionName setting. For more information, see Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User Guide.

§security_db_encryption_name: Option<String>

For an Oracle source endpoint, the name of a key used for the transparent data encryption (TDE) of the columns and tablespaces in an Oracle source database that is encrypted using TDE. The key value is the value of the SecurityDbEncryption setting. For more information on setting the key name value of SecurityDbEncryptionName, see the information and example for setting the securityDbEncryptionName extra connection attribute in Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User Guide.

§server_name: Option<String>

Fully qualified domain name of the endpoint.

For an Amazon RDS Oracle instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.

§spatial_data_option_to_geo_json_function_name: Option<String>

Use this attribute to convert SDO_GEOMETRY to GEOJSON format. By default, DMS calls the SDO2GEOJSON custom function if present and accessible. Or you can create your own custom function that mimics the operation of SDOGEOJSON and set SpatialDataOptionToGeoJsonFunctionName to call it instead.

§standby_delay_time: Option<i32>

Use this attribute to specify a time in minutes for the delay in standby sync. If the source is an Oracle Active Data Guard standby database, use this attribute to specify the time lag between primary and standby databases.

In DMS, you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for replicating ongoing changes. Doing this eliminates the need to connect to an active database that might be in production.

§username: Option<String>

Endpoint connection user name.

§use_b_file: Option<bool>

Set this attribute to True to capture change data using the Binary Reader utility. Set UseLogminerReader to False to set this attribute to True. To use Binary Reader with Amazon RDS for Oracle as the source, you set additional attributes. For more information about using this setting with Oracle Automatic Storage Management (ASM), see Using Oracle LogMiner or DMS Binary Reader for CDC.

§use_direct_path_full_load: Option<bool>

Set this attribute to True to have DMS use a direct path full load. Specify this value to use the direct path protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle target tables during a full load.

§use_logminer_reader: Option<bool>

Set this attribute to True to capture change data using the Oracle LogMiner utility (the default). Set this attribute to False if you want to access the redo logs as a binary file. When you set UseLogminerReader to False, also set UseBfile to True. For more information on this setting and using Oracle ASM, see Using Oracle LogMiner or DMS Binary Reader for CDC in the DMS User Guide.

§secrets_manager_access_role_arn: Option<String>

The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the Oracle endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

§secrets_manager_secret_id: Option<String>

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle endpoint connection details.

§secrets_manager_oracle_asm_access_role_arn: Option<String>

Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the SecretsManagerOracleAsmSecret. This SecretsManagerOracleAsmSecret has the secret value that allows access to the Oracle ASM of the endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerOracleAsmSecretId. Or you can specify clear-text values for AsmUser, AsmPassword, and AsmServerName. You can't specify both. For more information on creating this SecretsManagerOracleAsmSecret and the SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

§secrets_manager_oracle_asm_secret_id: Option<String>

Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.

§trim_space_in_char: Option<bool>

Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is true.

§convert_timestamp_with_zone_to_utc: Option<bool>

When true, converts timestamps with the timezone datatype to their UTC value.

§open_transaction_window: Option<i32>

The timeframe in minutes to check for open transactions for a CDC-only task.

You can specify an integer value between 0 (the default) and 240 (the maximum).

This parameter is only valid in DMS version 3.5.0 and later.

§authentication_method: Option<OracleAuthenticationMethod>

Specifies using Kerberos authentication with Oracle.

Struct OracleSettingsCopy item path

Fields (Non-exhaustive)§

Implementations§

impl OracleSettings

pub fn add_supplemental_logging(&self) -> Option<bool>

pub fn archived_log_dest_id(&self) -> Option<i32>

pub fn additional_archived_log_dest_id(&self) -> Option<i32>

pub fn extra_archived_log_dest_ids(&self) -> &[i32]

pub fn allow_select_nested_tables(&self) -> Option<bool>

pub fn parallel_asm_read_threads(&self) -> Option<i32>

pub fn read_ahead_blocks(&self) -> Option<i32>

pub fn access_alternate_directly(&self) -> Option<bool>

pub fn use_alternate_folder_for_online(&self) -> Option<bool>

pub fn oracle_path_prefix(&self) -> Option<&str>

pub fn use_path_prefix(&self) -> Option<&str>

pub fn replace_path_prefix(&self) -> Option<bool>

pub fn enable_homogenous_tablespace(&self) -> Option<bool>

pub fn direct_path_no_log(&self) -> Option<bool>

pub fn archived_logs_only(&self) -> Option<bool>

pub fn asm_password(&self) -> Option<&str>

pub fn asm_server(&self) -> Option<&str>

pub fn asm_user(&self) -> Option<&str>

pub fn char_length_semantics(&self) -> Option<&CharLengthSemantics>

pub fn database_name(&self) -> Option<&str>

pub fn direct_path_parallel_load(&self) -> Option<bool>

pub fn fail_tasks_on_lob_truncation(&self) -> Option<bool>

pub fn number_datatype_scale(&self) -> Option<i32>

pub fn password(&self) -> Option<&str>

pub fn port(&self) -> Option<i32>

pub fn read_table_space_name(&self) -> Option<bool>

pub fn retry_interval(&self) -> Option<i32>

pub fn security_db_encryption(&self) -> Option<&str>

pub fn security_db_encryption_name(&self) -> Option<&str>

pub fn server_name(&self) -> Option<&str>

pub fn spatial_data_option_to_geo_json_function_name(&self) -> Option<&str>

pub fn standby_delay_time(&self) -> Option<i32>

pub fn username(&self) -> Option<&str>

pub fn use_b_file(&self) -> Option<bool>

pub fn use_direct_path_full_load(&self) -> Option<bool>

pub fn use_logminer_reader(&self) -> Option<bool>

pub fn secrets_manager_access_role_arn(&self) -> Option<&str>

pub fn secrets_manager_secret_id(&self) -> Option<&str>

pub fn secrets_manager_oracle_asm_access_role_arn(&self) -> Option<&str>

pub fn secrets_manager_oracle_asm_secret_id(&self) -> Option<&str>

pub fn trim_space_in_char(&self) -> Option<bool>

pub fn convert_timestamp_with_zone_to_utc(&self) -> Option<bool>

pub fn open_transaction_window(&self) -> Option<i32>

pub fn authentication_method(&self) -> Option<&OracleAuthenticationMethod>

impl OracleSettings

pub fn builder() -> OracleSettingsBuilder

Trait Implementations§

impl Clone for OracleSettings

fn clone(&self) -> OracleSettings

fn clone_from(&mut self, source: &Self)

impl Debug for OracleSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl PartialEq for OracleSettings

fn eq(&self, other: &OracleSettings) -> bool

fn ne(&self, other: &Rhs) -> bool

impl StructuralPartialEq for OracleSettings

Auto Trait Implementations§

impl Freeze for OracleSettings

impl RefUnwindSafe for OracleSettings

impl Send for OracleSettings

impl Sync for OracleSettings

impl Unpin for OracleSettings

impl UnwindSafe for OracleSettings

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Struct OracleSettings

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

impl<T> Paint for T
where T: ?Sized,