gfxd write-schema-to-db

Creates a schema in a database by using the contents of a one or more schema XML files (see gfxd write-schema-to-xml). This command is generally used with a GemFire XD cluster to export the schema, but it can also be used with other JDBC datasources.

Syntax

To create a database schema from one or more schema XML files, use the syntax:

gfxd write-schema-to-db -files=<path,path,...>
     [-alter-identity-columns]
     [-auth-provider=<name>]
     [-bind-address=<address>]
     [-catalog-pattern=<pattern>]
     [-client-bind-address=<address>]
     [-client-port=<port>]
     [-database-type=<db type>]
     [-delimited-identifiers=<true | false>]
     [-do-drops]
     [-driver-class=<class name>]
     [-extra-conn-props=<properties>] 
     [-help] [-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 gfxd write-schema-to-db command. Default values are used if you do not specify an option.

Option Description
-files

The full path to one or more schema XML files to use for creating the schema. Use a comma-separated list to specify multiple files. This argument is required.

-alter-identity-columns

This option is provided for tables that have GENERATED ALWAYS identity columns, which prohibit manually inserting identity values even during data import. If one or more tables contains existing GENERATED ALWAYS identity values that you want to preserve, specify -alter-identity-columns with both the gfxd write-schema-to-db and gfxd write-data-to-db commands.

When you include this option with gfxd write-schema-to-db, GemFire XD changes an existing GENERATED ALWAYS identity column to a non-identity column. This enables you to import existing data values for the column.

When you include this option with gfxd write-data-to-db, GemFire XD alters the column to an identity column (GENERATED ALWAYS AS IDENTITY) after the final column value is imported. Identity values are then automatically generated for new rows, and GemFire XD ensures that all new identity values are greater than the last imported value.

As an alternative to using these options, GemFire XD supports GENERATED BY DEFAULT identity columns that permit insertion of the identity value. See Identity Columns in the CREATE TABLE reference page.

-auth-provider Sets the authentication provider to use for peer-to-peer connections as well as client-server connections. Valid values are BUILTIN and LDAP. All other members of the GemFire XD distributed system must use the same authentication provider and user definitions. If you omit this option, the connection uses no authentication mechanism. See Configuring Authentication and Authorization.
-bind-address The address to which this peer binds for receiving peer-to-peer messages. By default gfxd 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 gfxd writes. gfxd 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 GemFire XD locator listens for client connections. The default is "localhost."

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

-client-port

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

Use this option with -client-bind-address to attach to a GemFire XD 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 gfxd 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, gemfirexd, 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, gfxd sets this option to "false."

-do-drops

Include this option to generate SQL for dropping tables and their associated external constraints, if necessary, before recreating them.

-driver-class

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

-extra-conn-props

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

-help, --help

Display the help message for this gfxd command.

-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 gfxd 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 GemFire XD 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 GemFire XD 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, gfxd prompts you to enter a password from the console.

-schema-pattern

A string pattern that determines the schema(s) that gfxd writes. gfxd 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

See also gfxd write-schema-to-xml.

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 GemFire XD 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 GemFire XD 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 GemFire XD.

Examples

This command connects to a GemFire XD network server running on localhost:1527, and creates a database schema using a schema XML file named db-schema.xml:
gfxd write-schema-to-db -files=db-schema.xml
This command connects to a GemFire XD network server running on myserver:1234, and creates a database schema using two schema XML files named db-schema1.xml and db-schema2.xml:
gfxd write-schema-to-db -files=db-schema1.xml,db-schema2.xml 
     -client-bind-address=myserver -client-port=1234
This command connects as a peer client to a GemFire XD system running on multicast port 1234, and creates a database schema using a schema XML file named db-schema.xml:
gfxd write-schema-to-db -files=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 creates a database schema in the "test" database using a schema XML file name db-schema.xml:
gfxd write-schema-to-db -files=db-schema.xml
		  -url=jdbc:mysql://myserver/test -driver-class=com.mysql.jdbc.Driver