@@ -12,10 +12,10 @@ this client][how to submit].
1212
1313- [ Installation] ( #installation )
1414- [ Quickstart] ( #quickstart )
15+ - [ config.yaml] ( #configyaml )
1516- [ Running Using ` run.sh ` ] ( #running-using-runsh )
1617- [ Running Using ` bqms-run ` Directly] ( #running-using-bqms-run-directly )
1718 - [ Environment Variables] ( #environment-variables )
18- - [ config.yaml] ( #configyaml )
1919- [ Metadata Lookup] ( #metadata-lookup )
2020 - [ DDL and Metadata Dump] ( #ddl-and-metadata-dump )
2121 - [ Unqualified References] ( #unqualified-references )
@@ -32,12 +32,11 @@ this client][how to submit].
3232Preferred OS: Linux or macOS. Windows usage may be possible through PowerShell,
3333but it is not officially supported.
3434
35- ** Download and extract the latest release zip ` dwh-migration-tools-vX.X.X.zip `
36- from [ the Releases page] ( https://github.com/google/dwh-migration-tools/releases ) .**
35+ ** Download and extract [ the latest release zip ` dwh-migration-tools-vX.X.X.zip ` ] ( https://github.com/google/dwh-migration-tools/releases/latest ) .**
3736
3837Python &ge ; 3.7.2 is required, as well as the additional local dependencies
3938` pkg-config ` and ` libicu-dev ` . Typical commands for installing these
40- dependencies on Linux would be:
39+ dependencies on a Debian-based Linux distribution such as Ubuntu would be:
4140
4241``` shell
4342sudo apt update
@@ -90,6 +89,37 @@ export BQMS_GCS_BUCKET="<YOUR_GCS_BUCKET>"
9089./run.sh
9190```
9291
92+ ## config.yaml
93+
94+ The ` config.yaml ` file specifies the translation type (i.e. source and target
95+ dialects), translation location and default values for
96+ [ unqualified references] ( #unqualified-references ) .
97+
98+ The ` run.sh ` wrapper script looks for ` config.yaml ` in the ` config ` directory
99+ in which it is running. If you are using ` bqms-run ` directly instead, it
100+ requires a file path be passed as the ` BQMS_CONFIG_PATH ` environment variable.
101+
102+ Example ` config.yaml ` file:
103+
104+ ``` yaml
105+ # The type of translation to perform e.g. Teradata to BigQuery. Doc:
106+ # https://cloud.google.com/bigquery/docs/reference/migration/rest/v2/projects.locations.workflows#migrationtask
107+ translation_type : Translation_Teradata2BQ
108+
109+ # The region where the translation job will run.
110+ location : ' us'
111+
112+ # Default database and schemas to use when looking up unqualified references:
113+
114+ # https://cloud.google.com/bigquery/docs/output-name-mapping#default_database
115+ default_database : default_db
116+
117+ # https://cloud.google.com/bigquery/docs/output-name-mapping#default_schema
118+ schema_search_path :
119+ - library
120+ - foo
121+ ` ` `
122+
93123## Running Using ` run.sh`
94124
95125There are two ways to run the CLI : via the wrapping `run.sh` script or
@@ -224,37 +254,6 @@ See also the instructions for [deploying to Cloud Run](#deploying-to-cloud-run).
224254 out-of-band process which is highly discouraged.
225255- `BQMS_VERBOSE` : Set to `True` to enable debug logging.
226256
227- ## config.yaml
228-
229- The ` config.yaml ` file specifies the translation type (i.e. source and target
230- dialects), translation location and default values for
231- [ unqualified references] ( #unqualified-references ) .
232-
233- The ` run.sh ` wrapper script looks for ` config.yaml ` in the ` config ` directory
234- in which it is running. If you are using ` bqms-run ` directly instead, it
235- requires a file path be passed as the ` BQMS_CONFIG_PATH ` environment variable.
236-
237- Example ` config.yaml ` file:
238-
239- ``` yaml
240- # The type of translation to perform e.g. Teradata to BigQuery. Doc:
241- # https://cloud.google.com/bigquery/docs/reference/migration/rest/v2/projects.locations.workflows#migrationtask
242- translation_type : Translation_Teradata2BQ
243-
244- # The region where the translation job will run.
245- location : ' us'
246-
247- # Default database and schemas to use when looking up unqualified references:
248-
249- # https://cloud.google.com/bigquery/docs/output-name-mapping#default_database
250- default_database : default_db
251-
252- # https://cloud.google.com/bigquery/docs/output-name-mapping#default_schema
253- schema_search_path :
254- - library
255- - foo
256- ` ` `
257-
258257# # Metadata Lookup
259258
260259In order to properly translate DML and queries, the batch SQL translator needs
0 commit comments