Uses of Class
org.apache.solr.common.params.SolrParams
Packages that use SolrParams
Package
Description
Primary APIs for communicating with a Solr Server from a Java client.
Concrete implementations of client API classes.
Convenience classes for dealing with various types of Solr requests.
Allows sending of requests using Solr's JSON query/faceting API
Convenience classes for making Schema API requests.
Classes to handle query routing preferences
Common Solr Cloud and ZooKeeper related classes reused on both clients & server.
Parameter constants and enumerations.
Common utility classes reused on both clients & server.
-
Uses of SolrParams in org.apache.solr.client.solrj
Subclasses of SolrParams in org.apache.solr.client.solrjModifier and TypeClassDescriptionclassThis is an augmented SolrParams with get/set/add fields for common fields used in the Standard and Dismax request handlersMethods in org.apache.solr.client.solrj that return SolrParamsMethods in org.apache.solr.client.solrj with parameters of type SolrParamsModifier and TypeMethodDescriptionSolrClient.getById(String collection, String id, SolrParams params) Retrieves the SolrDocument associated with the given identifier and uses the SolrParams to execute the request.SolrClient.getById(String collection, Collection<String> ids, SolrParams params) Retrieves the SolrDocuments associated with the given identifiers and uses the SolrParams to execute the request.SolrClient.getById(String id, SolrParams params) Retrieves the SolrDocument associated with the given identifier and uses the SolrParams to execute the request.SolrClient.getById(Collection<String> ids, SolrParams params) Retrieves the SolrDocuments associated with the given identifiers and uses the SolrParams to execute the request.SolrClient.query(String collection, SolrParams params) Performs a query to the Solr serverSolrClient.query(String collection, SolrParams params, SolrRequest.METHOD method) Performs a query to the Solr serverSolrClient.query(SolrParams params) Performs a query to the Solr serverSolrClient.query(SolrParams params, SolrRequest.METHOD method) Performs a query to the Solr serverSolrClient.queryAndStreamResponse(String collection, SolrParams params, FastStreamingDocsCallback callback) SolrClient.queryAndStreamResponse(String collection, SolrParams params, StreamingResponseCallback callback) Query solr, and stream the results.SolrClient.queryAndStreamResponse(SolrParams params, StreamingResponseCallback callback) Query solr, and stream the results. -
Uses of SolrParams in org.apache.solr.client.solrj.impl
Methods in org.apache.solr.client.solrj.impl with parameters of type SolrParamsModifier and TypeMethodDescriptionstatic org.apache.http.impl.client.CloseableHttpClientHttpClientUtil.createClient(SolrParams params) Deprecated.Creates new http client by using the provided configuration.static org.apache.http.impl.client.CloseableHttpClientHttpClientUtil.createClient(SolrParams params, org.apache.http.impl.conn.PoolingHttpClientConnectionManager cm) Deprecated.static org.apache.http.impl.client.CloseableHttpClientHttpClientUtil.createClient(SolrParams params, org.apache.http.impl.conn.PoolingHttpClientConnectionManager cm, boolean sharedConnectionManager) Deprecated.Creates new http client by using the provided configuration.static org.apache.http.impl.client.CloseableHttpClientHttpClientUtil.createClient(SolrParams params, org.apache.http.impl.conn.PoolingHttpClientConnectionManager cm, boolean sharedConnectionManager, org.apache.http.protocol.HttpRequestExecutor httpRequestExecutor) Deprecated.static voidPreemptiveBasicAuthClientBuilderFactory.setDefaultSolrParams(SolrParams params) This method enables configuring system-wide defaults (apart from using a config file based approach). -
Uses of SolrParams in org.apache.solr.client.solrj.request
Fields in org.apache.solr.client.solrj.request declared as SolrParamsMethods in org.apache.solr.client.solrj.request that return SolrParamsModifier and TypeMethodDescriptionAliasesApi.CreateAlias.getParams()AliasesApi.DeleteAlias.getParams()AliasesApi.GetAliasByName.getParams()AliasesApi.GetAliases.getParams()AliasPropertiesApi.CreateOrUpdateAliasProperty.getParams()AliasPropertiesApi.DeleteAliasProperty.getParams()AliasPropertiesApi.GetAliasProperty.getParams()AliasPropertiesApi.GetAllAliasProperties.getParams()AliasPropertiesApi.UpdateAliasProperties.getParams()ClusterApi.BalanceReplicas.getParams()ClusterApi.MigrateReplicas.getParams()ClusterPropertiesApi.CreateOrUpdateClusterProperty.getParams()ClusterPropertiesApi.CreateOrUpdateNestedClusterProperty.getParams()ClusterPropertiesApi.DeleteClusterProperty.getParams()ClusterPropertiesApi.GetClusterProperty.getParams()ClusterPropertiesApi.ListClusterProperties.getParams()CollectionAdminRequest.AddReplica.getParams()CollectionAdminRequest.AddReplicaProp.getParams()CollectionAdminRequest.AsyncCollectionAdminRequest.getParams()CollectionAdminRequest.AsyncCollectionSpecificAdminRequest.getParams()CollectionAdminRequest.AsyncShardSpecificAdminRequest.getParams()CollectionAdminRequest.Backup.getParams()CollectionAdminRequest.BalanceShardUnique.getParams()CollectionAdminRequest.ClusterProp.getParams()CollectionAdminRequest.ClusterStatus.getParams()CollectionAdminRequest.CollectionAdminRoleRequest.getParams()CollectionAdminRequest.CollectionProp.getParams()CollectionAdminRequest.ColStatus.getParams()CollectionAdminRequest.Create.getParams()CollectionAdminRequest.CreateAlias.getParams()CollectionAdminRequest.CreateCategoryRoutedAlias.getParams()CollectionAdminRequest.CreateShard.getParams()CollectionAdminRequest.CreateSnapshot.getParams()CollectionAdminRequest.CreateTimeRoutedAlias.getParams()CollectionAdminRequest.DeleteAlias.getParams()CollectionAdminRequest.DeleteBackup.getParams()CollectionAdminRequest.DeleteNode.getParams()CollectionAdminRequest.DeleteReplica.getParams()CollectionAdminRequest.DeleteReplicaProp.getParams()CollectionAdminRequest.DeleteShard.getParams()CollectionAdminRequest.DeleteSnapshot.getParams()CollectionAdminRequest.DeleteStatus.getParams()CollectionAdminRequest.DimensionalRoutedAlias.getParams()CollectionAdminRequest.getParams()CollectionAdminRequest.InstallShard.getParams()CollectionAdminRequest.ListBackup.getParams()CollectionAdminRequest.ListSnapshots.getParams()CollectionAdminRequest.Migrate.getParams()CollectionAdminRequest.MockCollTask.getParams()CollectionAdminRequest.Modify.getParams()CollectionAdminRequest.MoveReplica.getParams()CollectionAdminRequest.RebalanceLeaders.getParams()CollectionAdminRequest.ReindexCollection.getParams()CollectionAdminRequest.Rename.getParams()CollectionAdminRequest.ReplaceNode.getParams()CollectionAdminRequest.RequestStatus.getParams()CollectionAdminRequest.Restore.getParams()CollectionAdminRequest.RoutedAliasAdminRequest.getParams()CollectionAdminRequest.SetAliasProperty.getParams()CollectionAdminRequest.ShardSpecificAdminRequest.getParams()CollectionAdminRequest.SplitShard.getParams()CollectionBackupsApi.CreateCollectionBackup.getParams()CollectionBackupsApi.DeleteMultipleBackupsByRecency.getParams()CollectionBackupsApi.DeleteSingleBackupById.getParams()CollectionBackupsApi.GarbageCollectUnusedBackupFiles.getParams()CollectionBackupsApi.ListBackupsAtLocation.getParams()CollectionBackupsApi.RestoreCollection.getParams()CollectionPropertiesApi.CreateOrUpdateCollectionProperty.getParams()CollectionPropertiesApi.DeleteCollectionProperty.getParams()CollectionPropertiesApi.GetCollectionProperty.getParams()CollectionPropertiesApi.ListCollectionProperties.getParams()CollectionsApi.BalanceShardUnique.getParams()CollectionsApi.CreateCollection.getParams()CollectionsApi.DeleteCollection.getParams()CollectionsApi.GetCollectionStatus.getParams()CollectionsApi.ListCollections.getParams()CollectionsApi.ReloadCollection.getParams()CollectionsApi.RenameCollection.getParams()CollectionSnapshotsApi.CreateCollectionSnapshot.getParams()CollectionSnapshotsApi.DeleteCollectionSnapshot.getParams()CollectionSnapshotsApi.ListSnapshots.getParams()ConfigSetAdminRequest.ConfigSetSpecificAdminRequest.getParams()ConfigSetAdminRequest.Create.getParams()ConfigSetAdminRequest.getParams()ConfigSetAdminRequest.Upload.getParams()ConfigsetsApi.CloneExistingConfigSet.getParams()ConfigsetsApi.DeleteConfigSet.getParams()ConfigsetsApi.ListConfigSet.getParams()ConfigsetsApi.UploadConfigSet.getParams()ConfigsetsApi.UploadConfigSetFile.getParams()CoreAdminRequest.Create.getParams()CoreAdminRequest.CreateSnapshot.getParams()CoreAdminRequest.DeleteSnapshot.getParams()CoreAdminRequest.getParams()CoreAdminRequest.MergeIndexes.getParams()CoreAdminRequest.OverrideLastPublished.getParams()CoreAdminRequest.RequestRecovery.getParams()CoreAdminRequest.RequestSyncShard.getParams()CoreAdminRequest.Unload.getParams()CoreAdminRequest.WaitForState.getParams()CoreBackupsApi.CreateBackup.getParams()CoresApi.InstallCoreData.getParams()CoresApi.MergeIndexes.getParams()CoresApi.ReloadCore.getParams()CoresApi.RenameCore.getParams()CoresApi.RestoreCore.getParams()CoresApi.SwapCores.getParams()CoresApi.UnloadCore.getParams()CoreSnapshotsApi.CreateSnapshot.getParams()CoreSnapshotsApi.DeleteSnapshot.getParams()CoreSnapshotsApi.ListSnapshots1.getParams()DelegationTokenRequest.Cancel.getParams()DelegationTokenRequest.Get.getParams()DelegationTokenRequest.Renew.getParams()DirectXmlRequest.getParams()Deprecated.FieldAnalysisRequest.getParams()FileStoreApi.DeleteFile.getParams()FileStoreApi.FetchFile.getParams()FileStoreApi.GetFile.getParams()FileStoreApi.GetMetadata.getParams()FileStoreApi.SyncFile.getParams()FileStoreApi.UploadFile.getParams()GenericSolrRequest.getParams()HealthCheckRequest.getParams()LoggingApi.FetchLocalLogMessages.getParams()LoggingApi.ListAllLoggersAndLevels.getParams()LoggingApi.ModifyLocalLogLevel.getParams()LoggingApi.SetMessageThreshold.getParams()LukeRequest.getParams()NodeApi.DeleteNode.getParams()NodeApi.GetCommandStatus.getParams()NodeApi.GetPublicKey.getParams()NodeApi.ReplaceNode.getParams()QueryingApi.JsonQuery.getParams()QueryingApi.Query.getParams()QueryRequest.getParams()ReplicaPropertiesApi.AddReplicaProperty.getParams()ReplicaPropertiesApi.DeleteReplicaProperty.getParams()ReplicasApi.CreateReplica.getParams()ReplicasApi.DeleteReplicaByName.getParams()ReplicasApi.DeleteReplicasByCount.getParams()ReplicasApi.DeleteReplicasByCountAllShards.getParams()ReplicationApi.FetchFile1.getParams()ReplicationApi.FetchFileList.getParams()ReplicationApi.FetchIndexVersion.getParams()ReplicationBackupsApi.CreateBackup1.getParams()SchemaApi.GetDynamicFieldInfo.getParams()SchemaApi.GetFieldInfo.getParams()SchemaApi.GetFieldTypeInfo.getParams()SchemaApi.GetSchemaInfo.getParams()SchemaApi.GetSchemaName.getParams()SchemaApi.GetSchemaSimilarity.getParams()SchemaApi.GetSchemaUniqueKey.getParams()SchemaApi.GetSchemaVersion.getParams()SchemaApi.GetSchemaZkVersion.getParams()SchemaApi.ListCopyFields.getParams()SchemaApi.ListDynamicFields.getParams()SchemaApi.ListSchemaFields.getParams()SchemaApi.ListSchemaFieldTypes.getParams()SegmentsApi.GetSegmentData.getParams()ShardsApi.CreateShard.getParams()ShardsApi.DeleteShard.getParams()ShardsApi.ForceShardLeader.getParams()ShardsApi.InstallShardData.getParams()ShardsApi.SyncShard.getParams()V2Request.getParams()ZookeeperReadApi.ListNodes.getParams()ZookeeperReadApi.ReadNode.getParams()Methods in org.apache.solr.client.solrj.request with parameters of type SolrParamsModifier and TypeMethodDescriptionvoidDirectXmlRequest.setParams(SolrParams params) Deprecated.V2Request.Builder.withParams(SolrParams params) Constructors in org.apache.solr.client.solrj.request with parameters of type SolrParamsModifierConstructorDescriptionGenericSolrRequest(SolrRequest.METHOD m, String path, SolrParams params) GenericV2SolrRequest(SolrRequest.METHOD m, String path, SolrParams params) LukeRequest(SolrParams params) QueryRequest(String path, SolrParams q) QueryRequest(String path, SolrParams q, SolrRequest.METHOD method) QueryRequest(SolrParams q, SolrRequest.METHOD method) -
Uses of SolrParams in org.apache.solr.client.solrj.request.json
Constructors in org.apache.solr.client.solrj.request.json with parameters of type SolrParamsModifierConstructorDescriptionDirectJsonQueryRequest(String jsonString, SolrParams params) JsonQueryRequest(SolrParams params) Creates aJsonQueryRequestusing the providedSolrParams -
Uses of SolrParams in org.apache.solr.client.solrj.request.schema
Methods in org.apache.solr.client.solrj.request.schema that return SolrParamsConstructors in org.apache.solr.client.solrj.request.schema with parameters of type SolrParamsModifierConstructorDescriptionAbstractSchemaRequest(SolrRequest.METHOD m, String path, SolrParams params) AddCopyField(String source, List<String> dest, Integer maxChars, SolrParams q) AddCopyField(String source, List<String> dest, SolrParams q) AddDynamicField(Map<String, Object> fieldAttributes, SolrParams q) AddField(Map<String, Object> fieldAttributes, SolrParams q) AddFieldType(FieldTypeDefinition fieldTypeDefinition, SolrParams q) DeleteCopyField(String source, List<String> dest, SolrParams q) DeleteDynamicField(String fieldName, SolrParams q) DeleteField(String fieldName, SolrParams q) DeleteFieldType(String fieldTypeName, SolrParams q) DynamicField(String dynamicFieldName, SolrParams q) Field(String fieldName, SolrParams q) Fields(SolrParams q) FieldType(String fieldTypeName, SolrParams q) MultiUpdate(List<SchemaRequest.Update> updateSchemaRequests, SolrParams q) ReplaceDynamicField(Map<String, Object> dynamicFieldAttributes, SolrParams q) ReplaceField(Map<String, Object> fieldAttributes, SolrParams q) ReplaceFieldType(FieldTypeDefinition fieldTypeDefinition, SolrParams q) Update(SolrParams q) -
Uses of SolrParams in org.apache.solr.client.solrj.routing
Methods in org.apache.solr.client.solrj.routing with parameters of type SolrParamsModifier and TypeMethodDescriptionstatic ReplicaListTransformerAffinityReplicaListTransformer.getInstance(String dividendParam, String hashParam, SolrParams requestParams) AffinityReplicaListTransformerFactory.getInstance(String configSpec, SolrParams requestParams, ReplicaListTransformerFactory fallback) ReplicaListTransformerFactory.getInstance(String configSpec, SolrParams requestParams, ReplicaListTransformerFactory fallback) RequestReplicaListTransformerGenerator.getReplicaListTransformer(SolrParams requestParams) RequestReplicaListTransformerGenerator.getReplicaListTransformer(SolrParams requestParams, String defaultShardPreferences) RequestReplicaListTransformerGenerator.getReplicaListTransformer(SolrParams requestParams, String defaultShardPreferences, String nodeName, String baseUrl, String hostName, NodesSysProps sysProps) Constructors in org.apache.solr.client.solrj.routing with parameters of type SolrParamsModifierConstructorDescriptionNodePreferenceRulesComparator(List<PreferenceRule> preferenceRules, SolrParams requestParams, String nodeName, String baseUrl, String hostName, NodesSysProps sysProps, ReplicaListTransformerFactory defaultRltFactory, ReplicaListTransformerFactory stableRltFactory) NodePreferenceRulesComparator(List<PreferenceRule> preferenceRules, SolrParams requestParams, ReplicaListTransformerFactory defaultRltFactory, ReplicaListTransformerFactory stableRltFactory) -
Uses of SolrParams in org.apache.solr.common.cloud
Methods in org.apache.solr.common.cloud with parameters of type SolrParamsModifier and TypeMethodDescriptionprotected StringHashBasedRouter.getId(SolrInputDocument sdoc, SolrParams params) CompositeIdRouter.getSearchRangeSingle(String shardKey, SolrParams params, DocCollection collection) DocRouter.getSearchRangeSingle(String shardKey, SolrParams params, DocCollection collection) This method is consulted to determine what search range (the part of the hash ring) should be queried for a request when an explicit shards' parameter was not used.DocRouter.getSearchSlices(String shardKeys, SolrParams params, DocCollection collection) This method is consulted to determine what slices should be queried for a request when an explicit shards' parameter was not used.CompositeIdRouter.getSearchSlicesSingle(String shardKey, SolrParams params, DocCollection collection) abstract Collection<Slice> DocRouter.getSearchSlicesSingle(String shardKey, SolrParams params, DocCollection collection) This method is consulted to determine what slices should be queried for a request when an explicit shards' parameter was not used.HashBasedRouter.getSearchSlicesSingle(String shardKey, SolrParams params, DocCollection collection) ImplicitDocRouter.getSearchSlicesSingle(String shardKey, SolrParams params, DocCollection collection) CompositeIdRouter.getTargetSlice(String id, SolrInputDocument sdoc, String route, SolrParams params, DocCollection collection) abstract SliceDocRouter.getTargetSlice(String id, SolrInputDocument sdoc, String route, SolrParams params, DocCollection collection) Returns the Slice that the document should reside on, or null if there is not enough informationHashBasedRouter.getTargetSlice(String id, SolrInputDocument sdoc, String route, SolrParams params, DocCollection collection) ImplicitDocRouter.getTargetSlice(String id, SolrInputDocument sdoc, String route, SolrParams params, DocCollection collection) abstract booleanDocRouter.isTargetSlice(String id, SolrInputDocument sdoc, SolrParams params, String shardId, DocCollection collection) booleanHashBasedRouter.isTargetSlice(String id, SolrInputDocument sdoc, SolrParams params, String shardId, DocCollection collection) booleanImplicitDocRouter.isTargetSlice(String id, SolrInputDocument sdoc, SolrParams params, String shardId, DocCollection collection) intCompositeIdRouter.sliceHash(String id, SolrInputDocument doc, SolrParams params, DocCollection collection) intHashBasedRouter.sliceHash(String id, SolrInputDocument sdoc, SolrParams params, DocCollection collection) -
Uses of SolrParams in org.apache.solr.common.params
Subclasses of SolrParams in org.apache.solr.common.paramsModifier and TypeClassDescriptionclassSolrParams wrapper which acts similar to DefaultSolrParams except that it "appends" the values of multi-value params from both sub instances, so that all the values are returned.classclassSolrParamsimplementation that can be built from and is backed by aMap.classThis class is similar toMultiMapSolrParamsexcept you can edit the parameters after it is initialized.classclassThis is a simple wrapper to SolrParams that will throw a 400 exception if you ask for a parameter that does not exist.Fields in org.apache.solr.common.params declared as SolrParamsModifier and TypeFieldDescriptionprotected final SolrParamsDefaultSolrParams.defaultsprotected final SolrParamsDefaultSolrParams.paramsprotected final SolrParamsRequiredSolrParams.paramsMethods in org.apache.solr.common.params that return SolrParamsModifier and TypeMethodDescriptionstatic SolrParamsSolrParams.of()An empty, immutable SolrParams.static SolrParamsAn immutable SolrParams holding one pair (not null).static SolrParamsSolrParams.wrapAppended(SolrParams params, SolrParams defaults) static SolrParamsSolrParams.wrapDefaults(SolrParams params, SolrParams defaults) Methods in org.apache.solr.common.params with parameters of type SolrParamsModifier and TypeMethodDescriptionvoidModifiableSolrParams.add(SolrParams params) Add all the params provided in the parameter to this params.MultiMapSolrParams.asMultiMap(SolrParams params) Returns a MultiMap view of the SolrParams as efficiently as possible.MultiMapSolrParams.asMultiMap(SolrParams params, boolean newCopy) Returns a MultiMap view of the SolrParams.static ModifiableSolrParamsModifiableSolrParams.of(SolrParams params) If the input params are of type ModifiableSolrParams, returns the input, otherwise, constructs a new ModifiableSolrParams, copying values from the given params.static AppendedSolrParamsAppendedSolrParams.wrapAppended(SolrParams params, SolrParams extra) static SolrParamsSolrParams.wrapAppended(SolrParams params, SolrParams defaults) static SolrParamsSolrParams.wrapDefaults(SolrParams params, SolrParams defaults) Constructors in org.apache.solr.common.params with parameters of type SolrParamsModifierConstructorDescriptionDefaultSolrParams(SolrParams params, SolrParams defaults) ModifiableSolrParams(SolrParams params) Constructs a new ModifiableSolrParams, copying values from an existing SolrParamsRequiredSolrParams(SolrParams params) -
Uses of SolrParams in org.apache.solr.common.util
Methods in org.apache.solr.common.util that return SolrParams