Connecting to GemFire XD with JDBC Tools

Third-party JDBC tools can help you browse data in tables, issue SQL commands, design new tables, and so forth. You can configure these tools to use the GemFire XD JDBC thin client driver to connect to a GemFire XD distributed system.

Although the instructions for setting up each tool vary, the general process for establishing a connection involves configuring the JDBC client driver and setting JDBC connection URL properties. Follow these basic steps:
  1. In the third-party tool, choose to configure a new driver, and select the gemfirexd-client.jar file that contains the GemFire XD JDBC client driver. This file is installed in the lib directory of your GemFire XD installation.
  2. If the tool does not automatically select a driver class, you will generally have the option of selecting a class from within the JAR file. For GemFire XD, select the com.pivotal.gemfirexd.jdbc.ClientDriver class.
  3. In order to use the client driver, you must specify a JDBC connection URL for your GemFire XD distributed system. The basic URL format for the client driver is:
    jdbc:gemfirexd://hostname:port/

    where hostname and port correspond to the -client-bind-address and -client-port value of a GemFire XD server or locator in your distributed system.

  4. Your tool may require that you specify a username and password to use for connecting to the system. If the GemFire XD server or locator enables authentication (using the -auth-provider boot property), then enter a valid username and password combination to connect to the distributed system.

    If authentication is disabled, specify "app" as both the username and password values, or any other temporary value.

    Note: GemFire XD uses the username specified in the JDBC connection as the schema name when you do not provide the schema name for a database object. GemFire XD uses "APP" as the default schema. If your system does not enable authentication, you can specify "APP" for both the username and password to maintain consistency with the default schema behavior.

For a full example of configuring GemFire XD with a third-party JDBC tool, see Using SQuirreL SQL with GemFire XD on the GemFire XD community site.