You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If you are using several options for a migration, or have to specify a long list of objects for an option, consider using the `-optionsFile` option to specify the values in a separate text file. See [Specifying options using a file](mtk_command_options_in_file) for more information.
36
+
If you're using several options for a migration or have to specify a long list of objects for an option, consider using the `-optionsFile` option to specify the values in a separate text file. See [Specifying options using a file](mtk_command_options_in_file) for more information.
Copy file name to clipboardExpand all lines: product_docs/docs/migration_toolkit/55/07_invoking_mtk/mtk_command_options_in_file/creating_txt_file.mdx
+33-27
Original file line number
Diff line number
Diff line change
@@ -4,39 +4,39 @@ navTitle: "Creating the options file"
4
4
deepToC: true
5
5
---
6
6
7
-
To specify a text file that contains command line options and values, you must create a`<example.options>` file with the options you want to execute, and then run the `runMTK.sh` command with the `-optionsFile <example.options>` argument.
7
+
To specify a text file that contains command line options and values, create an`<options_textfile>` file with the options you want to execute. Then run the `runMTK.sh` command with the `-optionsFile <options_textfile>` argument.
8
8
9
9
!!!note
10
-
You can store the `<example.options>` file in the same folder as the MTK utility, or in a directory of your choice.
10
+
You can store the `<options_textfile>` file in the same folder as the Migration Toolkit utility or in a directory of your choice.
11
11
!!!
12
12
13
13
## Creating the text file - guidelines
14
14
15
-
Create a text file on a location that is accessible by the user performing the migration. Then, add an option per line following these guidelines:
15
+
Create a text file in a location that's accessible by the user performing the migration. Then, add one option per line following these guidelines.
16
16
17
17
### Skip the dash
18
18
19
-
Use the same option syntax as in the command line options without the dash sign (-). The options file recognizes each line as a new parameter and doesn't require a dash as a delimiter.
19
+
Use the same option syntax as in the command line options without the dash (-). The options file recognizes each line as a new parameter and doesn't require a dash as a delimiter.
20
20
21
21
| Option in CLI | Supported syntax for the option in file |
@@ -45,64 +45,70 @@ And you can combine both approaches, because MTK will combine all lines that hav
45
45
|| tables TAB1 <br/> tables TAB2,TAB3 |
46
46
47
47
!!!note
48
-
The duplication of options is only supported for the options file. <br/>
49
-
When using `-tables`in the command line more than one time, only the last parameter is executed. For example, `./runMTK.sh -tables TAB2 -tables TAB3`only includes the _TAB3_ table in the migration.
48
+
Duplicating options is supported only for the options file. <br/>
49
+
When using `-tables`at the command line more than one time, only the last parameter is executed. For example, `./runMTK.sh -tables TAB2 -tables TAB3` includes only the `TAB3` table in the migration.
50
50
!!!
51
51
52
52
### Use a space or equal sign to provide values
53
53
54
-
For options that require values (key-value pairs), separate the option from the value with a space or an equal sign (=). Both options are supported.
54
+
For options that require values (key-value pairs), separate the option from the value with a space or an equal sign (=). Both syntaxes are supported.
55
55
56
56
| Option in CLI | Supported syntax for the option in file |
### Don't specify an option in the file and command line
61
+
### Don't specify an option in the file and at the command line
62
62
63
-
Don't include an option in the options file if you're specifying it as a flag in the command line.
63
+
Don't include an option in the options file if you're specifying it as a flag at the command line.
64
64
65
-
Specifying an option in both the command line and in the text file will cause the migration to fail.
65
+
Specifying an option both at the command line and in the text file causes the migration to fail.
66
66
67
67
## Order of processing
68
68
69
-
Migration Toolkit reads command line options and option files in the order you provide them when running the command.
69
+
Migration Toolkit reads command line options and option files in the order you provide them when running the command. Ensure you add the [schema scope](executing_migration_with_txt/#provide-the-scope-for-the-schema-migration) (`schema_name` or `-allSchemas`) as the last parameter at the command line.
70
70
71
-
For example, if you run the following command, MTK first recognizes the `-sourcedbtype oracle` option, then reads the contents of `example.options` in order from top to bottom. Last parameter is always `schema_name`.
71
+
For example, if you run the following command, Migration Toolkit first recognizes the `-sourcedbtype oracle` option, and then reads the contents of `options_textfile` in order from top to bottom. The last parameter is the schema scope (`<schema_name>` or `-allSchemas`).
If you want an option to be executed last, you can either put it at the end of the `example.options` file and add no further options after `-optionsFile` in the command line.
77
+
Using an options file means that you can employ different syntaxes to perform a migration where parameters are executed in the same way. The following alternatives perform the same migration.
78
78
79
-
Schema definition (`schema_name` or `-allSchemas`) must always be the last parameter on the command line.
Where the content of the `<options_textfile>` file is:
99
+
100
+
```
101
+
tables=TAB1
96
102
```
97
103
98
104
## Other considerations
99
105
100
-
-**Commenting out**: Use a pound sign (#) to comment out a line. MTK won’t execute that line.
106
+
-**Commenting out**—Use a pound sign (#) to comment out a line. Migration Toolkit doesn't execute lines that are commented out.
101
107
102
-
-**Limitations**: Do not use quote marks.
108
+
-**Limitations**— Don't use quote marks.
103
109
104
-
-**Space processing**: MTK removes spaces between an option and its value. When you separate an option from its value with a space, only one space is treated as a delimiter.
110
+
-**Space processing**— Migration Toolkit removes spaces between an option and its value. When you separate an option from its value with a space, only one space is treated as a delimiter.
105
111
106
-
For example, to run the `-views all_emp, mgmt_list, acct_list` command line option, you can add _views all_emp,mgmt_list,acct_list_ OR _views = all_emp,mgmt_list,acct_list_ in the options file.
112
+
For example, to run the `-views all_emp, mgmt_list, acct_list` command line option, you can add `views all_emp,mgmt_list,acct_list` or `views = all_emp,mgmt_list,acct_list` in the options file.
107
113
108
-
After you have created the options file, [execute the migration with the options file](executing_migration_with_txt).
114
+
After you create the options file, [execute the migration with it](executing_migration_with_txt).
Copy file name to clipboardExpand all lines: product_docs/docs/migration_toolkit/55/07_invoking_mtk/mtk_command_options_in_file/executing_migration_with_txt.mdx
+18-18
Original file line number
Diff line number
Diff line change
@@ -4,31 +4,31 @@ navTitle: "Executing a migration with the options file"
4
4
deepToC: true
5
5
---
6
6
7
-
After you have created the options file, execute the migration command by referencing the options file:
7
+
After you create the options file, reference it when executing the migration command:
Provide the full path for `<example.options>` if you are running the MTK command from a different folder than where you have stored the file.
14
+
Provide the full path for `<options_textfile>` if you're running the Migration Toolkit command from a different folder from where you stored the file.
15
15
!!!
16
16
17
-
You can specify all options in the file, or use a mix of command line and options file to specify the migration parameters.
17
+
You can specify all options in the file or use a mix of the command line and the options file to specify the migration parameters.
18
18
19
19
## Provide the scope for the schema migration
20
20
21
-
You must specify the scope of the schemas to be migrated.
21
+
Specify the scope of the schemas to migrate:
22
22
23
-
- If you want to migrate all schemas: Add the `-allSchemas` option in the command line or add `allSchemas` in your options file. Regardless of which method you use, this option must be the last parameter.
23
+
- If you want to migrate all schemas, add the `-allSchemas` option at the command line or add `allSchemas` in your options file. For both methods, this option must be the last parameter.
24
24
25
-
- If you want to specify one or several schemas: Specify the schemas you want to migrate in the command line with no preceding option. They have to be the last parameter in the command line.
25
+
- If you want to specify a subset of schemas, specify the schemas you want to migrate at the command line with no preceding option and as a comma-separated list. Schema specifications must be the last parameter at the command line.
26
26
27
-
Here are some examples for specifying all options in the file:
27
+
Here are some examples for specifying all options in the file.
Copy file name to clipboardExpand all lines: product_docs/docs/migration_toolkit/55/07_invoking_mtk/mtk_command_options_in_file/index.mdx
+4-7
Original file line number
Diff line number
Diff line change
@@ -4,15 +4,13 @@ navTitle: "Specifying options using a file"
4
4
deepToC: true
5
5
---
6
6
7
-
EDB supports using a text file to specify several [database migration options](../08_mtk_command_options.mdx) instead of manually entering them in the command line. This is particularly helpful when:
7
+
EDB supports using a text file to specify several [database migration options](../08_mtk_command_options.mdx) instead of manually entering them at the command line. This is particularly helpful when:
8
8
9
-
- You have to specify a large number of command line options for complex migration scenarios. Entering all options in the command line becomes troublesome, or you might have even reached command line length limits.
9
+
- You have to specify a large number of command line options or a large number of values for complex migration scenarios. Entering all options or values at the command line becomes cumbersome, or you might reach command line length limits.
10
10
11
-
- You have to specify a large number of values for a command line option for complex migration scenarios. Entering all values in the command line becomes troublesome, or you might have even reached command line length limits.
11
+
- You want to apply the same migration options and values to several different databases, or you might want to automate database migration. Running `runMTK.sh` with several options and values repeatedly at the command line becomes prone to errors.
12
12
13
-
- You want to apply the same migration options and values to several different databases, or you might even consider automating the migration of databases. Running `runMTK.sh` with several options and values repeatedly in the command line becomes prone to errors.
14
-
15
-
The `-optionsFile <example.options>` argument allows you to reference a text file with all options and values, making the migration process easier.
13
+
The `-optionsFile <options_textfile>` argument allows you to reference a text file with options and values, making the migration process easier.
16
14
17
15
## Execute a migration using an options file
18
16
@@ -21,4 +19,3 @@ To perform a migration with a file that specifies the command options:
21
19
1.[Create a text file with the command options](creating_txt_file).
22
20
23
21
1.[Perform a migration by invoking the file with the command options](executing_migration_with_txt).
0 commit comments