No result set is returned by this procedure.

TOOLNAME

The name of the optional tool. Must be one of the following case-sensitive names: 'databaseMetaData', 'foreignViews', 'luceneSupport', 'simpleJson', or 'rawDBReader'.

REGISTER

A value of true tells to load the tool. A value of false tells to unload the tool.

OPTIONALARGS

Optional case-sensitive string arguments specific to each tool.

If authentication and SQL authorization are both enabled, only the database owner has execute privileges on this procedure by default. See "Configuring user authentication" and "Configuring user authorization" in the for more information. The database owner can grant access to other users.

The following optional tools are supported:

• databaseMetaData

  This optional tool creates functions and table functions to wrap the methods in java.sql.DatabaseMetaData, allowing you to use DatabaseMetaData methods in queries. For example, you can join and filter the ResultSets returned by DatabaseMetaData methods. This tool does not require any optional arguments. To create the metadata functions and table functions, do the following:

  call syscs_util.syscs_register_tool( 'databaseMetaData', true )

  To drop the functions and table functions, do the following:

  call syscs_util.syscs_register_tool( 'databaseMetaData', false )
• foreignViews

  This optional tool creates schemas, table functions, and convenience views for all user tables in a foreign database. The table functions and views are useful for bulk-importing foreign data into . This tool takes two additional arguments:

  CONNECTION_URL

  This is a connection URL string suitable for creating a connection to the foreign database by calling DriverManager.getConnection().

  SCHEMA_PREFIX

  This is an optional string prefixed to all of the schema names which the tool creates. This argument may be omitted. If it is omitted, then the tool will create schemas which have the same names as the schemas in the foreign database.

  To create views on the foreign data, do the following:

  call syscs_util.syscs_register_tool( 'foreignViews', true, 'foreignDatabaseURL', 'XYZ_' )

  To drop the views on the foreign data, do the following:

  call syscs_util.syscs_register_tool( 'foreignViews', false, 'foreignDatabaseURL', 'XYZ_' )

See the for more information on how to use these tools. Before you run an optional tool, make sure that your classpath contains the jar files, including derbytools.jar.