Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.apache.derby.catalog
Class SystemProcedures  view SystemProcedures download SystemProcedures.java

java.lang.Object
  extended byorg.apache.derby.catalog.SystemProcedures

public class SystemProcedures
extends java.lang.Object

Some system built-in procedures, and help routines. Now used for network server. These procedures are built-in to the SYSIBM schema which match the DB2 SYSIBM procedures. Currently information on those can be found at url: ftp://ftp.software.ibm.com/ps/products/db2/info/vr8/pdf/letter/db2l2e80.pdf


Field Summary
private static java.lang.String DRIVER_TYPE_OPTION
           
private static java.lang.String ODBC_DRIVER_OPTION
           
private static int SQL_BEST_ROWID
           
private static int SQL_ROWVER
           
 
Constructor Summary
SystemProcedures()
           
 
Method Summary
private static void checkJarSQLName(java.lang.String sqlName)
           
private static java.sql.Connection getDefaultConn()
          Get the default or nested connection corresponding to the URL jdbc:default:connection.
private static java.sql.DatabaseMetaData getDMD()
          Get the DatabaseMetaData for the current connection for use in mapping the jcc SYSIBM.* calls to the Cloudscape DatabaseMetaData methods
private static java.lang.String getOption(java.lang.String pattern, java.lang.String options)
          Helper for SQLForeignKeys and SQLTables
static void INSTALL_JAR(java.lang.String url, java.lang.String jar, int deploy)
          Install a jar file in the database.
private static boolean isForODBC(java.lang.String options)
          Helper for ODBC metadata calls.
static void METADATA(java.sql.ResultSet[] rs)
           
static void REMOVE_JAR(java.lang.String jar, int undeploy)
          Remove a jar file from the database.
static void REPLACE_JAR(java.lang.String url, java.lang.String jar)
          Replace a jar file in the database.
static void SQLCAMESSAGE(int sqlcode, short errmcLen, java.lang.String sqlerrmc, java.lang.String sqlerrp, int errd0, int errd1, int errd2, int errd3, int errd4, int errd5, java.lang.String warn, java.lang.String sqlState, java.lang.String file, java.lang.String localeStr, java.lang.String[] msg, int[] rc)
          Method used by Cloudscape Network Server to get localized message (original call from jcc.
static void SQLCOLPRIVILEGES(java.lang.String catalogName, java.lang.String schemaName, java.lang.String tableName, java.lang.String columnName, java.lang.String options, java.sql.ResultSet[] rs)
          Map SQLColPrivileges to EmbedDatabaseMetaData.getColumnPrivileges
static void SQLCOLUMNS(java.lang.String catalogName, java.lang.String schemaName, java.lang.String tableName, java.lang.String columnName, java.lang.String options, java.sql.ResultSet[] rs)
          Map SQLColumns to EmbedDatabaseMetaData.getColumns
static void SQLFOREIGNKEYS(java.lang.String pkCatalogName, java.lang.String pkSchemaName, java.lang.String pkTableName, java.lang.String fkCatalogName, java.lang.String fkSchemaName, java.lang.String fkTableName, java.lang.String options, java.sql.ResultSet[] rs)
          Map SQLForeignKeys to EmbedDatabaseMetaData.getImportedKeys, getExportedKeys, and getCrossReference
static void SQLGETTYPEINFO(short dataType, java.lang.String options, java.sql.ResultSet[] rs)
          Map SQLGetTypeInfo to EmbedDatabaseMetaData.getTypeInfo
static void SQLPRIMARYKEYS(java.lang.String catalogName, java.lang.String schemaName, java.lang.String tableName, java.lang.String options, java.sql.ResultSet[] rs)
          Map SQLPrimaryKeys to EmbedDatabaseMetaData.getPrimaryKeys
static void SQLPROCEDURECOLS(java.lang.String catalogName, java.lang.String schemaName, java.lang.String procName, java.lang.String paramName, java.lang.String options, java.sql.ResultSet[] rs)
          Map SQLProcedureCols to EmbedDatabaseMetaData.getProcedureColumns
static void SQLPROCEDURES(java.lang.String catalogName, java.lang.String schemaName, java.lang.String procName, java.lang.String options, java.sql.ResultSet[] rs)
          Map SQLProcedures to EmbedDatabaseMetaData.getProcedures
static void SQLSPECIALCOLUMNS(short colType, java.lang.String catalogName, java.lang.String schemaName, java.lang.String tableName, short scope, short nullable, java.lang.String options, java.sql.ResultSet[] rs)
          Map SQLSpecialColumns to EmbedDatabaseMetaData.getBestRowIdentifier and getVersionColumns
static void SQLSTATISTICS(java.lang.String catalogName, java.lang.String schemaName, java.lang.String tableName, short unique, short approximate, java.lang.String options, java.sql.ResultSet[] rs)
          Map SQLStatistics to EmbedDatabaseMetaData.getIndexInfo
static void SQLTABLEPRIVILEGES(java.lang.String catalogName, java.lang.String schemaName, java.lang.String tableName, java.lang.String options, java.sql.ResultSet[] rs)
          Map SQLTablePrivileges to EmbedDatabaseMetaData.getTablePrivileges
static void SQLTABLES(java.lang.String catalogName, java.lang.String schemaName, java.lang.String tableName, java.lang.String tableType, java.lang.String options, java.sql.ResultSet[] rs)
          Map SQLTables to EmbedDatabaseMetaData.getSchemas, getCatalogs, getTableTypes and getTables containing the result of the DatabaseMetaData calls
static void SQLUDTS(java.lang.String catalogName, java.lang.String schemaPattern, java.lang.String typeNamePattern, java.lang.String udtTypes, java.lang.String options, java.sql.ResultSet[] rs)
          Map SQLUDTS to EmbedDatabaseMetaData.getUDTs
static void SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE(java.lang.String backupDir, int deleteOnlineArchivedLogFiles)
           
static void SYSCS_BACKUP_DATABASE(java.lang.String backupDir)
           
static void SYSCS_BULK_INSERT(java.lang.String schemaName, java.lang.String tableName, java.lang.String vtiName, java.lang.String vtiArg)
          Perform bulk insert using the specificed vti .
static int SYSCS_CHECK_TABLE(java.lang.String schema, java.lang.String tablename)
           
static void SYSCS_CHECKPOINT_DATABASE()
           
static void SYSCS_COMPRESS_TABLE(java.lang.String schema, java.lang.String tablename, int sequential)
          Compress the table.
static void SYSCS_DISABLE_LOG_ARCHIVE_MODE(int deleteOnlineArchivedLogFiles)
           
static void SYSCS_EXPORT_QUERY(java.lang.String selectStatement, java.lang.String fileName, java.lang.String columnDelimiter, java.lang.String characterDelimiter, java.lang.String codeset)
          Export data from a select statement to given file.
static void SYSCS_EXPORT_TABLE(java.lang.String schemaName, java.lang.String tableName, java.lang.String fileName, java.lang.String columnDelimiter, java.lang.String characterDelimiter, java.lang.String codeset)
          Export data from a table to given file.
static void SYSCS_FREEZE_DATABASE()
          Freeze the database.
static java.lang.String SYSCS_GET_DATABASE_PROPERTY(java.lang.String key)
          Get the value of a property of the database in current connection.
static java.lang.String SYSCS_GET_RUNTIMESTATISTICS()
           
static void SYSCS_IMPORT_DATA(java.lang.String schemaName, java.lang.String tableName, java.lang.String insertColumnList, java.lang.String columnIndexes, java.lang.String fileName, java.lang.String columnDelimiter, java.lang.String characterDelimiter, java.lang.String codeset, short replace)
          Import data from a given file into the specified table columns from the specified columns in the file.
static void SYSCS_IMPORT_TABLE(java.lang.String schemaName, java.lang.String tableName, java.lang.String fileName, java.lang.String columnDelimiter, java.lang.String characterDelimiter, java.lang.String codeset, short replace)
          Import data from a given file to a table.
static void SYSCS_INPLACE_COMPRESS_TABLE(java.lang.String schema, java.lang.String tablename, int purgeRows, int defragementRows, int truncateEnd)
           
static void SYSCS_SET_DATABASE_PROPERTY(java.lang.String key, java.lang.String value)
          Set/delete the value of a property of the database in current connection.
static void SYSCS_SET_RUNTIMESTATISTICS(int enable)
           
static void SYSCS_SET_STATISTICS_TIMING(int enable)
           
static void SYSCS_UNFREEZE_DATABASE()
          Unfreeze the database.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SQL_BEST_ROWID

private static final int SQL_BEST_ROWID
See Also:
Constant Field Values

SQL_ROWVER

private static final int SQL_ROWVER
See Also:
Constant Field Values

DRIVER_TYPE_OPTION

private static final java.lang.String DRIVER_TYPE_OPTION
See Also:
Constant Field Values

ODBC_DRIVER_OPTION

private static final java.lang.String ODBC_DRIVER_OPTION
See Also:
Constant Field Values
Constructor Detail

SystemProcedures

public SystemProcedures()
Method Detail

SQLCAMESSAGE

public static void SQLCAMESSAGE(int sqlcode,
                                short errmcLen,
                                java.lang.String sqlerrmc,
                                java.lang.String sqlerrp,
                                int errd0,
                                int errd1,
                                int errd2,
                                int errd3,
                                int errd4,
                                int errd5,
                                java.lang.String warn,
                                java.lang.String sqlState,
                                java.lang.String file,
                                java.lang.String localeStr,
                                java.lang.String[] msg,
                                int[] rc)
Method used by Cloudscape Network Server to get localized message (original call from jcc.


getDefaultConn

private static java.sql.Connection getDefaultConn()
                                           throws java.sql.SQLException
Get the default or nested connection corresponding to the URL jdbc:default:connection. We do not use DriverManager here as it is not supported in JSR 169. IN addition we need to perform more checks for null drivers or the driver returing null from connect as that logic is in DriverManager.


getDMD

private static java.sql.DatabaseMetaData getDMD()
                                         throws java.sql.SQLException
Get the DatabaseMetaData for the current connection for use in mapping the jcc SYSIBM.* calls to the Cloudscape DatabaseMetaData methods


SQLPROCEDURES

public static void SQLPROCEDURES(java.lang.String catalogName,
                                 java.lang.String schemaName,
                                 java.lang.String procName,
                                 java.lang.String options,
                                 java.sql.ResultSet[] rs)
                          throws java.sql.SQLException
Map SQLProcedures to EmbedDatabaseMetaData.getProcedures


SQLTABLES

public static void SQLTABLES(java.lang.String catalogName,
                             java.lang.String schemaName,
                             java.lang.String tableName,
                             java.lang.String tableType,
                             java.lang.String options,
                             java.sql.ResultSet[] rs)
                      throws java.sql.SQLException
Map SQLTables to EmbedDatabaseMetaData.getSchemas, getCatalogs, getTableTypes and getTables containing the result of the DatabaseMetaData calls


SQLFOREIGNKEYS

public static void SQLFOREIGNKEYS(java.lang.String pkCatalogName,
                                  java.lang.String pkSchemaName,
                                  java.lang.String pkTableName,
                                  java.lang.String fkCatalogName,
                                  java.lang.String fkSchemaName,
                                  java.lang.String fkTableName,
                                  java.lang.String options,
                                  java.sql.ResultSet[] rs)
                           throws java.sql.SQLException
Map SQLForeignKeys to EmbedDatabaseMetaData.getImportedKeys, getExportedKeys, and getCrossReference


getOption

private static java.lang.String getOption(java.lang.String pattern,
                                          java.lang.String options)
Helper for SQLForeignKeys and SQLTables


SQLPROCEDURECOLS

public static void SQLPROCEDURECOLS(java.lang.String catalogName,
                                    java.lang.String schemaName,
                                    java.lang.String procName,
                                    java.lang.String paramName,
                                    java.lang.String options,
                                    java.sql.ResultSet[] rs)
                             throws java.sql.SQLException
Map SQLProcedureCols to EmbedDatabaseMetaData.getProcedureColumns


SQLCOLUMNS

public static void SQLCOLUMNS(java.lang.String catalogName,
                              java.lang.String schemaName,
                              java.lang.String tableName,
                              java.lang.String columnName,
                              java.lang.String options,
                              java.sql.ResultSet[] rs)
                       throws java.sql.SQLException
Map SQLColumns to EmbedDatabaseMetaData.getColumns


SQLCOLPRIVILEGES

public static void SQLCOLPRIVILEGES(java.lang.String catalogName,
                                    java.lang.String schemaName,
                                    java.lang.String tableName,
                                    java.lang.String columnName,
                                    java.lang.String options,
                                    java.sql.ResultSet[] rs)
                             throws java.sql.SQLException
Map SQLColPrivileges to EmbedDatabaseMetaData.getColumnPrivileges


SQLTABLEPRIVILEGES

public static void SQLTABLEPRIVILEGES(java.lang.String catalogName,
                                      java.lang.String schemaName,
                                      java.lang.String tableName,
                                      java.lang.String options,
                                      java.sql.ResultSet[] rs)
                               throws java.sql.SQLException
Map SQLTablePrivileges to EmbedDatabaseMetaData.getTablePrivileges


SQLPRIMARYKEYS

public static void SQLPRIMARYKEYS(java.lang.String catalogName,
                                  java.lang.String schemaName,
                                  java.lang.String tableName,
                                  java.lang.String options,
                                  java.sql.ResultSet[] rs)
                           throws java.sql.SQLException
Map SQLPrimaryKeys to EmbedDatabaseMetaData.getPrimaryKeys


SQLGETTYPEINFO

public static void SQLGETTYPEINFO(short dataType,
                                  java.lang.String options,
                                  java.sql.ResultSet[] rs)
                           throws java.sql.SQLException
Map SQLGetTypeInfo to EmbedDatabaseMetaData.getTypeInfo


SQLSTATISTICS

public static void SQLSTATISTICS(java.lang.String catalogName,
                                 java.lang.String schemaName,
                                 java.lang.String tableName,
                                 short unique,
                                 short approximate,
                                 java.lang.String options,
                                 java.sql.ResultSet[] rs)
                          throws java.sql.SQLException
Map SQLStatistics to EmbedDatabaseMetaData.getIndexInfo


SQLSPECIALCOLUMNS

public static void SQLSPECIALCOLUMNS(short colType,
                                     java.lang.String catalogName,
                                     java.lang.String schemaName,
                                     java.lang.String tableName,
                                     short scope,
                                     short nullable,
                                     java.lang.String options,
                                     java.sql.ResultSet[] rs)
                              throws java.sql.SQLException
Map SQLSpecialColumns to EmbedDatabaseMetaData.getBestRowIdentifier and getVersionColumns


SQLUDTS

public static void SQLUDTS(java.lang.String catalogName,
                           java.lang.String schemaPattern,
                           java.lang.String typeNamePattern,
                           java.lang.String udtTypes,
                           java.lang.String options,
                           java.sql.ResultSet[] rs)
                    throws java.sql.SQLException
Map SQLUDTS to EmbedDatabaseMetaData.getUDTs


METADATA

public static void METADATA(java.sql.ResultSet[] rs)
                     throws java.sql.SQLException

isForODBC

private static boolean isForODBC(java.lang.String options)
Helper for ODBC metadata calls.


SYSCS_SET_DATABASE_PROPERTY

public static void SYSCS_SET_DATABASE_PROPERTY(java.lang.String key,
                                               java.lang.String value)
                                        throws java.sql.SQLException
Set/delete the value of a property of the database in current connection.

Will be called as SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY.


SYSCS_GET_DATABASE_PROPERTY

public static java.lang.String SYSCS_GET_DATABASE_PROPERTY(java.lang.String key)
                                                    throws java.sql.SQLException
Get the value of a property of the database in current connection.

Will be called as SYSCS_UTIL.SYSCS_GET_DATABASE_PROPERTY.


SYSCS_COMPRESS_TABLE

public static void SYSCS_COMPRESS_TABLE(java.lang.String schema,
                                        java.lang.String tablename,
                                        int sequential)
                                 throws java.sql.SQLException
Compress the table.

Calls the "alter table compress {sequential}" sql. This syntax is not db2 compatible so it mapped by a system routine. This routine will be called when an application calls: SYSCS_UTIL.SYSCS_COMPRESS_TABLE


SYSCS_FREEZE_DATABASE

public static void SYSCS_FREEZE_DATABASE()
                                  throws java.sql.SQLException
Freeze the database.

Call internal routine to freeze the database so that a backup can be made.


SYSCS_UNFREEZE_DATABASE

public static void SYSCS_UNFREEZE_DATABASE()
                                    throws java.sql.SQLException
Unfreeze the database.

Call internal routine to unfreeze the database, which was "freezed" by calling SYSCS_FREEZE_DATABASE(). can be made.


SYSCS_CHECKPOINT_DATABASE

public static void SYSCS_CHECKPOINT_DATABASE()
                                      throws java.sql.SQLException

SYSCS_BACKUP_DATABASE

public static void SYSCS_BACKUP_DATABASE(java.lang.String backupDir)
                                  throws java.sql.SQLException

SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE

public static void SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE(java.lang.String backupDir,
                                                                     int deleteOnlineArchivedLogFiles)
                                                              throws java.sql.SQLException

SYSCS_DISABLE_LOG_ARCHIVE_MODE

public static void SYSCS_DISABLE_LOG_ARCHIVE_MODE(int deleteOnlineArchivedLogFiles)
                                           throws java.sql.SQLException

SYSCS_SET_RUNTIMESTATISTICS

public static void SYSCS_SET_RUNTIMESTATISTICS(int enable)
                                        throws java.sql.SQLException

SYSCS_SET_STATISTICS_TIMING

public static void SYSCS_SET_STATISTICS_TIMING(int enable)
                                        throws java.sql.SQLException

SYSCS_CHECK_TABLE

public static int SYSCS_CHECK_TABLE(java.lang.String schema,
                                    java.lang.String tablename)
                             throws java.sql.SQLException

SYSCS_INPLACE_COMPRESS_TABLE

public static void SYSCS_INPLACE_COMPRESS_TABLE(java.lang.String schema,
                                                java.lang.String tablename,
                                                int purgeRows,
                                                int defragementRows,
                                                int truncateEnd)
                                         throws java.sql.SQLException

SYSCS_GET_RUNTIMESTATISTICS

public static java.lang.String SYSCS_GET_RUNTIMESTATISTICS()
                                                    throws java.sql.SQLException

INSTALL_JAR

public static void INSTALL_JAR(java.lang.String url,
                               java.lang.String jar,
                               int deploy)
                        throws java.sql.SQLException
Install a jar file in the database. SQLJ.INSTALL_JAR


REPLACE_JAR

public static void REPLACE_JAR(java.lang.String url,
                               java.lang.String jar)
                        throws java.sql.SQLException
Replace a jar file in the database. SQLJ.REPLACE_JAR


REMOVE_JAR

public static void REMOVE_JAR(java.lang.String jar,
                              int undeploy)
                       throws java.sql.SQLException
Remove a jar file from the database.


checkJarSQLName

private static void checkJarSQLName(java.lang.String sqlName)
                             throws org.apache.derby.iapi.error.StandardException

SYSCS_EXPORT_TABLE

public static void SYSCS_EXPORT_TABLE(java.lang.String schemaName,
                                      java.lang.String tableName,
                                      java.lang.String fileName,
                                      java.lang.String columnDelimiter,
                                      java.lang.String characterDelimiter,
                                      java.lang.String codeset)
                               throws java.sql.SQLException
Export data from a table to given file.

Will be called by system procedure: SYSCS_EXPORT_TABLE(IN SCHEMANAME VARCHAR(128), IN TABLENAME VARCHAR(128), IN FILENAME VARCHAR(32672) , IN COLUMNDELIMITER CHAR(1), IN CHARACTERDELIMITER CHAR(1) , IN CODESET VARCHAR(128))


SYSCS_EXPORT_QUERY

public static void SYSCS_EXPORT_QUERY(java.lang.String selectStatement,
                                      java.lang.String fileName,
                                      java.lang.String columnDelimiter,
                                      java.lang.String characterDelimiter,
                                      java.lang.String codeset)
                               throws java.sql.SQLException
Export data from a select statement to given file.

Will be called as SYSCS_EXPORT_QUERY(IN SELECTSTATEMENT VARCHAR(32672), IN FILENAME VARCHAR(32672) , IN COLUMNDELIMITER CHAR(1), IN CHARACTERDELIMITER CHAR(1) , IN CODESET VARCHAR(128))


SYSCS_IMPORT_TABLE

public static void SYSCS_IMPORT_TABLE(java.lang.String schemaName,
                                      java.lang.String tableName,
                                      java.lang.String fileName,
                                      java.lang.String columnDelimiter,
                                      java.lang.String characterDelimiter,
                                      java.lang.String codeset,
                                      short replace)
                               throws java.sql.SQLException
Import data from a given file to a table.

Will be called by system procedure as SYSCS_IMPORT_TABLE(IN SCHEMANAME VARCHAR(128), IN TABLENAME VARCHAR(128), IN FILENAME VARCHAR(32672) , IN COLUMNDELIMITER CHAR(1), IN CHARACTERDELIMITER CHAR(1) , IN CODESET VARCHAR(128), IN  REPLACE SMALLINT)


SYSCS_IMPORT_DATA

public static void SYSCS_IMPORT_DATA(java.lang.String schemaName,
                                     java.lang.String tableName,
                                     java.lang.String insertColumnList,
                                     java.lang.String columnIndexes,
                                     java.lang.String fileName,
                                     java.lang.String columnDelimiter,
                                     java.lang.String characterDelimiter,
                                     java.lang.String codeset,
                                     short replace)
                              throws java.sql.SQLException
Import data from a given file into the specified table columns from the specified columns in the file.

Will be called as SYSCS_IMPORT_DATA (IN SCHEMANAME  VARCHAR(128), IN TABLENAME    VARCHAR(128),  IN INSERTCOLUMNLIST VARCHAR(32762), IN COLUMNINDEXES VARCHAR(32762), IN FILENAME VARCHAR(32762), IN COLUMNDELIMITER CHAR(1),  IN CHARACTERDELIMITER  CHAR(1) ,  IN CODESET VARCHAR(128) , IN  REPLACE SMALLINT)


SYSCS_BULK_INSERT

public static void SYSCS_BULK_INSERT(java.lang.String schemaName,
                                     java.lang.String tableName,
                                     java.lang.String vtiName,
                                     java.lang.String vtiArg)
                              throws java.sql.SQLException
Perform bulk insert using the specificed vti .

Will be called as SYSCS_BULK_INSERT (IN SCHEMANAME VARCHAR(128), IN TABLENAME    VARCHAR(128),  IN VTINAME VARCHAR(32762), IN VTIARG VARCHAR(32762))