[jira] [Updated] (DERBY-6042) Document the syscs_util.syscs_register_tool procedure added by DERBY-6022.
[ https://issues.apache.org/jira/browse/DERBY-6042?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Kim Haase updated DERBY-6042: - Attachment: DERBY-6042-2.zip DERBY-6042-2.diff Thanks again, Rick. I'm attaching DERBY-6042-2.diff and DERBY-6042-2.zip, with the single change to src/ref/rrefregistertoolproc.dita that you notice. I'll go ahead and commit this second patch, unless I hear otherwise. > Document the syscs_util.syscs_register_tool procedure added by DERBY-6022. > -- > > Key: DERBY-6042 > URL: https://issues.apache.org/jira/browse/DERBY-6042 > Project: Derby > Issue Type: Improvement > Components: Documentation >Affects Versions: 10.10.0.0 >Reporter: Rick Hillegas >Assignee: Kim Haase > Attachments: DERBY-6042-2.diff, DERBY-6042-2.zip, DERBY-6042.diff, > DERBY-6042.stat, DERBY-6042.zip > > > We should document the new syscs_util.syscs_register_tool() procedure and the > new optional tools which it loads and unloads. The following changes make > sense to me: > -- > -- Reference Manual > -- > -- New section on the syscs_util.syscs_register_tool() procedure > -- > This procedure loads and unloads optional tools packages. By default, only > the DBO can run this procedure. > Syntax: > SYSCS_UTIL.SYSCS_REGISTER_TOOL > ( > IN TOOLNAME VARCHAR(128), > IN REGISTER BOOLEAN, > IN OPTIONALARGS VARCHAR(128) ... > ); > No result set is returned by this procedure. > TOOLNAME > Name of the optional tool. One of: 'databaseMetaData' or 'foreignViews' > REGISTER > True means the tool is loaded. False means it is unloaded. > OPTIONALARGS > Optional arguments specific to each tool. > The following optional tools are supported: > databaseMetaData > This optional tool creates functions and table functions to wrap the methods > in java.sql.DatabaseMetaData. This lets you use DatabaseMetaData methods in > queries. This includes the ability to 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 ) > The Tools Guide provides more information on how to use this tool. > 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 Derby. This tool takes two > additional arguments: > CONNECTION_URL > This is a connection URL string suitable for creating a connection to the > foreign database via 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_' ) > The Tools Guide provides more information on how to use this tool. > -- > -- Tools Guide > -- > -- New section on the optional databaseMetaData tool > -- > This is an optional tool loaded and unloaded by the > syscs_util.syscs_register_tool() system procedure. Loading this tool creates > functions and table functions corresponding to most of the methods in the > java.sql.DatabaseMetaData interface. To load this tool, do the following: > call syscs_util.syscs_register_tool( 'databaseMetaData', true ) > That command creates metadata functions and table functions in the current > schema. The functions and table functions have the same names as the > corresponding DatabaseMetaData methods which they wrap. Once you have loaded > this tool, you can filter and join these functions to create powerful > metadata queries. For instance, the following query lists the column names > and datatypes for all columns in tables created by users: > select t.table_schem, t.table_name, c.column_name, c.type_name > from table( getTables( null, '%', '%' ) ) t, > table( getColumns( null, '%', '%', '%') ) c > where c.table_schem = t.table_schem > and c.table_name = t.table_name > and t.table_type = 'TABLE' > order by table_schem, table_name, column_name > A couple DatabaseMetaData methods take array arguments. Because those > arguments can't be represented as Derby types, th
[jira] [Updated] (DERBY-6042) Document the syscs_util.syscs_register_tool procedure added by DERBY-6022.
[ https://issues.apache.org/jira/browse/DERBY-6042?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Kim Haase updated DERBY-6042: - Issue & fix info: Patch Available > Document the syscs_util.syscs_register_tool procedure added by DERBY-6022. > -- > > Key: DERBY-6042 > URL: https://issues.apache.org/jira/browse/DERBY-6042 > Project: Derby > Issue Type: Improvement > Components: Documentation >Affects Versions: 10.10.0.0 >Reporter: Rick Hillegas >Assignee: Kim Haase > Attachments: DERBY-6042.diff, DERBY-6042.stat, DERBY-6042.zip > > > We should document the new syscs_util.syscs_register_tool() procedure and the > new optional tools which it loads and unloads. The following changes make > sense to me: > -- > -- Reference Manual > -- > -- New section on the syscs_util.syscs_register_tool() procedure > -- > This procedure loads and unloads optional tools packages. By default, only > the DBO can run this procedure. > Syntax: > SYSCS_UTIL.SYSCS_REGISTER_TOOL > ( > IN TOOLNAME VARCHAR(128), > IN REGISTER BOOLEAN, > IN OPTIONALARGS VARCHAR(128) ... > ); > No result set is returned by this procedure. > TOOLNAME > Name of the optional tool. One of: 'databaseMetaData' or 'foreignViews' > REGISTER > True means the tool is loaded. False means it is unloaded. > OPTIONALARGS > Optional arguments specific to each tool. > The following optional tools are supported: > databaseMetaData > This optional tool creates functions and table functions to wrap the methods > in java.sql.DatabaseMetaData. This lets you use DatabaseMetaData methods in > queries. This includes the ability to 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 ) > The Tools Guide provides more information on how to use this tool. > 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 Derby. This tool takes two > additional arguments: > CONNECTION_URL > This is a connection URL string suitable for creating a connection to the > foreign database via 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_' ) > The Tools Guide provides more information on how to use this tool. > -- > -- Tools Guide > -- > -- New section on the optional databaseMetaData tool > -- > This is an optional tool loaded and unloaded by the > syscs_util.syscs_register_tool() system procedure. Loading this tool creates > functions and table functions corresponding to most of the methods in the > java.sql.DatabaseMetaData interface. To load this tool, do the following: > call syscs_util.syscs_register_tool( 'databaseMetaData', true ) > That command creates metadata functions and table functions in the current > schema. The functions and table functions have the same names as the > corresponding DatabaseMetaData methods which they wrap. Once you have loaded > this tool, you can filter and join these functions to create powerful > metadata queries. For instance, the following query lists the column names > and datatypes for all columns in tables created by users: > select t.table_schem, t.table_name, c.column_name, c.type_name > from table( getTables( null, '%', '%' ) ) t, > table( getColumns( null, '%', '%', '%') ) c > where c.table_schem = t.table_schem > and c.table_name = t.table_name > and t.table_type = 'TABLE' > order by table_schem, table_name, column_name > A couple DatabaseMetaData methods take array arguments. Because those > arguments can't be represented as Derby types, the arguments are eliminated. > This means that the trailing "types" arguments to getTables() and getUDTs() > have been eliminated. In addition, the following DatabaseMetaData methods > don't have corresponding metadata routines: > o getRowIdLifetime() is eliminated because Derby does not provide an >
[jira] [Updated] (DERBY-6042) Document the syscs_util.syscs_register_tool procedure added by DERBY-6022.
[ https://issues.apache.org/jira/browse/DERBY-6042?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Kim Haase updated DERBY-6042: - Attachment: DERBY-6042.zip DERBY-6042.stat DERBY-6042.diff Attaching DERBY-6042.diff, DERBY-6042.stat, and DERBY-6042.zip, with four new topics and corresponding changes to map files: A src/ref/rrefregistertoolproc.dita M src/ref/refderby.ditamap M src/tools/derbytools.ditamap A src/tools/rtoolsoptdbmetadata.dita A src/tools/rtoolsoptforeignviews.dita A src/tools/ctoolsopttools.dita I created an umbrella topic for the optional tools in the Tools Guide, just in case more come along at some point. All comments are welcome! > Document the syscs_util.syscs_register_tool procedure added by DERBY-6022. > -- > > Key: DERBY-6042 > URL: https://issues.apache.org/jira/browse/DERBY-6042 > Project: Derby > Issue Type: Improvement > Components: Documentation >Affects Versions: 10.10.0.0 >Reporter: Rick Hillegas >Assignee: Kim Haase > Attachments: DERBY-6042.diff, DERBY-6042.stat, DERBY-6042.zip > > > We should document the new syscs_util.syscs_register_tool() procedure and the > new optional tools which it loads and unloads. The following changes make > sense to me: > -- > -- Reference Manual > -- > -- New section on the syscs_util.syscs_register_tool() procedure > -- > This procedure loads and unloads optional tools packages. By default, only > the DBO can run this procedure. > Syntax: > SYSCS_UTIL.SYSCS_REGISTER_TOOL > ( > IN TOOLNAME VARCHAR(128), > IN REGISTER BOOLEAN, > IN OPTIONALARGS VARCHAR(128) ... > ); > No result set is returned by this procedure. > TOOLNAME > Name of the optional tool. One of: 'databaseMetaData' or 'foreignViews' > REGISTER > True means the tool is loaded. False means it is unloaded. > OPTIONALARGS > Optional arguments specific to each tool. > The following optional tools are supported: > databaseMetaData > This optional tool creates functions and table functions to wrap the methods > in java.sql.DatabaseMetaData. This lets you use DatabaseMetaData methods in > queries. This includes the ability to 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 ) > The Tools Guide provides more information on how to use this tool. > 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 Derby. This tool takes two > additional arguments: > CONNECTION_URL > This is a connection URL string suitable for creating a connection to the > foreign database via 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_' ) > The Tools Guide provides more information on how to use this tool. > -- > -- Tools Guide > -- > -- New section on the optional databaseMetaData tool > -- > This is an optional tool loaded and unloaded by the > syscs_util.syscs_register_tool() system procedure. Loading this tool creates > functions and table functions corresponding to most of the methods in the > java.sql.DatabaseMetaData interface. To load this tool, do the following: > call syscs_util.syscs_register_tool( 'databaseMetaData', true ) > That command creates metadata functions and table functions in the current > schema. The functions and table functions have the same names as the > corresponding DatabaseMetaData methods which they wrap. Once you have loaded > this tool, you can filter and join these functions to create powerful > metadata queries. For instance, the following query lists the column names > and datatypes for all columns in tables created by users: > select t.table_schem, t.table_name, c.column_name, c.type_name > from table( getTables( null, '%', '%' ) ) t, > table( getColumns( null, '%', '%', '%') ) c
