Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.catalog.SystemProcedures

Modifier and Type	Field and Description
private static final String	DRIVER_TYPE_OPTION
private static final String	ODBC_DRIVER_OPTION
private static final int	SQL_BEST_ROWID
private static final int	SQL_ROWVER

Access	Constructor and Description
public	SystemProcedures()

Method Summary

Modifier and Type	Method and Description
public static void	addUser(String Name of user userName, String corresponding password password, TransactionController Transaction tc) Create a new user (this entry is called when bootstrapping the credentials of the DBO at database creation time.
private static String	Returns: schemaname.tablename or tablename basicSchemaTableValidation(String If schema name is null, then we will use the current schema to resolve the table name. Empty string for schema name will raise an exception. schemaname, String If table name is null or an empty string, we will throw table not found exception. tablename) Do following checks a)Schema name can't be empty string b)If schema name is null, then we use current schema c)Table name can't be null or empty string
private static void	checkJarSQLName(String sqlName)
private static void	checkLegalUser(DataDictionary The data dictionary dd, String User to check userName) Raise an exception if the user doesn't exist.
public static double	Returns: 1 / tan(x) COT(double The input value value) Cotangent function.
private static void	createXplainSchema(String schemaName)
private static void	createXplainTable(LanguageConnectionContext lcc, String schemaName, XPLAINTableDescriptor t)
private static Connection	Returns: The nested connection getDefaultConn() Get the default or nested connection corresponding to the URL jdbc:default:connection.
private static DatabaseMetaData	Returns: The DatabaseMetaData object of the current connection getDMD() Get the DatabaseMetaData for the current connection for use in mapping the jcc SYSIBM.* calls to the Derby DatabaseMetaData methods
private static ModuleFactory	getMonitor() Helper routine which looks up the monitor.
private static String	Returns: option String containing the value for a given option getOption(String String containing the option to search for pattern, String String containing the options to search through options) Helper for SQLForeignKeys and SQLTables
private static String	Returns: the value mapped to the key getProperty(String The key name key, Securable Authorization handle authorizationCheck) This method exists so that we can get a property value without performing authorization checks.
private static boolean	hasSchema(Connection conn, String schemaName)
private static boolean	hasTable(Connection conn, String schemaName, String tableName)
public static void	INSTALL_JAR(String URL of the jar file to be installed in the database. url, String SQL name jar will be installed as. jar, int Ignored. deploy) Install a jar file in the database.
private static boolean	Returns: True if options contain ODBC indicator; false otherwise. isForODBC(String String containig the options to search through. options) Helper for ODBC metadata calls.
private static UserDescriptor	makeUserDescriptor(DataDictionary dd, TransactionController tc, String userName, String password)
public static void	METADATA(ResultSet[] rs)
private static String	normalizeUserName(String User name userName) Normalize the user name so that there is only one set of credentials for a given authorization id.
public static double	Returns: PI PI() Method to return the constant PI.
public static double	Returns: a random number RAND(int The input seed seed) Pseudo-random number function.
public static void	REMOVE_JAR(String SQL name of jar to be replaced. jar, int Ignored. undeploy) Remove a jar file from the database.
private static void	removeFromAccessList(String The name of the list listProperty, String The user name userName) Utility method for SYSCS_SET_USER_ACCESS removes a user from one of the access lists, driven by the property name.
public static void	REPLACE_JAR(String URL of the jar file to be installed in the database. url, String SQL name of jar to be replaced. jar) Replace a jar file in the database.
private static void	resetAuthorizationIDPassword(String The user's name userName, String The corresponding password password) Reset the password for an already normalized authorization id.
private static void	rollBackAndThrowSQLException(Connection conn, SQLException se) issue a rollback when SQLException se occurs.
private static void	setDatabaseProperty(String key, String value, Securable authorizationCheck)
public static int	Returns: 0, 1 or -1 SIGN(double The input value value) Method to return the sign of the given value.
public static void	SQLCAMESSAGE(int sqlcode, not used. sqlcode, short sqlerrmc length errmcLen, String sql error message tokens, variable part of error message (ie., arguments) plus messageId, separated by separator. sqlerrmc, String not used sqlerrp, int not used errd0, int not used errd1, int not used errd2, int not used errd3, int not used errd4, int not used errd5, String not used warn, String 5-char sql state sqlState, String not used file, String client locale in string localeStr, String[] OUTPUT parameter, localized error message msg, int[] OUTPUT parameter, return code -- 0 for success rc) Method used by Derby Network Server to get localized message (original call from jcc.
public static void	SQLCOLPRIVILEGES(String SYSIBM.SQLColPrivileges CatalogName varchar(128), catalogName, String SYSIBM.SQLColPrivileges SchemaName varchar(128), schemaName, String SYSIBM.SQLColPrivileges ProcName varchar(128), tableName, String SYSIBM.SQLColPrivileges ColumnName varchar(128), columnName, String SYSIBM.SQLColPrivileges Options varchar(4000)) options, ResultSet[] output parameter, the resultset object containing the result of getColumnPrivileges rs) Map SQLColPrivileges to EmbedDatabaseMetaData.getColumnPrivileges
public static void	SQLCOLUMNS(String SYSIBM.SQLColumns CatalogName varchar(128), catalogName, String SYSIBM.SQLColumns SchemaName varchar(128), schemaName, String SYSIBM.SQLColumns TableName varchar(128), tableName, String SYSIBM.SQLColumns ColumnName varchar(128), columnName, String SYSIBM.SQLColumns Options varchar(4000)) If options contains the string 'DATATYPE='ODBC'', call the ODBC version of this procedure. options, ResultSet[] output parameter, the resultset object containing the result of getProcedures rs) Map SQLColumns to EmbedDatabaseMetaData.getColumns
public static void	SQLFOREIGNKEYS(String SYSIBM.SQLForeignKeys PKCatalogName varchar(128), pkCatalogName, String SYSIBM.SQLForeignKeys PKSchemaName varchar(128), pkSchemaName, String SYSIBM.SQLForeignKeys PKTableName varchar(128), pkTableName, String SYSIBM.SQLForeignKeys FKCatalogName varchar(128), fkCatalogName, String SYSIBM.SQLForeignKeys FKSchemaName varchar(128), fkSchemaName, String SYSIBM.SQLForeignKeys FKTableName varchar(128), fkTableName, String SYSIBM.SQLForeignKeys Options varchar(4000)) options, ResultSet[] output parameter, the resultset object containing the result of the DatabaseMetaData calls JCC overloads this method: If options contains the string 'EXPORTEDKEY=1', call getImportedKeys If options contains the string 'IMPORTEDKEY=1', call getExportedKeys otherwise, call getCrossReference rs) Map SQLForeignKeys to EmbedDatabaseMetaData.getImportedKeys, getExportedKeys, and getCrossReference
public static void	SQLFUNCTIONPARAMS(String SYSIBM.SQLFunctionParameters CatalogName varchar(128), catalogName, String SYSIBM.SQLFunctionParameters SchemaName varchar(128), schemaName, String SYSIBM.SQLFunctionParameters FuncName varchar(128), funcName, String SYSIBM.SQLFunctionParameters ParamName varchar(128), paramName, String SYSIBM.SQLFunctionParameters Options varchar(4000)) options, ResultSet[] output parameter, the resultset object containing the result of getFunctionColumns(). rs) Map SQLFunctionParameters to EmbedDatabaseMetaData.getFunctionColumns()
public static void	SQLFUNCTIONS(String SYSIBM.SQLFunctions CatalogName varchar(128), catalogName, String SYSIBM.SQLFunctions SchemaName varchar(128), schemaName, String SYSIBM.SQLFunctions ProcName varchar(128), funcName, String SYSIBM.SQLFunctions Options varchar(4000)) (not used) options, ResultSet[] output parameter, the resultset object containing the result of getFunctions rs) Map SQLFunctions to EmbedDatabaseMetaData.getFunctions
public static void	SQLGETTYPEINFO(short SYSIBM.SQLGetTypeInfo DataType smallint, dataType, String SYSIBM.SQLGetTypeInfo Options varchar(4000)) If options contains the string 'DATATYPE='ODBC'', call the ODBC version of this procedure. options, ResultSet[] output parameter, the resultset object containing the result of getTypeInfo rs) Map SQLGetTypeInfo to EmbedDatabaseMetaData.getTypeInfo
public static void	SQLPRIMARYKEYS(String SYSIBM.SQLPrimaryKeys CatalogName varchar(128), catalogName, String SYSIBM.SQLPrimaryKeys SchemaName varchar(128), schemaName, String SYSIBM.SQLPrimaryKeys TableName varchar(128), tableName, String SYSIBM.SQLPrimaryKeys Options varchar(4000)) If options contains the string 'DATATYPE='ODBC'', call the ODBC version of this procedure. options, ResultSet[] output parameter, the resultset object containing the result of getPrimaryKeys rs) Map SQLPrimaryKeys to EmbedDatabaseMetaData.getPrimaryKeys
public static void	SQLPROCEDURECOLS(String SYSIBM.SQLProcedureCols CatalogName varchar(128), catalogName, String SYSIBM.SQLProcedureCols SchemaName varchar(128), schemaName, String SYSIBM.SQLProcedureCols ProcName varchar(128), procName, String SYSIBM.SQLProcedureCols ParamName varchar(128), paramName, String SYSIBM.SQLProcedureCols Options varchar(4000)) options, ResultSet[] output parameter, the resultset object containing the result of getProcedureColumns If options contains the string 'DATATYPE='ODBC'', call the ODBC version of this procedure. rs) Map SQLProcedureCols to EmbedDatabaseMetaData.getProcedureColumns
public static void	SQLPROCEDURES(String SYSIBM.SQLProcedures CatalogName varchar(128), catalogName, String SYSIBM.SQLProcedures SchemaName varchar(128), schemaName, String SYSIBM.SQLProcedures ProcName varchar(128), procName, String SYSIBM.SQLProcedures Options varchar(4000)) options, ResultSet[] output parameter, the resultset object containing the result of getProcedures If options contains the string 'DATATYPE='ODBC'', call the ODBC version of this procedure. rs) Map SQLProcedures to EmbedDatabaseMetaData.getProcedures
public static void	SQLSPECIALCOLUMNS(short SYSIBM.SQLSpecialColumns ColType smallint, where 1 means getBestRowIdentifier and 2 getVersionColumns was called. colType, String SYSIBM.SQLSpecialColumns CatalogName varchar(128), catalogName, String SYSIBM.SQLSpecialColumns SchemaName varchar(128), schemaName, String SYSIBM.SQLSpecialColumns TableName varchar(128), tableName, short SYSIBM.SQLSpecialColumns Scope smallint, scope, short SYSIBM.SQLSpecialColumns Nullable smallint; 0=false, 1=true, nullable, String SYSIBM.SQLSpecialColumns Options varchar(4000)) If options contains the string 'DATATYPE='ODBC'', call the ODBC version of this procedure. options, ResultSet[] output parameter, the resultset object containing the result of the DatabaseMetaData call rs) Map SQLSpecialColumns to EmbedDatabaseMetaData.getBestRowIdentifier and getVersionColumns
public static void	SQLSTATISTICS(String SYSIBM.SQLStatistics CatalogName varchar(128), catalogName, String SYSIBM.SQLStatistics SchemaName varchar(128), schemaName, String SYSIBM.SQLStatistics TableName varchar(128), tableName, short SYSIBM.SQLStatistics Unique smallint; 0=SQL_INDEX_UNIQUE(0); 1=SQL_INDEX_ALL(1), unique, short SYSIBM.SQLStatistics Approximate smallint; 1=true; 0=false, approximate, String SYSIBM.SQLStatistics Options varchar(4000)) If options contains the string 'DATATYPE='ODBC'', call the ODBC version of this procedure. options, ResultSet[] output parameter, the resultset object containing the result of getIndexInfo rs) Map SQLStatistics to EmbedDatabaseMetaData.getIndexInfo
public static void	SQLTABLEPRIVILEGES(String SYSIBM.SQLTablePrivileges CatalogName varchar(128), catalogName, String SYSIBM.SQLTablePrivileges SchemaName varchar(128), schemaName, String SYSIBM.SQLTablePrivileges ProcName varchar(128), tableName, String SYSIBM.SQLTablePrivileges Options varchar(4000)) options, ResultSet[] output parameter, the resultset object containing the result of getTablePrivileges rs) Map SQLTablePrivileges to EmbedDatabaseMetaData.getTablePrivileges
public static void	SQLTABLES(String SYSIBM.SQLTables CatalogName varchar(128), catalogName, String SYSIBM.SQLTables SchemaName varchar(128), schemaName, String SYSIBM.SQLTables TableName varchar(128), tableName, String SYSIBM.SQLTables TableType varchar(4000)) tableType, String SYSIBM.SQLTables Options varchar(4000)) options, ResultSet[] output parameter, the resultset object rs) Map SQLTables to EmbedDatabaseMetaData.getSchemas, getCatalogs, getTableTypes and getTables, and return the result of the DatabaseMetaData calls.
public static void	SQLUDTS(String SYSIBM.SQLUDTS CatalogName varchar(128), catalogName, String SYSIBM.SQLUDTS Schema_Name_Pattern varchar(128), schemaPattern, String SYSIBM.SQLUDTS Type_Name_Pattern varchar(128), typeNamePattern, String SYSIBM.SQLUDTS UDTTypes varchar(128), udtTypes, String SYSIBM.SQLUDTS Options varchar(4000)) options, ResultSet[] output parameter, the resultset object containing the result of getUDTs, which will be empty rs) Map SQLUDTS to EmbedDatabaseMetaData.getUDTs
public static void	SYSCS_BACKUP_DATABASE(String the name of the directory where the backup should be stored. This directory will be created if it does not exist. backupDir) Backup the database to a backup directory.
public static void	SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE(String the name of the directory where the backup should be stored. This directory will be created if not it does not exist. backupDir, short If `non-zero` deletes online archived log files that exist before this backup, delete will occur only after the backup is complete. deleteOnlineArchivedLogFiles) Backup the database to a backup directory and enable the log archive mode that will keep the archived log files required for roll-forward from this version of the backup.
public static void	SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE_NOWAIT(String the name of the directory where the backup should be stored. This directory will be created if not it does not exist. backupDir, short If `non-zero` deletes online archived log files that exist before this backup, delete will occur only after the backup is complete. deleteOnlineArchivedLogFiles) Backup the database to a backup directory and enable the log archive mode that will keep the archived log files required for roll-forward from this version backup.
public static void	SYSCS_BACKUP_DATABASE_NOWAIT(String the name of the directory where the backup should be stored. This directory will be created if it does not exist. backupDir) Backup the database to a backup directory.
public static void	SYSCS_BULK_INSERT(String Name of schema schemaName, String Name of table tableName, String VTI which supplies the data vtiName, String Its arguments vtiArg) Perform bulk insert using the specificed vti .
public static int	SYSCS_CHECK_TABLE(String schema, String tablename)
public static void	SYSCS_CHECKPOINT_DATABASE()
public static void	SYSCS_COMPRESS_TABLE(String schema name of the table to compress. null will mean use the current schema to resolve the table name. Empty string for schema name will raise an exception. schemaname, String table name of the table to compress. A null value or an empty string will throw table not found exception. Must be non-null. tablename, short if non-zero then rebuild indexes sequentially, if 0 then rebuild all indexes in parallel. sequential) Compress the table.
public static void	SYSCS_CREATE_USER(String Name of user userName, String corresponding password password) Create a new user.
public static void	SYSCS_DISABLE_LOG_ARCHIVE_MODE(short If `non-zero` deletes all the online archived log files that exist before this call immediately. deleteOnlineArchivedLogFiles) Disables the log archival process, i.e No old log files will be kept around for a roll-forward recovery.
public static void	SYSCS_DROP_STATISTICS(String schema name of the table/index(es) whose statistics will be dropped. null will mean use the current schema to resolve the table name. Empty string for schema name will raise an exception. schemaname, String table name of the index(es) whose statistics will be dropped. A null value or an empty string will throw table not found exception. Must be non-null. tablename, String If null, then drop the statistics for all the indexes for the given table name. If not null and not empty string, then the user wants to drop the statistics for only the give index name. Empty string for index name will raise an exception. indexname) Drop the statistics for 1)all the indexes or 2)a specific index on a table.
public static void	SYSCS_DROP_USER(String The user's name userName) Drop a user.
public static void	SYSCS_EMPTY_STATEMENT_CACHE() Empty as much of the cache as possible.
public static void	SYSCS_EXPORT_QUERY(String The query which materializes results selectStatement, String Where to dump the table contents fileName, String Column separator columnDelimiter, String Quote character characterDelimiter, String The encoding to use codeset) Export data from a select statement to given file.
public static void	SYSCS_EXPORT_QUERY_LOBS_TO_EXTFILE(String The query which materializes results selectStatement, String Where to dump the table contents fileName, String Column separator columnDelimiter, String Quote character characterDelimiter, String The encoding to use codeset, String Where to dump the large objects lobsFileName) Export data from a select statement to given file.
public static void	SYSCS_EXPORT_TABLE(String Name of schema schemaName, String Name of table tableName, String Where to dump the table contents fileName, String Column separator columnDelimiter, String Quote character characterDelimiter, String The encoding to use codeset) Export data from a table to given file.
public static void	SYSCS_EXPORT_TABLE_LOBS_TO_EXTFILE(String Name of schema schemaName, String Name of table tableName, String Where to dump the table contents fileName, String Column separator columnDelimiter, String Quote character characterDelimiter, String The encoding to use codeset, String Where to dump the large objects lobsFileName) Export data from a table to given files.
public static void	SYSCS_FREEZE_DATABASE() Freeze the database.
public static String	Returns: database name SYSCS_GET_DATABASE_NAME() Return the database name
public static String	Returns: the value mapped to that key SYSCS_GET_DATABASE_PROPERTY(String The property key. key) Get the value of a property of the database in current connection.
public static String	SYSCS_GET_RUNTIMESTATISTICS()
public static String	Returns: the authorization level for the user SYSCS_GET_USER_ACCESS(String name of the user in its normal form (not a SQL identifier). userName) Get the connection level authorization for a specific user - SYSCS_UTIL.SYSCS_GET_USER_ACCESS.
public static int	Returns: 0 if XPLAIN mode is off, non-zero if on. SYSCS_GET_XPLAIN_MODE() This procedure returns the current status of the xplain mode.
public static String	Returns: schema name, may be blank if no schema currently set. SYSCS_GET_XPLAIN_SCHEMA() This procedure returns the current set XPLAIN_SCHEMA
public static void	SYSCS_IMPORT_DATA(String Name of schema schemaName, String Name of table tableName, String Columns to insert insertColumnList, String Indexes of fields to be imported columnIndexes, String File to read fileName, String Column separator columnDelimiter, String Quote character characterDelimiter, String Encoding codeset, short True if the table should be truncated first replace) Import data from a given file into the specified table columns from the specified columns in the file.
public static void	SYSCS_IMPORT_DATA_BULK(String Name of schema schemaName, String Name of table tableName, String Columns to insert insertColumnList, String Indexes of fields to be imported columnIndexes, String File to read fileName, String Column separator columnDelimiter, String Quote character characterDelimiter, String Encoding codeset, short True if the table should be truncated first replace, short The number of header lines to skip over skip) Import data from a given file into the specified table columns skipping header lines from the specified columns in the file.
public static void	SYSCS_IMPORT_DATA_LOBS_FROM_EXTFILE(String Name of schema schemaName, String Name of table tableName, String Columns to insert insertColumnList, String Indexes of fields to be imported columnIndexes, String File to read fileName, String Column separator columnDelimiter, String Quote character characterDelimiter, String Encoding codeset, short True if the table should be truncated first replace) Import data from a given file into the specified table columns from the specified columns in the file.
public static void	SYSCS_IMPORT_TABLE(String Name of schema schemaName, String Name of table tableName, String File to read fileName, String Column separator columnDelimiter, String Quote character characterDelimiter, String Encoding codeset, short True if the table should be truncated first replace) Import data from a given file to a table.
public static void	SYSCS_IMPORT_TABLE_BULK(String schemaName, String tableName, String fileName, String columnDelimiter, String characterDelimiter, String codeset, short replace, short skip)
public static void	SYSCS_IMPORT_TABLE_LOBS_FROM_EXTFILE(String Name of schema schemaName, String Name of table tableName, String File to read fileName, String Column separator columnDelimiter, String Quote character characterDelimiter, String Encoding codeset, short True if the table should be truncated first replace) Import data from a given file to a table.
public static void	SYSCS_INPLACE_COMPRESS_TABLE(String Schema name schema, String Unqualifed name of table tablename, short Whether to purge rows purgeRows, short Whether to defragment rows defragmentRows, short Whether to truncate truncateEnd) Implementation of SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE().
public static void	SYSCS_INVALIDATE_STORED_STATEMENTS() Invalidate all the stored statements so they will get recompiled when executed next time around.
public static void	SYSCS_MODIFY_PASSWORD(String The corresponding password password) Change a user's password.
public static Long	Returns: the current value of the identity generator SYSCS_PEEK_AT_IDENTITY(String The name of the schema holding the table. schemaName, String The name of the table in that schema. tableName) Peek at the current value of an identity generator without advancing it.
public static Long	Returns: the current value of the sequence generator SYSCS_PEEK_AT_SEQUENCE(String The name of the schema holding the sequence. schemaName, String The name of the sequence in that schema. sequenceName) Peek at the current value of a sequence generator without advancing it.
public static void	SYSCS_RELOAD_SECURITY_POLICY() Reload the policy file.
public static void	SYSCS_RESET_PASSWORD(String The user's name userName, String The corresponding password password) Reset a user's password.
public static void	SYSCS_SET_DATABASE_PROPERTY(String The property key. key, String The new value, if null the property is deleted. value) Set/delete the value of a property of the database in current connection.
public static void	SYSCS_SET_RUNTIMESTATISTICS(short enable)
public static void	SYSCS_SET_STATISTICS_TIMING(short enable)
public static void	SYSCS_SET_USER_ACCESS(String name of the user in its normal form (not a SQL identifier). userName, String Permission to set for user connectionPermission) Set the connection level authorization for a specific user - SYSCS_UTIL.SYSCS_SET_USER_ACCESS.
public static void	SYSCS_SET_XPLAIN_MODE(int either 0 for explain only, or 1 for explain and execute (default) mode) this procedure switches between the different xplain modes
public static void	SYSCS_SET_XPLAIN_SCHEMA(String May be an empty string. schemaName) This procedure sets the current xplain schema.
public static void	SYSCS_UNFREEZE_DATABASE() Unfreeze the database.
public static void	SYSCS_UPDATE_STATISTICS(String schema name of the table/index(es) whose statistics will be updated. null will mean use the current schema to resolve the table name. Empty string for schema name will raise an exception. schemaname, String table name of the index(es) whose statistics will be updated. A null value or an empty string will throw table not found exception. Must be non-null. tablename, String If null, then update the statistics for all the indexes for the given table name. If not null and not empty string, then the user wants to update the statistics for only the give index name. Empty string for index name will raise an exception. indexname) Update the statistics for 1)all the indexes or 2)a specific index on a table.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public Class SystemProcedures

Field Summary

Constructor Summary

Method Summary