Syntax:
GATEWAY EXPORT SQL filename.sql +
SELECT clause +
OPTION QUALIFIER symbol +
|FORMAT value +
|STRUCTURE value +
|TABLE_NAME value +
|SHOW_PROGRESS value +
|MESSAGES value +
|ACTION value +
|BLANK_IF_NULL value +
|BLANK_IF_ZERO value +
|SPECIFICATION_FILE_NAME filename +
|DATASET_FIELD_ORDER value +
|NO_UNICODE_CONVERSION value +
|ADD_UTF8_BOM value
filename.sql
This parameter defines the file name of the target file with exported data using a SQL Script format. The file extension must be sql.
SELECT clause
Use the SELECT command to identify rows of data from a table or view.
OPTION
ACTION
Defines the default action which will be processed after export is complete, for example, to open the target export file in view/edit mode or send this exported file by email as attachment. Available Parameter: OPENVIEW
ADD_UTF8_BOM
Specifies whether to add a UTF8 BOM to an exported UTF8 string. Available Parameters: ON / OFF
BLANK_IF_NULL
If ON, will export NULL values as blank values. If OFF, will export NULL values as the database NULL setting. The default is set to OFF. Available Parameters: ON / OFF
BLANK_IF_ZERO
If ON, will export zero values as blank values. If OFF, will export zero values as zero. The default is set to OFF. Available Parameters: ON / OFF
DATASET_FIELD_ORDER
Specifies the export will follow the SELECT clause column order, rather than the field order in the specification file, when a specification file is used as an OPTION parameter. The default is set to OFF. Available Parameters: ON / OFF
FORMAT
Specifies the database format type. Below lists valid values for the FORMAT parameter. If a FORMAT is not specified or an invalid value is used then a generic SQL format will be used.
Format Type |
Parameter Value |
DB2 |
DB2 |
InterBase, Firebird |
INTERBASE, IB, FIREBIRD, FB |
Access |
MSACCESS, ACCESS |
SQL Server |
MSSQL, SQL, SQLSERVER |
MySQL |
MYSQL |
Oracle |
ORACLE |
PosgreSQL |
POSTGRESQL, POSTGRES, PG |
SQLite |
SQLITE |
MESSAGES
If ON, during export process some messages will be displayed such as -ERROR- messages, if any. If OFF, the entire export process will be in "silent" mode. Available Parameters: ON / OFF
NO_UNICODE_CONVERSION
Exports Unicode data as a UTF8 string to fit in the target field, ensuring no data is lost. If OFF, the Unicode data will be converted to ANSI and characters from source that is higher than 0x127 will become ‘?’. As not all target formats support Unicode and this field is for cases when source is Unicode and destination is normal text field. Available Parameters: ON / OFF
QUALIFIER
Changing the value of this option you can define any qualifier for fields in the target Comma Separated Values text file. The popular value is Quotes (") but you can define any custom character you wish. Use the keyword PIPE as the value if you wish to use the pipe character as the qualifier. Use the keyword NONE if you wish to specify no text qualifier.
SHOW_PROGRESS
Indicates whether to display status dialog during export process. Set SHOW_PROGRESS to ON if you wish to show an animated status dialog during the export process. Set SHOW_PROGRESS to OFF if you wish to export data without animated status dialog. Available Parameters: ON / OFF
SPECIFICATION_FILE_NAME
This parameter is used to load a prepared specification with all pre-defined settings for exporting. The export must be performed once using the graphic user interface "Export Wizard" and saved using the "Specifications.." button. The specifications will be stored in a file with the .RGW file extension. The .RGW file acts as a set of default values. Any value in the .RGW file will be overwritten by the same parameter specifically assigned by an OPTION parameter. Since the input file name is required in the GATEWAY command, the input file name in the .RGW will always be overwritten.
STRUCTURE
Adds a CREATE TABLE command in the script. Available Parameters: ON / OFF
TABLE_NAME
Sets a table name different from the table name in the SELECT command. As the source is a query and supports JOINs, the TABLE_NAME parameter is available to specify a table after the FROM keyword is used.
Examples:
GATEWAY EXPORT SQL D:\TEMP\Employee.SQL +
SELECT * FROM Employee WHERE EmpStatus = 'Active' +
OPTION SHOW_PROGRESS ON|MESSAGES ON
GATEWAY EXPORT SQL D:\DataStore\Contacts.SQL +
SELECT * FROM Contacts +
OPTION FORMAT ORACLE|STRUCTURE ON|TABLE_NAME ContactTable
|BLANK_IF_ZERO ON|MESSAGES OFF
Notes:
Each record will include INSERT INTO statements which can be executed in the supported SQL compliant databases.
