sqlf write-schema-to-xml

Writes the schema of a database to an XML file. You can use the resulting XML file to recreate the schema in SQLFire, or in another database management system. This command is generally used with a SQLFire cluster to export the schema, but it can also be used with other JDBC datasources.

Syntax


To write a database schema to an XML file, use the syntax:

sqlf write-schema-to-xml -file=<path>
     [-bind-address=<address>]
     [-catalog-pattern=<pattern>]
     [-client-bind-address=<address>]
     [-client-port=<port>]
     [-database-type=<db type>]
     [-delimited-identifiers=<true | false>]
     [-driver-class=<class name>]
     [-exclude-table-filter=<filter>] 
     [-exclude-tables=<name,name,...>]
     [-extra-conn-props=<properties>] 
     [-help] 
     [-include-table-filter=<filter>] 
     [-include-tables=<name,name,...>]
     [-isolation-level=<level>]
     [-locators=<adresses>]
     [-mcast-address=<address>]
     [-mcast-port=<port>]
     [-password[=<password>]]
     [-schema-pattern=<pattern>]
     [-url=<url>]
     [-user=<username>]
     [-verbose=<level>]

This table describes options for the sqlf write-schema-to-xml command. Default values are used if you do not specify an option.

Option Description
-file

The full path of the XML file to create. This argument is required.

-bind-address The address to which this peer binds for receiving peer-to-peer messages. By default sqlf uses the hostname, or localhost if the hostname points to a local loopback address.
-catalog-pattern

A string pattern that determines the database catalogs that sqlf writes. sqlf does not use a default catalog pattern.

To use a catalog pattern, specify a string value that describes the catalogs that you want to write. Use the "%" character to match any substring of 0 or more characters. Use the "_" character to match any individual character.

-client-bind-address

The hostname or IP address on which a SQLFire locator listens for client connections. The default is "localhost."

Use this option with -client-port to attach to a SQLFire cluster as a thin client and perform the command.

-client-port

The port on which a SQLFire locator listens for client connections. The default is 1527.

Use this option with -client-bind-address to attach to a SQLFire cluster as a thin client and perform the command.

-database-type Specifies the type of database to which you are connecting. Use this option if sqlf cannot determine the type of database from the JDBC driver and JDBC connection URL. Valid values are: axion, cloudscape, db2, derby, firebird, hsqldb, interbase, maxdb, mckoi, mssql, mysql, mysql5, oracle, oracle9, oracle10, postgresql, sapdb, sqlfire, and sybase.
-delimited-identifiers

Specifies whether to use delimited (quoted) identifiers for table names, column names, and so forth. Most databases convert undelimited identifiers to uppercase letters and ignore any case that you specify in the SQL command.

You can set this option to "true" for platforms that support delimited identifiers. However, keep in mind that when you use delimited identifiers, you must always enclose identifiers in double quotes, and you must specify the correct case for the identifier in all subsequent SQL commands.

By default, sqlf sets this option to "false."

-driver-class

The JDBC driver class to use for connecting to a datasource. Use this option with -url to connect to a JDBC datasource.

-exclude-table-filter Specifies a regular expression to use for excluding tables when reading the database. Tables that match the pattern are not included in the output file. For case-insensitive matching (-delimited-identifiers option is false), specify uppercase table names in the pattern.
-exclude-tables Specifies the name of one or more tables to exclude when reading the database.
-extra-conn-props

A semicolon-separated list of properties to use when connecting to the datasource.

-help, --help

Display the help message for this sqlf command.

-include-table-filter Specifies a regular expression to use for including tables when reading the database. Tables that match the pattern are included in the output file. For case-insensitive matching (-delimited-identifiers option is false), specify uppercase table names in the pattern.
-include-tables Specifies the name of one or more tables to include when reading the database.
-isolation-level Sets the ANSI standard transaction isolation level for database operations. Valid values are READ_UNCOMMITTED, READ_COMMITTED, REPEATABLE_READ, and SERIALIZABLE (case insensitive).
-locators

The list of locators as comma-separated host[port] values, used to discover other members of the distributed system.

Using -locators creates a peer client member to execute the sqlf command.

-mcast-address

The multicast address used to discover other members of the distributed system. This value is used only when the -locators option is not specified. The default multicast address is 239.192.81.1.

Use this option with -mcast-port to attach to a SQLFire cluster as a peer client and perform the command.

-mcast-port

The multicast port used to communicate with other members of the distributed system. If zero, multicast is not used for member discovery (specify -locators instead). This value is used only if the -locators option is not specified.

Valid values are in the range 0–65535, with a default value of 10334.

Use this option with -mcast-address to attach to a SQLFire cluster as a peer client and perform the command.

-password

If the servers or locators have been configured to use authentication, this option specifies the password for the user (specified with the -user option) to use for booting the server and joining the distributed system.

The password value is optional. If you omit the password, sqlf prompts you to enter a password from the console.

-schema-pattern

A string pattern that determines the schema(s) that sqlf writes. sqlf does not use a default schema pattern. However, with certain databases you may be required to use a schema pattern to exclude system tables that contain data types that are incompatible with the DdlUtils 1.1 API.

To use a schema pattern, specify a string value that describes the catalogs that you want to write. Use the "%" character to match any substring of 0 or more characters. Use the "_" character to match any individual character.

-url

The JDBC URL to use for connecting to a datasource. Use this option with -driver-class to connect to a JDBC datasource.

-user If the servers or locators have been configured to use authentication, this option specifies the user name to use for booting the server and joining the distributed system.
-verbose

Sets the DdlUtils verbosity level to one of FATAL, ERROR, WARN, INFO, or DEBUG, in increasing order of logging. The default level is INFO.

Description

Specify one of these pairs of options to connect to a data source with this command:
  • Use both -client-bind-address and -client-port to connect to a SQLFire cluster as a thin client and perform the command.
  • Use both mcast-port and -mcast-address, or use the -locators property to connect to a SQLFire cluster as a peer client and perform the command.
  • Use both -url and -driver-class to connect to a datasource using a JDBC URL and driver. You can use this option to connect to a data source other than SQLFire.

Examples

Note: See also Export, Alter, and Import a Database Schema Using SQLF for a full example of migrating a third-party database to vFabric SQLFire.
This command connects to a SQLFire network server running on localhost:1527, and writes the database schema to a file named db-schema.xml:
sqlf write-schema-to-xml -file=db-schema.xml
This command connects to a SQLFire network server running on myserver:1234, and writes the database schema to a file named db-schema.xml:
sqlf write-schema-to-xml -file=db-schema.xml -client-bind-address=myserver -client-port=1234
This command connects as a peer client to a SQLFire system running on multicast port 1234, and writes the database schema to a file named db-schema.xml:
sqlf write-schema-to-xml -file=db-schema.xml -mcast-port=1234
		  -extra-conn-props=host-data=false
		
This command uses MySQL Connector/J to connect to a MySQL server running on the "myserver" host, and writes the “test�? database schema to a file name db-schema.xml:
sqlf write-schema-to-xml -file=db-schema.xml
		  -url=jdbc:mysql://myserver/test -driver-class=com.mysql.jdbc.Driver