org.apache.solr.cloud.api.collections

Class TimeRoutedAlias

java.lang.Object

org.apache.solr.cloud.api.collections.RoutedAlias

org.apache.solr.cloud.api.collections.TimeRoutedAlias

public class TimeRoutedAlias
extends RoutedAlias

Holds configuration for a routed alias, and some common code and constants.

See Also:

CreateAliasCmd, MaintainRoutedAliasCmd, RoutedAliasUpdateProcessor

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.cloud.api.collections.RoutedAlias

RoutedAlias.Action

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	OPTIONAL_ROUTER_PARAMS Optional parameters for creating a routed alias excluding parameters for collection creation.
static Set<String>	REQUIRED_ROUTER_PARAMS Parameters required for creating a routed alias
static String	ROUTER_AUTO_DELETE_AGE
static String	ROUTER_INTERVAL
static String	ROUTER_MAX_FUTURE
static String	ROUTER_PREEMPTIVE_CREATE_MATH
static String	ROUTER_START
static RoutedAliasTypes	TYPE

Fields inherited from class org.apache.solr.cloud.api.collections.RoutedAlias

CREATE_COLLECTION_PREFIX, MINIMAL_REQUIRED_PARAMS, ROUTED_ALIAS_NAME_CORE_PROP, ROUTER_FIELD, ROUTER_TYPE_NAME

Method Summary

Modifier and Type	Method and Description
protected List<RoutedAlias.Action>	calculateActions(String targetCol) Determine the combination of adds/deletes implied by the arrival of a document destined for the specified collection.
String	computeInitialCollectionName() Create the initial collection for this RoutedAlias if applicable.
org.apache.solr.cloud.api.collections.RoutedAlias.CandidateCollection	findCandidateGivenValue(AddUpdateCommand cmd) Given the route key, finds the correct collection and an indication of any collection that needs to be created.
static String	formatCollectionNameFromInstant(String aliasName, Instant timestamp)
Map<String,String>	getAliasMetadata()
String	getAliasName() The name of the alias.
String	getAutoDeleteAgeMath()
protected String	getHeadCollectionIfOrdered(AddUpdateCommand cmd) Calculate the head collection (i.e.
String	getIntervalMath()
long	getMaxFutureMs()
Set<String>	getOptionalParams()
String	getPreemptiveCreateWindow()
Set<String>	getRequiredParams()
RoutedAliasTypes	getRoutedAliasType()
String	getRouteField()
TimeZone	getTimeZone()
static Instant	parseInstantFromCollectionName(String aliasName, String collection)
String	toString()
boolean	updateParsedCollectionAliases(ZkStateReader zkStateReader, boolean contextualize) Ensure our parsed version of the alias collection list is up to date.
void	validateRouteValue(AddUpdateCommand cmd) Check that the value we will be routing on is legal for this type of routed alias.

Methods inherited from class org.apache.solr.cloud.api.collections.RoutedAlias

createCollectionsIfRequired, fromProps, newAliasMustExistException

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final RoutedAliasTypes TYPE

ROUTER_START

public static final String ROUTER_START

See Also:

Constant Field Values

ROUTER_INTERVAL

public static final String ROUTER_INTERVAL

See Also:

Constant Field Values

ROUTER_MAX_FUTURE

public static final String ROUTER_MAX_FUTURE

See Also:

Constant Field Values

ROUTER_AUTO_DELETE_AGE

public static final String ROUTER_AUTO_DELETE_AGE

See Also:

Constant Field Values

ROUTER_PREEMPTIVE_CREATE_MATH

public static final String ROUTER_PREEMPTIVE_CREATE_MATH

See Also:

Constant Field Values

REQUIRED_ROUTER_PARAMS

public static final Set<String> REQUIRED_ROUTER_PARAMS

Parameters required for creating a routed alias

OPTIONAL_ROUTER_PARAMS

public static final Set<String> OPTIONAL_ROUTER_PARAMS

Optional parameters for creating a routed alias excluding parameters for collection creation.

Method Detail

computeInitialCollectionName

public String computeInitialCollectionName()

Description copied from class: RoutedAlias

Create the initial collection for this RoutedAlias if applicable.

Routed Aliases do not aggregate existing collections, instead they create collections on the fly. If the initial collection can be determined from initialization parameters it should be calculated here.

Returns:

optional string of initial collection name

parseInstantFromCollectionName

public static Instant parseInstantFromCollectionName(String aliasName,
                                                     String collection)

formatCollectionNameFromInstant

public static String formatCollectionNameFromInstant(String aliasName,
                                                     Instant timestamp)

updateParsedCollectionAliases

public boolean updateParsedCollectionAliases(ZkStateReader zkStateReader,
                                             boolean contextualize)

Description copied from class: RoutedAlias

Ensure our parsed version of the alias collection list is up to date. If it was modified, return true. Note that this will return true if some other alias was modified or if properties were modified. These are spurious and the caller should be written to be tolerant of no material changes.

Specified by:

updateParsedCollectionAliases in class RoutedAlias

getAliasName

public String getAliasName()

Description copied from class: RoutedAlias

The name of the alias. This name is used in place of a collection name for both queries and updates.

Specified by:

getAliasName in class RoutedAlias

Returns:

The name of the Alias.

getRouteField

public String getRouteField()

getRoutedAliasType

public RoutedAliasTypes getRoutedAliasType()

getIntervalMath

public String getIntervalMath()

getMaxFutureMs

public long getMaxFutureMs()

getPreemptiveCreateWindow

public String getPreemptiveCreateWindow()

getAutoDeleteAgeMath

public String getAutoDeleteAgeMath()

getTimeZone

public TimeZone getTimeZone()

toString

public String toString()

Overrides:

toString in class Object

validateRouteValue

public void validateRouteValue(AddUpdateCommand cmd)
                        throws SolrException

Description copied from class: RoutedAlias

Check that the value we will be routing on is legal for this type of routed alias.

Specified by:

validateRouteValue in class RoutedAlias

Parameters:

cmd - the command containing the document

Throws:

SolrException

getAliasMetadata

public Map<String,String> getAliasMetadata()

Returns:

get alias related metadata

getRequiredParams

public Set<String> getRequiredParams()

Specified by:

getRequiredParams in class RoutedAlias

getOptionalParams

public Set<String> getOptionalParams()

Specified by:

getOptionalParams in class RoutedAlias

getHeadCollectionIfOrdered

protected String getHeadCollectionIfOrdered(AddUpdateCommand cmd)

Description copied from class: RoutedAlias

Calculate the head collection (i.e. the most recent one for a TRA) if this routed alias has an implicit order, or if the collection is unordered return the appropriate collection name for the value in the current document. This method should never return null.

Specified by:

getHeadCollectionIfOrdered in class RoutedAlias

findCandidateGivenValue

public org.apache.solr.cloud.api.collections.RoutedAlias.CandidateCollection findCandidateGivenValue(AddUpdateCommand cmd)

Given the route key, finds the correct collection and an indication of any collection that needs to be created. Future docs will potentially cause creation of a collection that does not yet exist. This method presumes that the doc time stamp has already been checked to not exceed maxFutureMs

Throws:

SolrException - if the doc is too old to be stored in the TRA

calculateActions

protected List<RoutedAlias.Action> calculateActions(String targetCol)

Description copied from class: RoutedAlias

Determine the combination of adds/deletes implied by the arrival of a document destined for the specified collection.

Specified by:

calculateActions in class RoutedAlias

Parameters:

targetCol - the collection for which a document is destined.

Returns:

A list of actions across the DRA.