Class CloudSolrClient
- java.lang.Object
-
- org.apache.solr.client.solrj.SolrClient
-
- org.apache.solr.client.solrj.impl.CloudSolrClient
-
- All Implemented Interfaces:
Closeable
,Serializable
,AutoCloseable
public class CloudSolrClient extends SolrClient
SolrJ client class to communicate with SolrCloud. Instances of this class communicate with Zookeeper to discover Solr endpoints for SolrCloud collections, and then use theLBHttpSolrClient
to issue requests. This class assumes the id field for your documents is called 'id' - if this is not the case, you must set the right name withsetIdField(String)
.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CloudSolrClient.Builder
ConstructsCloudSolrClient
instances from provided configuration.static class
CloudSolrClient.RouteException
static class
CloudSolrClient.RouteResponse
-
Field Summary
Fields Modifier and Type Field Description protected org.apache.solr.client.solrj.impl.CloudSolrClient.StateCache
collectionStateCache
static String
STATE_VERSION
-
Constructor Summary
Constructors Modifier Constructor Description protected
CloudSolrClient(CloudSolrClient.Builder builder)
Create a new client object that connects to Zookeeper and is always aware of the SolrCloud state.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
close()
CloudSolrClient.RouteResponse
condenseResponse(NamedList response, int timeMillis)
void
connect()
Connect to the zookeeper ensemble.void
connect(long duration, TimeUnit timeUnit)
Connect to a cluster.ClusterStateProvider
getClusterStateProvider()
String
getDefaultCollection()
Gets the default collection for requestprotected DocCollection
getDocCollection(String collection, Integer expectedVersion)
org.apache.http.client.HttpClient
getHttpClient()
String
getIdField()
LBHttpSolrClient
getLbClient()
int
getMinAchievedReplicationFactor(String collection, NamedList resp)
Useful for determining the minimum achieved replication factor across all shards involved in processing an update request, typically useful for gauging the replication factor of a batch.ResponseParser
getParser()
RequestWriter
getRequestWriter()
Map<String,Integer>
getShardReplicationFactor(String collection, NamedList resp)
Walks the NamedList response after performing an update request looking for the replication factor that was achieved in each shard involved in the request.String
getZkHost()
ZkStateReader
getZkStateReader()
boolean
isDirectUpdatesToLeadersOnly()
boolean
isParallelUpdates()
Gets whether direct updates are sent in parallelboolean
isUpdatesToLeaders()
void
registerCollectionStateWatcher(String collection, CollectionStateWatcher watcher)
Register a CollectionStateWatcher to be called when the cluster state for a collection changes Note that the watcher is unregistered after it has been called once.NamedList<Object>
request(SolrRequest request, String collection)
Execute a request against a Solr server for a given collectionprotected NamedList<Object>
requestWithRetryOnStaleState(SolrRequest request, int retryCount, List<String> inputCollections)
As this class doesn't watch external collections on the client side, there's a chance that the request will fail due to cached stale state, which means the state must be refreshed from ZK and retried.protected NamedList<Object>
sendRequest(SolrRequest request, List<String> inputCollections)
void
setCollectionCacheTTl(int seconds)
Sets the cache ttl for DocCollection Objects cached .void
setConnectionTimeout(int timeout)
Deprecated.since 7.0 UseCloudSolrClient.Builder
methods instead.void
setDefaultCollection(String collection)
Sets the default collection for requestvoid
setIdField(String idField)
void
setParallelCacheRefreshes(int n)
If caches are expired they are refreshed after acquiring a lock.void
setParallelUpdates(boolean parallelUpdates)
Deprecated.since 7.2 UseCloudSolrClient.Builder
methods instead.void
setParser(ResponseParser processor)
Note: This setter method is not thread-safe.void
setRequestWriter(RequestWriter requestWriter)
void
setRetryExpiryTime(int secs)
This is the time to wait to refetch the state after getting the same state version from ZKvoid
setSoTimeout(int timeout)
Deprecated.since 7.0 UseCloudSolrClient.Builder
methods instead.void
setZkClientTimeout(int zkClientTimeout)
Set the timeout to the zookeeper ensemble in msvoid
setZkConnectTimeout(int zkConnectTimeout)
Set the connect timeout to the zookeeper ensemble in msvoid
waitForState(String collection, long wait, TimeUnit unit, CollectionStatePredicate predicate)
Block until a collection state matches a predicate, or a timeout Note that the predicate may be called again even after it has returned true, so implementors should avoid changing state within the predicate call itself.-
Methods inherited from class org.apache.solr.client.solrj.SolrClient
add, add, add, add, add, add, add, add, add, add, addBean, addBean, addBean, addBean, addBeans, addBeans, addBeans, addBeans, addBeans, addBeans, commit, commit, commit, commit, commit, commit, deleteById, deleteById, deleteById, deleteById, deleteById, deleteById, deleteById, deleteById, deleteByQuery, deleteByQuery, deleteByQuery, deleteByQuery, getBinder, getById, getById, getById, getById, getById, getById, getById, getById, optimize, optimize, optimize, optimize, optimize, optimize, ping, query, query, query, query, queryAndStreamResponse, queryAndStreamResponse, request, rollback, rollback
-
-
-
-
Field Detail
-
STATE_VERSION
public static final String STATE_VERSION
- See Also:
- Constant Field Values
-
collectionStateCache
protected final org.apache.solr.client.solrj.impl.CloudSolrClient.StateCache collectionStateCache
-
-
Constructor Detail
-
CloudSolrClient
protected CloudSolrClient(CloudSolrClient.Builder builder)
Create a new client object that connects to Zookeeper and is always aware of the SolrCloud state. If there is a fully redundant Zookeeper quorum and SolrCloud has enough replicas for every shard in a collection, there is no single point of failure. Updates will be sent to shard leaders by default.- Parameters:
builder
- aCloudSolrClient.Builder
with the options used to create the client.
-
-
Method Detail
-
setRetryExpiryTime
public void setRetryExpiryTime(int secs)
This is the time to wait to refetch the state after getting the same state version from ZKsecs
-
setSoTimeout
@Deprecated public void setSoTimeout(int timeout)
Deprecated.since 7.0 UseCloudSolrClient.Builder
methods instead.
-
setCollectionCacheTTl
public void setCollectionCacheTTl(int seconds)
Sets the cache ttl for DocCollection Objects cached . This is only applicable for collections which are persisted outside of clusterstate.json- Parameters:
seconds
- ttl value in seconds
-
getParser
public ResponseParser getParser()
-
setParser
public void setParser(ResponseParser processor)
Note: This setter method is not thread-safe.- Parameters:
processor
- Default Response Parser chosen to parse the response if the parser were not specified as part of the request.- See Also:
SolrRequest.getResponseParser()
-
getRequestWriter
public RequestWriter getRequestWriter()
-
setRequestWriter
public void setRequestWriter(RequestWriter requestWriter)
-
getZkHost
public String getZkHost()
- Returns:
- the zkHost value used to connect to zookeeper.
-
getZkStateReader
public ZkStateReader getZkStateReader()
-
setIdField
public void setIdField(String idField)
- Parameters:
idField
- the field to route documents on.
-
getIdField
public String getIdField()
- Returns:
- the field that updates are routed on.
-
setDefaultCollection
public void setDefaultCollection(String collection)
Sets the default collection for request
-
getDefaultCollection
public String getDefaultCollection()
Gets the default collection for request
-
setZkConnectTimeout
public void setZkConnectTimeout(int zkConnectTimeout)
Set the connect timeout to the zookeeper ensemble in ms
-
setZkClientTimeout
public void setZkClientTimeout(int zkClientTimeout)
Set the timeout to the zookeeper ensemble in ms
-
isParallelUpdates
public boolean isParallelUpdates()
Gets whether direct updates are sent in parallel
-
setParallelUpdates
@Deprecated public void setParallelUpdates(boolean parallelUpdates)
Deprecated.since 7.2 UseCloudSolrClient.Builder
methods instead.
-
connect
public void connect()
Connect to the zookeeper ensemble. This is an optional method that may be used to force a connect before any other requests are sent.
-
connect
public void connect(long duration, TimeUnit timeUnit) throws TimeoutException, InterruptedException
Connect to a cluster. If the cluster is not ready, retry connection up to a given timeout.- Parameters:
duration
- the timeouttimeUnit
- the units of the timeout- Throws:
TimeoutException
- if the cluster is not ready after the timeoutInterruptedException
- if the wait is interrupted
-
waitForState
public void waitForState(String collection, long wait, TimeUnit unit, CollectionStatePredicate predicate) throws InterruptedException, TimeoutException
Block until a collection state matches a predicate, or a timeout Note that the predicate may be called again even after it has returned true, so implementors should avoid changing state within the predicate call itself.- Parameters:
collection
- the collection to watchwait
- how long to waitunit
- the units of the wait parameterpredicate
- aCollectionStatePredicate
to check the collection state- Throws:
InterruptedException
- on interruptTimeoutException
- on timeout
-
registerCollectionStateWatcher
public void registerCollectionStateWatcher(String collection, CollectionStateWatcher watcher)
Register a CollectionStateWatcher to be called when the cluster state for a collection changes Note that the watcher is unregistered after it has been called once. To make a watcher persistent, it should re-register itself in itsCollectionStateWatcher.onStateChanged(Set, DocCollection)
call- Parameters:
collection
- the collection to watchwatcher
- a watcher that will be called when the state changes
-
condenseResponse
public CloudSolrClient.RouteResponse condenseResponse(NamedList response, int timeMillis)
-
request
public NamedList<Object> request(SolrRequest request, String collection) throws SolrServerException, IOException
Description copied from class:SolrClient
Execute a request against a Solr server for a given collection- Specified by:
request
in classSolrClient
- Parameters:
request
- the request to executecollection
- the collection to execute the request against- Returns:
- a
NamedList
containing the response from the server - Throws:
SolrServerException
- if there is an error on the serverIOException
- If there is a low-level I/O error.
-
requestWithRetryOnStaleState
protected NamedList<Object> requestWithRetryOnStaleState(SolrRequest request, int retryCount, List<String> inputCollections) throws SolrServerException, IOException
As this class doesn't watch external collections on the client side, there's a chance that the request will fail due to cached stale state, which means the state must be refreshed from ZK and retried.- Throws:
SolrServerException
IOException
-
sendRequest
protected NamedList<Object> sendRequest(SolrRequest request, List<String> inputCollections) throws SolrServerException, IOException
- Throws:
SolrServerException
IOException
-
close
public void close() throws IOException
- Throws:
IOException
-
getLbClient
public LBHttpSolrClient getLbClient()
-
getHttpClient
public org.apache.http.client.HttpClient getHttpClient()
-
isUpdatesToLeaders
public boolean isUpdatesToLeaders()
-
isDirectUpdatesToLeadersOnly
public boolean isDirectUpdatesToLeadersOnly()
- Returns:
- true if direct updates are sent to shard leaders only
-
setParallelCacheRefreshes
public void setParallelCacheRefreshes(int n)
If caches are expired they are refreshed after acquiring a lock. use this to set the number of locks
-
getDocCollection
protected DocCollection getDocCollection(String collection, Integer expectedVersion) throws SolrException
- Throws:
SolrException
-
getMinAchievedReplicationFactor
public int getMinAchievedReplicationFactor(String collection, NamedList resp)
Useful for determining the minimum achieved replication factor across all shards involved in processing an update request, typically useful for gauging the replication factor of a batch.
-
getShardReplicationFactor
public Map<String,Integer> getShardReplicationFactor(String collection, NamedList resp)
Walks the NamedList response after performing an update request looking for the replication factor that was achieved in each shard involved in the request. For single doc updates, there will be only one shard in the return value.
-
setConnectionTimeout
@Deprecated public void setConnectionTimeout(int timeout)
Deprecated.since 7.0 UseCloudSolrClient.Builder
methods instead.
-
getClusterStateProvider
public ClusterStateProvider getClusterStateProvider()
-
-