com.amazon.carbonado.repo.indexed

Class IndexedRepositoryBuilder

java.lang.Object

com.amazon.carbonado.spi.AbstractRepositoryBuilder

com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder

All Implemented Interfaces:

RepositoryBuilder

public class IndexedRepositoryBuilder
extends AbstractRepositoryBuilder

Repository builder for the indexed repository.

In addition to supporting the capabilities of the wrapped repository, the following extra capabilities are supported:

• IndexInfoCapability
• StorableInfoCapability
• IndexEntryAccessCapability

Author:

Brian S O'Neill

Constructor Summary

Constructors

Constructor and Description
IndexedRepositoryBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
Repository	build(java.util.concurrent.atomic.AtomicReference<Repository> rootRef) Builds a repository instance.
void	errorCheck(java.util.Collection<java.lang.String> messages) This method is called by assertReady, and subclasses must override to perform custom checks.
double	getIndexRepairThrottle() Returns the throttle parameter used when indexes are added, dropped or bulk repaired.
java.lang.String	getName() Returns the name of the repository.
RepositoryBuilder	getWrappedRepository()
boolean	isAllClustered() Returns true if all indexes should be identified as clustered.
boolean	isIndexRepairEnabled()
boolean	isMaster() Returns true if repository should assume the role of master, which is true by default.
void	setAllClustered(boolean clustered) When all indexes are identified as clustered, the query analyzer treats all indexes as performing equally well.
void	setIndexRepairDiscardDuplicates(boolean discardDuplicates) Set true to skip collisions during index repair, logging each as a warning.
void	setIndexRepairEnabled(boolean enabled) By default, index repair is enabled.
void	setIndexRepairThrottle(double desiredSpeed) Sets the throttle parameter used when indexes are added, dropped or bulk repaired.
void	setIndexRepairVerifyOnly(boolean verifyOnly) Set true to build and verify indexes, but don't apply any changes.
void	setMaster(boolean b) Set to false if repository should not assume the role of master.
void	setName(java.lang.String name) Set name for the repository, which is required.
void	setStrictTriggers(boolean strict) Set to true to require that index maintenance triggers use a "for update" transaction, avoiding deadlocks and lock upgrade failures.
void	setWrappedRepository(RepositoryBuilder repoBuilder) Set the required wrapped respository, which must support the IndexInfoCapability.

Methods inherited from class com.amazon.carbonado.spi.AbstractRepositoryBuilder

addTriggerFactory, assertReady, build, getTriggerFactories, removeTriggerFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexedRepositoryBuilder

public IndexedRepositoryBuilder()

Method Detail

build

public Repository build(java.util.concurrent.atomic.AtomicReference<Repository> rootRef)
                 throws RepositoryException

Description copied from interface: RepositoryBuilder

Builds a repository instance.

If the repository is being wrapped by a parent repository, the child repository will need to know this fact for some operations to work correctly. Since the parent repository is not built yet, a reference is used instead.

Parameters:

rootRef - reference to root parent repository, to be set by parent repository upon being built

Throws:

ConfigurationException - if there is a problem in the builder's configuration

RepositoryException - if there is a general problem opening the repository

getName

public java.lang.String getName()

Description copied from interface: RepositoryBuilder

Returns the name of the repository.

setName

public void setName(java.lang.String name)

Description copied from interface: RepositoryBuilder

Set name for the repository, which is required.

isMaster

public boolean isMaster()

Description copied from interface: RepositoryBuilder

Returns true if repository should assume the role of master, which is true by default. Repositories that link different repositories together will designate only one as the master.

A master repository is responsible for version and sequence properties. For insert operations, a master repository must set these properties if they are uninitialized. For updates, the version property is checked to see if an OptimisticLockException should be thrown.

See Also:

ReplicatedRepositoryBuilder

setMaster

public void setMaster(boolean b)

Description copied from interface: RepositoryBuilder

Set to false if repository should not assume the role of master. By default, this option is true. Repositories that link different repositories together will designate only one as the master.

A master repository is responsible for version and sequence properties. For insert operations, a master repository must set these properties if they are uninitialized. For updates, the version property is checked to see if an OptimisticLockException should be thrown.

See Also:

ReplicatedRepositoryBuilder

getWrappedRepository

public RepositoryBuilder getWrappedRepository()

Returns:

wrapped respository

setWrappedRepository

public void setWrappedRepository(RepositoryBuilder repoBuilder)

Set the required wrapped respository, which must support the IndexInfoCapability.

isIndexRepairEnabled

public boolean isIndexRepairEnabled()

Returns:

true by default

See Also:

setIndexRepairEnabled(boolean)

setIndexRepairEnabled

public void setIndexRepairEnabled(boolean enabled)

By default, index repair is enabled. In this mode, the first time a Storable type is used, new indexes are populated and old indexes are removed. Until finished, access to the Storable is blocked.

When index repair is disabled, the Storable is immediately available. This does have consequences, however. The set of indexes available for queries is defined by the intersection of the old and new index sets. The set of indexes that are kept up-to-date is defined by the union of the old and new index sets.

While index repair is disabled, another process can safely repair the indexes in the background. When it is complete, index repair can be enabled for this repository too.

getIndexRepairThrottle

public double getIndexRepairThrottle()

Returns the throttle parameter used when indexes are added, dropped or bulk repaired. By default this value is 1.0, or maximum speed.

setIndexRepairThrottle

public void setIndexRepairThrottle(double desiredSpeed)

Sets the throttle parameter used when indexes are added, dropped or bulk repaired. By default this value is 1.0, or maximum speed.

Parameters:

desiredSpeed - 1.0 = perform work at full speed, 0.5 = perform work at half speed, 0.0 = fully suspend work

setIndexRepairDiscardDuplicates

public void setIndexRepairDiscardDuplicates(boolean discardDuplicates)

Set true to skip collisions during index repair, logging each as a warning.

setIndexRepairVerifyOnly

public void setIndexRepairVerifyOnly(boolean verifyOnly)

Set true to build and verify indexes, but don't apply any changes.

isAllClustered

public boolean isAllClustered()

Returns true if all indexes should be identified as clustered. This affects how indexes are selected by the query analyzer.

Since:

1.2

setAllClustered

public void setAllClustered(boolean clustered)

When all indexes are identified as clustered, the query analyzer treats all indexes as performing equally well. This is suitable for indexing repositories that never read from a slow storage medium.

Since:

1.2

setStrictTriggers

public void setStrictTriggers(boolean strict)

Set to true to require that index maintenance triggers use a "for update" transaction, avoiding deadlocks and lock upgrade failures.

errorCheck

public void errorCheck(java.util.Collection<java.lang.String> messages)
                throws ConfigurationException

Description copied from class: AbstractRepositoryBuilder

This method is called by assertReady, and subclasses must override to perform custom checks. Be sure to call super.errorCheck as well.

Overrides:

errorCheck in class AbstractRepositoryBuilder

Parameters:

messages - add any error messages to this list

Throws:

ConfigurationException - if error checking indirectly caused another exception