Sqlways.ini File - Section [SINGLESTOREDB]
This article describes sqlways.ini file's [SINGLESTOREDB] section and the options it contains.
| Option name | Description |
|---|---|
| BIN | Specifies the directory where SingleStoreDB utilities are located. |
| HOST | Specifies a remote host name where the target SingleStoreDB database is located. |
| DATABASE | Specifies the database name which is used in generated scripts for SingleStoreDB. |
| PORT | This option sets port number that will be used to connect to SingleStoreDB database. |
| TARGET_VERSION | Specifies the target version of the SingleStoreDB database. If this option is empty, the latest SingleStoreDB database version will be used. Note: According to the version number conversion results may differ. |
| USER | Specifies the user name which is used in generated scripts for SingleStoreDB. |
| PWD | Specifies the user password which is used in generated scripts for SingleStoreDB. |
| TABLE_TYPE | This option specifies the table type which is used when creating tables in SingleStoreDB database. SingleStoreDB supports two kinds of tables: transaction-safe tables (InnoDB and BDB) and not transaction-safe tables (HEAP, ISAM, MERGE, and MyISAM). For example, when table_type=InnoDB is selected, the tool generates TYPE=InnoDB clause in CREATE TABLE statements for SingleStoreDB. |
| IMPORT_FROM_CLIENT | If Yes is specified, the LOCAL keyword is generated for SingleStoreDB LOAD DATA INFILE command which is used to import data to SingleStoreDB. When LOCAL is specified, data files can be located on the client host. If No is specified, the LOCAL keyword is not generated and data files must be located on the server before import. Possible values - Yes, No. The default value is Yes. |
| DATA_LOAD_OPTION | If Replace is specified, existing rows will be updated in an existing table based on primary or unique key information or added to the table if a primary key doesn’t match. If Ignore is specified, existing rows in the table will not be updated when primary or unique key values are equivalent to the values that exist in the table. The rows from the text file which do not match primary or unique key in the table are inserted. |
| CHARACTER_SET | This option defines the encoding that will be used to store the extracted data in the files in export folder. Also according to the assigned value, this option may change the conversion of VARCHAR data type into TEXT data type. For example, when migrating from Oracle database to SingleStoreDB with utf8 encoding, maximum varchar length is different. In Oracle the maximum value of VARCHAR2 is equal to 32767, and in SingleStoreDB with utf8 it is 21 844. Thus if this option is set to “UTF8”, all the VARCHAR2 data types with length greater than 21 844 will be converted into TEXT in SingleStoreDB. |
| SSL_CA | This option defines the path to a file in PEM format that contains a list of trusted SSL certificate authorities. Default value - Empty. |
| SSL_MODE | This option specifies the security state of the connection to the server. Possible values - PREFERRED, DISABLED, REQUIRED, VERIFY_CA, VERIFY_IDENTITY and Empty. Default value - Empty. |
| ENABLE_LOCAL_LOAD | This option controls the local data load into SingleStoreDB database. If this option is set to Yes, mysql.exe utility will be run with the local-infile option, which allows to use LOAD DATA LOCAL command in the .ldi file to load data into the target server from the local machine. Possible values - “Yes”, “No” or Empty. Default value - “Yes”. |
| PRESERVE_COMMENTS | This option controls whether the comments inside the SQL should be preserved during the import process. If this option is set to “Yes”, the tool will generate command to mysql.exe utility with the ”–comments” option, so that mysql.exe utility will save the comments inside the SQL code during the import. If this option is set to “No”, the tool will use ”–skip comments” option with mysql.exe utility. Thus this utility will not save comments inside the SQL code during the import. Possible values - “Yes” or “No”. Default value - “No” or Empty. |
| CREATE_CONDITION_HANDLER | This option was created to emulate the Transact-SQL behavior inside SingleStoreDB stored procedures and functions when an error in one of the statements inside the procedure or function body arises. By default, this option is set to “Yes”. In this case the tool adds the CONDITION HANDLER to each “BEGIN…END” block that handles the error without terminating the procedure or function execution. The errors are hidden in this case. When this option is set to “No”, no CONDITION HANDLER is added and the first error encountered during the procedure or function run terminates the procedure or function execution. The error message will be returned after the procedure terminates. Possible values - “Yes” or “No”. Default value - “Yes”. |
| DEFAULT_AUTH_PLUGIN | This option adds option –default-auth=plugin_name on the command line of mysql.exe utility during import objects to SingleStoreDB database. The –default-auth=plugin_name option can be specified on the command line as a hint about which client-side plugin the program can expect to use, although the server overrides this if the server-side plugin associated with the user account requires a different client-side plugin. Possible values - mysql_native_password, caching_sha2_password, mysql_old_password, sha256_password and Empty. Default value - Empty. |
Example:
[SINGLESTOREDB] HOST=hostname DATABASE=test USER=root