SnowConvert AI - How to use the SnowConvert AI CLI¶

Installation¶

Depending on your Operating System, you can review the corresponding installation guide:

Commands¶

Summary¶

Each command can be used with the following syntax:

snowct [command] [arguments]

Copy

The available commands are listed below. If you want to check a detailed explanation for a command, you can click on the command.

Command	Alias	Description
`install-access-code`	`install-ac`	Install an access code.
`show-access-code`	`show-ac`	Show the installed access code(s).
`teradata`		Perform a Teradata conversion/assessment.
`oracle`		Perform an Oracle conversion/assessment.
`sql-server`		Perform a SQL Server conversion/assessment.
`redshift`		Perform a Redshift conversion/assessment.
`azuresynapse`		Perform an Azure Synapse conversion/assessment.
`sybase`		Perform a Sybase IQ conversion/assessment.
`greenplum`		Perform a Greenplum conversion/assessment.
`postgresql`		Perform a PostgreSQL conversion/assessment.
`netezza`		Perform a Netezza conversion/assessment.
`spark`		Perform a Spark SQL conversion/assessment.
`databricks`		Perform a Databricks SQL conversion/assessment.
`vertica`		Perform a Vertica conversion/assessment.
`hive`		Perform a Hive conversion/assessment.
`--help`	`-h`	Show help.
`--version`	`-v`	Show the version of the tool.

Installing an access code¶

Before converting your code, you need to install an access code. You can do this by specifying the access code, or by specifying the path to the file that contains the access code information (this is useful when installing the access code without an Internet connection or under restrictive firewall settings).

You can use the following command to install the access code by writing the code:

snowct install-access-code <access-code>

Copy

This command is equivalent to the previous command:

snowct install-ac <access-code>

Copy

If you want to install an access code using a file, you can use the --file / -f option, as shown in the following commands:

snowct install-access-code --file <path-to-file>
snowct install-access-code -f <path-to-file>
snowct install-a --file <path-to-file>
snowct install-ac -f <path-to-file>

Copy

Note

If there is an error during the installation of the license, an error will be shown. If you need an access code, you can reach out to snowconvert-support@snowflake.com .

Converting¶

You can use the following commands to convert your source code. You must provide an input path (where the source code is) and an output path (where the converted code will be placed). There is a different command for each product:

SnowConvert AI Teradata: teradata
SnowConvert AI Oracle: oracle
SnowConvert AI SQL Server: sql-server
SnowConvert AI Redshift: redshift
SnowConvert AI Azure Synapse: azuresynapse
SnowConvert AI Sybase IQ: sybase
SnowConvert AI Greenplum: greenplum
SnowConvert AI PostgreSQL: postgresql
SnowConvert AI Netezza: netezza
SnowConvert AI Spark SQL: spark
SnowConvert AI Databricks SQL: databricks
SnowConvert AI Vertica: vertica
SnowConvert AI Hive: hive

snowct teradata --input <input-path> --output <output-path> <additional-parameters>
snowct oracle --input <input-path> --output <output-path> <additional-parameters>
snowct sql-server --input <input-path> --output <output-path> <additional-parameters>
snowct redshift --input <input-path> --output <output-path> <additional-parameters>
snowct azuresynapse --input <input-path> --output <output-path> <additional-parameters>
snowct sybase --input <input-path> --output <output-path> <additional-parameters>
snowct greenplum --input <input-path> --output <output-path> <additional-parameters>
snowct postgresql --input <input-path> --output <output-path> <additional-parameters>
snowct netezza --input <input-path> --output <output-path> <additional-parameters>
snowct spark --input <input-path> --output <output-path> <additional-parameters>
snowct databricks --input <input-path> --output <output-path> <additional-parameters>
snowct vertica --input <input-path> --output <output-path> <additional-parameters>
snowct hive --input <input-path> --output <output-path> <additional-parameters>

Copy

In each of these cases, you can use -i instead of --input, or -o instead of --output. For example, instead of writing snowct teradata --input <input-path> --output <output-path> you can write snowct teradata -i <input-path> -o <output-path>.

Each of these commands might also receive additional parameters. In the following links, you can review which additional parameters are available for each product:

Checking which access codes are installed¶

If you want to know which access codes are installed on your computer, you can use the following command:

snowct show-access-code

Copy

This command is equivalent to the previous command:

snowct show-ac

Copy

This command will show the information for each access code that is installed on your computer.

Checking the version of the tool¶

You can use any of the following commands to check the version of the tool and the version for each code processing engine (SnowConvert AI Teradata, SnowConvert AI Oracle, SnowConvert AI SQL Server):

snowct --version
snowct -v

Copy

Need more help?¶

If you want to see general help for the CLI, you can use the following commands:

snowct --help
snowct -h

Copy

You can get more information about a command by executing this command:

snowct <command> --help

Copy

For example, you can execute snowct install-access-code --help to get more information about how to install an access code, or you can execute snowct teradata --help to get more information about how to execute conversions using SnowConvert AI Teradata. This will also show information about the additional options that are available for SnowConvert AI Teradata.