type

Specify the type of export to be performed:

Value	Default Filename	Description
xml	<dbname>.xml	Export into XML files
cvs	<dbname>_<tablename>.csv	Export into comma-separated (CSV) files
sql	<dbname>.sql	Export into SQL INSERT statement script
cat	<dbname>.cat	Export the schema definition into a catalog file
stats	<dbname>_stats.json	Export the statistics if available

Note

The default output file name can be set using the output option. For example, the following option string will select an XML export to file name other than the default. "type=XML;output=myFileName;force=True"

The export output files will be UTF-8 format text files.

XML Export Comments

For XML exports the rdm_dbExport() API writes all data from the database to an XML file. By exporting data into XML format, consumers of the data can be RDM (e.g. for database archiving), or other XML consumers, including other database products such as ADO.NET. The XML content created by the rdm_dbExport() API will allow reconstruction of sets (in the case of RDM as the consumer), or interpretation by any normal XML consumer.

CVS Export Comments

For CSV export the rdm_dbExport() API writes all data from each table to a separate file. The default file name for each file will be defined as: <dbname>_<tablename>.csv. If a table option is used to extract a specific table name, only the one CSV file for that table's rows are exported.

The created files will consist of one text line per row occurrence with a comma separator character separating the columns.

SQL Export Comments

For SQL exports, the contents will be contained in one file which will include, by default, the schema, trigger definitions and individual SQL INSERT statements for all the data in the database.

CAT Export Comments

The CAT export will export the compiled catalog in a JSON text format. This is the same catalog that would be generated by the rdm-compile command being run against the schema definition file.

STATS Export Comments

If a SQL database has had 'statistics' executed on the database, the results of those statistics can be extracted in a JSON text format. Statistics are used to optimize SQL query access so that queries use the most efficient access method to find the data request by the query statement. See Optimizer section for more information.

Default Value

If the type option is not defined, the default value of SQL is used.

Example

type=SQL

See also

rdm-export