Top Description Fields Methods
org.apache.derby.iapi.sql.depend

public Interface DependencyManager

Known Direct Implementers
org.apache.derby.impl.sql.depend.BasicDependencyManager
Imports
org.apache.derby.iapi.services.context.ContextManager, org.apache.derby.shared.common.error.StandardException, org.apache.derby.iapi.sql.conn.LanguageConnectionContext, org.apache.derby.iapi.store.access.TransactionController

Dependency Manager Interface

The dependency manager tracks needs that dependents have of providers. This is a general purpose interface which is associated with a DataDictinary object; infact the dependencymanager is really the datadictionary keeping track of dependencies between objects that it handles (descriptors) as well as prepared statements.

The primary example of this is a prepared statement's needs of schema objects such as tables.

Dependencies are used so that we can determine when we need to recompile a statement; compiled statements depend on schema objects like tables and constraints, and may no longer be executable when those tables or constraints are altered. For example, consider an insert statement.

An insert statement is likely to have dependencies on the table it inserts into, any tables it selects from (including subqueries), the authorities it uses to do this, and any constraints or triggers it needs to check.

A prepared insert statement has a dependency on the target table of the insert. When it is compiled, that dependency is registered from the prepared statement on the data dictionary entry for the table. This dependency is added to the prepared statement's dependency list, which is also accessible from an overall dependency pool.

A DDL statement will mark invalid any prepared statement that depends on the schema object the DDL statement is altering or dropping. We tend to want to track at the table level rather than the column or constraint level, so that we are not overburdened with dependencies. This does mean that we may invalidate when in fact we do not need to; for example, adding a column to a table may not actually cause an insert statement compiled for that table to stop working; but our level of granularity may force us to invalidate the insert because it has to invalidate all statements that depend on the table due to some of them actually no longer being valid. It is up to the user of the dependency system at what granularity to track dependencies, where to hang them, and how to identify when objects become invalid. The dependency system is basically supplying the ability to find out who is interested in knowing about other, distinct operations. The primary user is the language system, and its primary use is for invalidating prepared statements when DDL occurs.

The insert will recompile itself when its next execution is requested (not when it is invalidated). We don't want it to recompile when the DDL is issued, as that would increase the time of execution of the DDL command unacceptably. Note that the DDL command is also allowed to proceed even if it would make the statement no longer compilable. It can be useful to have a way to recompile invalid statements during idle time in the system, but our first implementation will simply recompile at the next execution.

The start of a recompile will release the connection to all dependencies when it releases the activation class and generates a new one.

The Dependency Manager is capable of storing dependencies to ensure that other D.M.s can see them and invalidate them appropriately. The dependencies in memory only the current D.M. can see; the stored dependencies are visible to other D.M.s once the transaction in which they were stored is committed.

Revisit

Given that statements are compiled in a separate top-transaction from their execution, we may need/want some intermediate memory storage that makes the dependencies visible to all D.M.s in the system, without requiring that they be stored.

To ensure that dependencies are cleaned up when a statement is undone, the compiler context needs to keep track of what dependent it was creating dependencies for, and if it is informed of a statement exception that causes it to throw out the statement it was compiling, it should also call the dependency manager to have the dependencies removed.

Several expansions of the basic interface may be desirable:

To provide a simple interface that satisfies the basic need, and yet supply more advanced functionality as well, we will present the simple functionality as defaults and provide ways to specify the more advanced functionality.

interface Dependent {
	boolean isValid();
	InvalidType getInvalidType(); // returns what it sees
					// as the "most important"
					// of its invalid types.
	void makeInvalid( );
	void makeInvalid( DependencyType dt, InvalidType it );
	void makeValid();
}

interface Provider() {
}

interface Dependency() {
	Provider getProvider();
	Dependent getDependent();
	DependencyType getDependencyType();
	boolean isValid();
	InvalidType getInvalidType(); // returns what it sees
					// as the "most important"
					// of its invalid types.
}

interface DependencyManager() {
	void addDependency(Dependent d, Provider p, ContextManager cm);
	void invalidateFor(Provider p);
	void invalidateFor(Provider p, DependencyType dt, InvalidType it);
	void clearDependencies(Dependent d);
	void clearDependencies(Dependent d, DependencyType dt);
	Enumeration getProviders (Dependent d);
	Enumeration getProviders (Dependent d, DependencyType dt);
	Enumeration getInvalidDependencies (Dependent d, 
		DependencyType dt, InvalidType it);
	Enumeration getDependents (Provider p);
	Enumeration getDependents (Provider p, DependencyType dt);
	Enumeration getInvalidDependencies (Provider p, 
		DependencyType dt, InvalidType it);
}

The simplest things for DependencyType and InvalidType to be are integer id's or strings, rather than complex objects.

In terms of ensuring that no makeInvalid calls are made until we have identified all objects that could be, so that the calls will be made from "leaf" invalid objects (those not in turn relied on by other dependents) to dependent objects upon which others depend, the dependency manager will need to maintain an internal queue of dependencies and make the calls once it has completes its analysis of the dependencies of which it is aware. Since it is much simpler and potentially faster for makeInvalid calls to be made as soon as the dependents are identified, separate implementations may be called for, or separate interfaces to trigger the different styles of invalidation.

In terms of separate interfaces, the DependencyManager might have two methods,

	void makeInvalidImmediate();
	void makeInvalidOrdered();
or a flag on the makeInvalid method to choose the style to use.

In terms of separate implementations, the ImmediateInvalidate manager might have simpler internal structures for tracking dependencies than the OrderedInvalidate manager.

The language system doesn't tend to suffer from this ordering problem, as it tends to handle the impact of invalidation by simply deferring recompilation until the next execution. So, a prepared statement might be invalidated several times by a transaction that contains several DDL operations, and only recompiled once, at its next execution. This is sufficient for the common use of a system, where DDL changes tend to be infrequent and clustered.

There could be ways to push this "ordering problem" out of the dependency system, but since it knows when it starts and when it finished finding all of the invalidating actions, it is likely the best home for this.

One other problem that could arise is multiple invalidations occurring one after another. The above design of the dependency system can really only react to each invalidation request as a unit, not to multiple invalidation requests.

Another extension that might be desired is for the dependency manager to provide for cascading invalidations -- that is, if it finds and marks one Dependent object as invalid, if that object can also be a provider, to look for its dependent objects and cascade the dependency on to them. This can be a way to address the multiple-invalidation request need, if it should arise. The simplest way to do this is to always cascade the same invalidation type; otherwise, dependents need to be able to say what a certain type of invalidation type gets changed to when it is handed on.

The basic language system does not need support for cascaded dependencies -- statements do not depend on other statements in a way that involves the dependency system.

I do not know if it would be worthwhile to consider using the dependency manager to aid in the implementation of the SQL DROP statements or not. Past implementations of database systems have not used the dependency system to implement this functionality, but have instead hard-coded the lookups like so:

	in DropTable:
		scan the TableAuthority table looking for authorities on
	this table; drop any that are found.
		scan the ColumnAuthority table looking for authorities on
	this table; drop any that are found.
		scan the View table looking for views on
	this table; drop any that are found.
		scan the Column table looking for rows for columns of
	this table; drop any that are found.
		scan the Constraint table looking for rows for constraints of
	this table; drop any that are found.
		scan the Index table looking for rows for indexes of
	this table; drop the indexes, and any rows that are found.
	drop the table's conglomerate
	drop the table's row in the Table table.
	

The direct approach such as that outlined in the example will probably be quicker and is definitely "known technology" over the use of a dependency system in this area.

Field Summary

Modifier and TypeField and Description
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
MAX_ACTION_CODE

Extensions to this interface may use action codes > MAX_ACTION_CODE without fear of clashing with action codes in this base interface.

public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int
public static final int

Method Summary

Modifier and TypeMethod and Description
public void
addDependency(Dependent
the dependent
d
,
Provider
the provider
p
,
ContextManager
Current ContextManager
cm
)

adds a dependency from the dependent on the provider.

public void
clearColumnInfoInProviders(ProviderList pl)

Clear the in memory column bit map information in any table descriptor provider in a provider list.

public void
clearDependencies(LanguageConnectionContext
Compiler state
lcc
,
Dependent
the dependent
d
)

Erases all of the dependencies the dependent has, be they valid or invalid, of any dependency type.

public void
clearDependencies(LanguageConnectionContext
Compiler state
lcc
,
Dependent
the dependent
d
,
TransactionController
transaction controller
tc
)

Erases all of the dependencies the dependent has, be they valid or invalid, of any dependency type.

public void
clearInMemoryDependency(Dependency dy)

Clear the specified in memory dependency.

public void
copyDependencies(Dependent
the dependent to copy from
copy_From
,
Dependent
the dependent to copy to
copyTo
,
boolean
only copy persistent dependencies
persistentOnly
,
ContextManager
Current ContextManager
cm
)

Copy dependencies from one dependent to another.

public void
copyDependencies(Dependent
the dependent to copy from
copy_From
,
Dependent
the dependent to copy to
copyTo
,
boolean
only copy persistent dependencies
persistentOnly
,
ContextManager
Current ContextManager
cm
,
TransactionController
Transaction Controller
tc
)

Copy dependencies from one dependent to another.

public int

Returns:

int The number of active dependencies in the system.
countDependencies
()

Count the number of active dependencies, both stored and in memory, in the system.

public String

Returns:

String The String representation
getActionString
(int
The action
action
)

Returns a string representation of the SQL action, hence no need to internationalize, which is causing the invokation of the Dependency Manager.

public ProviderInfo[]
getPersistentProviderInfos(Dependent dependent)

Get a new array of ProviderInfos representing all the persistent providers for the given dependent.

public ProviderInfo[]
getPersistentProviderInfos(ProviderList pl)

Get a new array of ProviderInfos representing all the persistent providers from the given list of providers.

public void
invalidateFor(Provider
the provider
p
,
int
The action causing the invalidate
action
,
LanguageConnectionContext
The LanguageConnectionContext
lcc
)

mark all dependencies on the named provider as invalid.

Field Detail

ALTER_TABLEback to summary
public static final int ALTER_TABLE
BULK_INSERTback to summary
public static final int BULK_INSERT
CHANGED_CURSORback to summary
public static final int CHANGED_CURSOR
COMPILE_FAILEDback to summary
public static final int COMPILE_FAILED
COMPRESS_TABLEback to summary
public static final int COMPRESS_TABLE
CREATE_CONSTRAINTback to summary
public static final int CREATE_CONSTRAINT
CREATE_INDEXback to summary
public static final int CREATE_INDEX
CREATE_TRIGGERback to summary
public static final int CREATE_TRIGGER
CREATE_VIEWback to summary
public static final int CREATE_VIEW
DROP_AGGREGATEback to summary
public static final int DROP_AGGREGATE
DROP_COLUMNback to summary
public static final int DROP_COLUMN
DROP_COLUMN_RESTRICTback to summary
public static final int DROP_COLUMN_RESTRICT
DROP_CONSTRAINTback to summary
public static final int DROP_CONSTRAINT
DROP_INDEXback to summary
public static final int DROP_INDEX
DROP_JARback to summary
public static final int DROP_JAR
DROP_METHOD_ALIASback to summary
public static final int DROP_METHOD_ALIAS
DROP_SCHEMAback to summary
public static final int DROP_SCHEMA
DROP_SEQUENCEback to summary
public static final int DROP_SEQUENCE
DROP_SPSback to summary
public static final int DROP_SPS
DROP_STATISTICSback to summary
public static final int DROP_STATISTICS
DROP_SYNONYMback to summary
public static final int DROP_SYNONYM
DROP_TABLEback to summary
public static final int DROP_TABLE
DROP_TRIGGERback to summary
public static final int DROP_TRIGGER
DROP_UDTback to summary
public static final int DROP_UDT
DROP_VIEWback to summary
public static final int DROP_VIEW
INTERNAL_RECOMPILE_REQUESTback to summary
public static final int INTERNAL_RECOMPILE_REQUEST
MAX_ACTION_CODEback to summary
public static final int MAX_ACTION_CODE

Extensions to this interface may use action codes > MAX_ACTION_CODE without fear of clashing with action codes in this base interface.

MODIFY_COLUMN_DEFAULTback to summary
public static final int MODIFY_COLUMN_DEFAULT
PREPARED_STATEMENT_RELEASEback to summary
public static final int PREPARED_STATEMENT_RELEASE
RECHECK_PRIVILEGESback to summary
public static final int RECHECK_PRIVILEGES
RENAMEback to summary
public static final int RENAME
RENAME_INDEXback to summary
public static final int RENAME_INDEX
REPLACE_JARback to summary
public static final int REPLACE_JAR
REVOKE_PRIVILEGEback to summary
public static final int REVOKE_PRIVILEGE
REVOKE_PRIVILEGE_RESTRICTback to summary
public static final int REVOKE_PRIVILEGE_RESTRICT
REVOKE_ROLEback to summary
public static final int REVOKE_ROLE
ROLLBACKback to summary
public static final int ROLLBACK
SET_CONSTRAINTS_DISABLEback to summary
public static final int SET_CONSTRAINTS_DISABLE
SET_CONSTRAINTS_ENABLEback to summary
public static final int SET_CONSTRAINTS_ENABLE
SET_TRIGGERS_DISABLEback to summary
public static final int SET_TRIGGERS_DISABLE
SET_TRIGGERS_ENABLEback to summary
public static final int SET_TRIGGERS_ENABLE
TRUNCATE_TABLEback to summary
public static final int TRUNCATE_TABLE
UPDATE_STATISTICSback to summary
public static final int UPDATE_STATISTICS
USER_RECOMPILE_REQUESTback to summary
public static final int USER_RECOMPILE_REQUEST

Method Detail

addDependencyback to summary
public void addDependency(Dependent d, Provider p, ContextManager cm) throws StandardException

adds a dependency from the dependent on the provider. This will be considered to be the default type of dependency, when dependency types show up.

Implementations of addDependency should be fast -- performing alot of extra actions to add a dependency would be a detriment.

Parameters
d:Dependent

the dependent

p:Provider

the provider

cm:ContextManager

Current ContextManager

Exceptions
StandardException:
thrown if something goes wrong
clearColumnInfoInProvidersback to summary
public void clearColumnInfoInProviders(ProviderList pl) throws StandardException

Clear the in memory column bit map information in any table descriptor provider in a provider list. This function needs to be called before the table descriptor is reused as provider in column dependency. For example, this happens in "create publication" statement with target-only DDL where more than one views are defined and they all reference one table.

Exceptions
StandardException:
Thrown on error.
clearDependenciesback to summary
public void clearDependencies(LanguageConnectionContext lcc, Dependent d) throws StandardException

Erases all of the dependencies the dependent has, be they valid or invalid, of any dependency type. This action is usually performed as the first step in revalidating a dependent; it first erases all the old dependencies, then revalidates itself generating a list of new dependencies, and then marks itself valid if all its new dependencies are valid.

There might be a future want to clear all dependencies for a particular provider, e.g. when destroying the provider. However, at present, they are assumed to stick around and it is the responsibility of the dependent to erase them when revalidating against the new version of the provider.

clearDependencies will delete dependencies if they are stored; the delete is finalized at the next commit.

Parameters
lcc:LanguageConnectionContext

Compiler state

d:Dependent

the dependent

Exceptions
StandardException:
Thrown on failure
clearDependenciesback to summary
public void clearDependencies(LanguageConnectionContext lcc, Dependent d, TransactionController tc) throws StandardException

Erases all of the dependencies the dependent has, be they valid or invalid, of any dependency type. This action is usually performed as the first step in revalidating a dependent; it first erases all the old dependencies, then revalidates itself generating a list of new dependencies, and then marks itself valid if all its new dependencies are valid.

There might be a future want to clear all dependencies for a particular provider, e.g. when destroying the provider. However, at present, they are assumed to stick around and it is the responsibility of the dependent to erase them when revalidating against the new version of the provider.

clearDependencies will delete dependencies if they are stored; the delete is finalized at the next commit.

Parameters
lcc:LanguageConnectionContext

Compiler state

d:Dependent

the dependent

tc:TransactionController

transaction controller

Exceptions
StandardException:
Thrown on failure
clearInMemoryDependencyback to summary
public void clearInMemoryDependency(Dependency dy)

Clear the specified in memory dependency. This is useful for clean-up when an exception occurs. (We clear all in-memory dependencies added in the current StatementContext.) This method will handle Dependency's that have already been removed from the DependencyManager.

copyDependenciesback to summary
public void copyDependencies(Dependent copy_From, Dependent copyTo, boolean persistentOnly, ContextManager cm) throws StandardException

Copy dependencies from one dependent to another.

Parameters
copy_From:Dependent

the dependent to copy from

copyTo:Dependent

the dependent to copy to

persistentOnly:boolean

only copy persistent dependencies

cm:ContextManager

Current ContextManager

Exceptions
StandardException:
Thrown on error.
copyDependenciesback to summary
public void copyDependencies(Dependent copy_From, Dependent copyTo, boolean persistentOnly, ContextManager cm, TransactionController tc) throws StandardException

Copy dependencies from one dependent to another.

Parameters
copy_From:Dependent

the dependent to copy from

copyTo:Dependent

the dependent to copy to

persistentOnly:boolean

only copy persistent dependencies

cm:ContextManager

Current ContextManager

tc:TransactionController

Transaction Controller

Exceptions
StandardException:
Thrown on error.
countDependenciesback to summary
public int countDependencies() throws StandardException

Count the number of active dependencies, both stored and in memory, in the system.

Returns:int

int The number of active dependencies in the system.

Exceptions
StandardException:
thrown if something goes wrong
getActionStringback to summary
public String getActionString(int action)

Returns a string representation of the SQL action, hence no need to internationalize, which is causing the invokation of the Dependency Manager.

Parameters
action:int

The action

Returns:String

String The String representation

getPersistentProviderInfosback to summary
public ProviderInfo[] getPersistentProviderInfos(Dependent dependent) throws StandardException

Get a new array of ProviderInfos representing all the persistent providers for the given dependent.

Exceptions
StandardException:
Thrown on error.
getPersistentProviderInfosback to summary
public ProviderInfo[] getPersistentProviderInfos(ProviderList pl) throws StandardException

Get a new array of ProviderInfos representing all the persistent providers from the given list of providers.

Exceptions
StandardException:
Thrown on error.
invalidateForback to summary
public void invalidateFor(Provider p, int action, LanguageConnectionContext lcc) throws StandardException

mark all dependencies on the named provider as invalid. When invalidation types show up, this will use the default invalidation type. The dependencies will still exist once they are marked invalid; clearDependencies should be used to remove dependencies that a dependent has or provider gives.

Implementations of this can take a little time, but are not really expected to recompile things against any changes made to the provider that caused the invalidation. The dependency system makes no guarantees about the state of the provider -- implementations can call this before or after actually changing the provider to its new state.

Implementations should throw DependencyStatementException if the invalidation should be disallowed.

Parameters
p:Provider

the provider

action:int

The action causing the invalidate

lcc:LanguageConnectionContext

The LanguageConnectionContext

Exceptions
StandardException:
thrown if unable to make it invalid