Package com.yahoo.vespa.model.search

Class IndexedSearchCluster

java.lang.Object

com.yahoo.config.model.producer.AbstractConfigProducer<SearchCluster>

com.yahoo.vespa.model.search.SearchCluster

com.yahoo.vespa.model.search.IndexedSearchCluster

All Implemented Interfaces:

com.yahoo.config.ConfigInstance.Producer, com.yahoo.prelude.fastsearch.DocumentdbInfoConfig.Producer, com.yahoo.search.config.IndexInfoConfig.Producer, com.yahoo.search.config.SchemaInfoConfig.Producer, com.yahoo.vespa.config.search.DispatchConfig.Producer, com.yahoo.vespa.config.search.DispatchNodesConfig.Producer, com.yahoo.vespa.configdefinition.IlscriptsConfig.Producer, ConfigProducer, Serializable

public class IndexedSearchCluster
extends SearchCluster
implements com.yahoo.prelude.fastsearch.DocumentdbInfoConfig.Producer, com.yahoo.search.config.IndexInfoConfig.Producer, com.yahoo.search.config.SchemaInfoConfig.Producer, com.yahoo.vespa.configdefinition.IlscriptsConfig.Producer, com.yahoo.vespa.config.search.DispatchConfig.Producer, com.yahoo.vespa.config.search.DispatchNodesConfig.Producer, com.yahoo.config.ConfigInstance.Producer

Author:

baldersheim

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IndexedSearchCluster.MultipleDocumentDatabasesConfigProducer	Class used to retrieve combined configuration from multiple document databases.

Nested classes/interfaces inherited from class com.yahoo.vespa.model.search.SearchCluster

SearchCluster.IndexingMode

Field Summary

Fields inherited from class com.yahoo.config.model.producer.AbstractConfigProducer

log

Constructor Summary

Constructors

Constructor	Description
IndexedSearchCluster(AbstractConfigProducer<SearchCluster> parent, String clusterName, int index, com.yahoo.config.model.api.ModelContext.FeatureFlags featureFlags)

Method Summary

Modifier and Type	Method	Description
void	addSearcher(SearchNode searcher)
void	defaultDocumentsConfig()	Create default config if not specified by user.
void	deriveFromSchemas(DeployState deployState)	Must be called after cluster is built, to derive schema configs.
void	fillDocumentDBConfig(String documentType, com.yahoo.vespa.config.search.core.ProtonConfig.Documentdb.Builder builder)
void	getConfig(com.yahoo.prelude.fastsearch.DocumentdbInfoConfig.Builder builder)
void	getConfig(com.yahoo.search.config.IndexInfoConfig.Builder builder)
void	getConfig(com.yahoo.search.config.SchemaInfoConfig.Builder builder)
void	getConfig(com.yahoo.vespa.config.search.AttributesConfig.Builder builder)
void	getConfig(com.yahoo.vespa.config.search.DispatchConfig.Builder builder)
void	getConfig(com.yahoo.vespa.config.search.DispatchNodesConfig.Builder builder)
void	getConfig(com.yahoo.vespa.config.search.RankProfilesConfig.Builder builder)
void	getConfig(com.yahoo.vespa.configdefinition.IlscriptsConfig.Builder builder)
DispatchSpec	getDispatchSpec()
List<DocumentDatabase>	getDocumentDbs()
String	getIndexingChainName()
String	getIndexingClusterName()	Returns the name of the docproc cluster running indexing for this search cluster.
protected SearchCluster.IndexingMode	getIndexingMode()
String	getIndexingServiceName()
int	getRedundancy()
DispatchGroup	getRootDispatch()
String	getRoutingSelector()	Returns the document selector that is able to resolve what documents are to be routed to this search cluster.
int	getRowBits()
int	getSearchableCopies()
SearchNode	getSearchNode(int index)
int	getSearchNodeCount()
List<SearchNode>	getSearchNodes()
Tuning	getTuning()
boolean	hasDocumentDB(String name)
final boolean	hasExplicitIndexingChain()
final boolean	hasExplicitIndexingCluster()
void	setDispatchSpec(DispatchSpec dispatchSpec)
SearchCluster	setIndexingChain(DocprocChain chain)	Sets the docproc chain that will be running indexing for this search cluster.
void	setIndexingChainName(String indexingChainName)
void	setIndexingClusterName(String name)	Sets the name of the docproc cluster running indexing for this search cluster.
void	setRedundancy(int redundancy)
void	setRoutingSelector(String selector)
void	setSearchableCopies(int searchableCopies)
void	setSearchCoverage(SearchCoverage searchCoverage)
void	setTuning(Tuning tuning)
String	toString()

Methods inherited from class com.yahoo.vespa.model.search.SearchCluster

add, getClusterIndex, getClusterName, getDocumentNames, getIndexingModeName, getQueryTimeout, getVisibilityDelay, isStreaming, schemas, setClusterIndex, setQueryTimeout, setVisibilityDelay

Methods inherited from class com.yahoo.config.model.producer.AbstractConfigProducer

addChild, addConfigId, addDescendantService, addUserConfig, cascadeConfig, dump, getChildren, getChildrenByTypeRecursive, getConfigClassLoader, getConfigId, getDescendantServices, getMonitoringService, getParent, getRoot, getSubId, getUserConfigs, hostSystem, mergeUserConfigs, remove, removeChild, setParent, setUserConfigs, stateIsHosted, validate

Methods inherited from class java.lang.Object

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

Constructor Details

IndexedSearchCluster

public IndexedSearchCluster(AbstractConfigProducer<SearchCluster> parent,
 String clusterName,
 int index,
 com.yahoo.config.model.api.ModelContext.FeatureFlags featureFlags)

Method Details

getRoutingSelector

public String getRoutingSelector()

Returns the document selector that is able to resolve what documents are to be routed to this search cluster. This string uses the document selector language as defined in the "document" module.

Returns:

the document selector

getIndexingMode

protected SearchCluster.IndexingMode getIndexingMode()

Specified by:

getIndexingMode in class SearchCluster

hasExplicitIndexingCluster

public final boolean hasExplicitIndexingCluster()

hasExplicitIndexingChain

public final boolean hasExplicitIndexingChain()

getIndexingClusterName

public String getIndexingClusterName()

Returns the name of the docproc cluster running indexing for this search cluster. This is derived from the services file on initialization, this can NOT be used at runtime to determine indexing chain. When initialization is done, the getIndexingServiceName() method holds the actual indexing docproc chain object.

Returns:

the name of the docproc cluster associated with this

getIndexingChainName

public String getIndexingChainName()

setIndexingChainName

public void setIndexingChainName(String indexingChainName)

setIndexingClusterName

public void setIndexingClusterName(String name)

Sets the name of the docproc cluster running indexing for this search cluster. This is for initial configuration, and will not reflect the actual indexing chain. See getIndexingClusterName() for more detail.

Parameters:

name - the name of the docproc cluster associated with this

getIndexingServiceName

public String getIndexingServiceName()

setIndexingChain

public SearchCluster setIndexingChain(DocprocChain chain)

Sets the docproc chain that will be running indexing for this search cluster. This is set by the Content model during build.

Parameters:

chain - the chain that is to run indexing for this cluster

Returns:

this, to allow chaining

getRootDispatch

public DispatchGroup getRootDispatch()

addSearcher

public void addSearcher(SearchNode searcher)

getSearchNodes

public List<SearchNode> getSearchNodes()

getSearchNodeCount

public int getSearchNodeCount()

getSearchNode

public SearchNode getSearchNode(int index)

setTuning

public void setTuning(Tuning tuning)

getTuning

public Tuning getTuning()

fillDocumentDBConfig

public void fillDocumentDBConfig(String documentType,
 com.yahoo.vespa.config.search.core.ProtonConfig.Documentdb.Builder builder)

setRoutingSelector

public void setRoutingSelector(String selector)

defaultDocumentsConfig

public void defaultDocumentsConfig()

Create default config if not specified by user. Accept empty strings as user config - it means that all feeds/documents are accepted.

Specified by:

defaultDocumentsConfig in class SearchCluster

deriveFromSchemas

public void deriveFromSchemas(DeployState deployState)

Description copied from class: SearchCluster

Must be called after cluster is built, to derive schema configs. Derives the schemas from the application package. Also stores the document names contained in the schemas.

Specified by:

deriveFromSchemas in class SearchCluster

getDocumentDbs

public List<DocumentDatabase> getDocumentDbs()

hasDocumentDB

public boolean hasDocumentDB(String name)

setSearchCoverage

public void setSearchCoverage(SearchCoverage searchCoverage)

getConfig

public void getConfig(com.yahoo.prelude.fastsearch.DocumentdbInfoConfig.Builder builder)

Specified by:

getConfig in interface com.yahoo.prelude.fastsearch.DocumentdbInfoConfig.Producer

getConfig

public void getConfig(com.yahoo.search.config.IndexInfoConfig.Builder builder)

Specified by:

getConfig in interface com.yahoo.search.config.IndexInfoConfig.Producer

getConfig

public void getConfig(com.yahoo.search.config.SchemaInfoConfig.Builder builder)

Specified by:

getConfig in interface com.yahoo.search.config.SchemaInfoConfig.Producer

getConfig

public void getConfig(com.yahoo.vespa.configdefinition.IlscriptsConfig.Builder builder)

Specified by:

getConfig in interface com.yahoo.vespa.configdefinition.IlscriptsConfig.Producer

getConfig

public void getConfig(com.yahoo.vespa.config.search.AttributesConfig.Builder builder)

Specified by:

getConfig in class SearchCluster

getConfig

public void getConfig(com.yahoo.vespa.config.search.RankProfilesConfig.Builder builder)

Specified by:

getConfig in class SearchCluster

getSearchableCopies

public int getSearchableCopies()

setSearchableCopies

public void setSearchableCopies(int searchableCopies)

getRedundancy

public int getRedundancy()

setRedundancy

public void setRedundancy(int redundancy)

setDispatchSpec

public void setDispatchSpec(DispatchSpec dispatchSpec)

getDispatchSpec

public DispatchSpec getDispatchSpec()

getConfig

public void getConfig(com.yahoo.vespa.config.search.DispatchNodesConfig.Builder builder)

Specified by:

getConfig in interface com.yahoo.vespa.config.search.DispatchNodesConfig.Producer

getConfig

public void getConfig(com.yahoo.vespa.config.search.DispatchConfig.Builder builder)

Specified by:

getConfig in interface com.yahoo.vespa.config.search.DispatchConfig.Producer

getRowBits

public int getRowBits()

Specified by:

getRowBits in class SearchCluster

toString

public String toString()

Overrides:

toString in class SearchCluster