Apache Solr Reference Guide
    • About This Guide
    • Getting Started
      • Solr Tutorial
      • A Quick Overview
      • Solr System Requirements
      • Installing Solr
    • Deployment and Operations
      • Solr Control Script Reference
      • Solr Configuration Files
      • Taking Solr to Production
      • Making and Restoring Backups
      • Running Solr on HDFS
      • SolrCloud on AWS EC2
      • Upgrading a Solr Cluster
        • IndexUpgraderTool
      • Solr Upgrade Notes
        • Major Changes in Solr 8
        • Major Changes in Solr 7
        • Major Changes from Solr 5 to Solr 6
    • Using the Solr Administration User Interface
      • Overview of the Solr Admin UI
      • Logging
      • Cloud Screens
      • Collections / Core Admin
      • Java Properties
      • Thread Dump
      • Suggestions Screen
      • Collection-Specific Tools
        • Analysis Screen
        • Dataimport Screen
        • Documents Screen
        • Files Screen
        • Query Screen
        • Stream Screen
        • Schema Browser Screen
      • Core-Specific Tools
        • Ping
        • Plugins & Stats Screen
        • Replication Screen
        • Segments Info
    • Documents, Fields, and Schema Design
      • Overview of Documents, Fields, and Schema Design
      • Solr Field Types
        • Field Type Definitions and Properties
        • Field Types Included with Solr
        • Working with Currencies and Exchange Rates
        • Working with Dates
        • Working with Enum Fields
        • Working with External Files and Processes
        • Field Properties by Use Case
      • Defining Fields
      • Copying Fields
      • Dynamic Fields
      • Other Schema Elements
      • Schema API
      • Putting the Pieces Together
      • DocValues
      • Schemaless Mode
      • Luke Request Handler
      • Schema Designer
    • Understanding Analyzers, Tokenizers, and Filters
      • Analyzers
      • About Tokenizers
      • About Filters
      • Tokenizers
      • Filter Descriptions
      • CharFilterFactories
      • Language Analysis
      • Phonetic Matching
      • Running Your Analyzer
    • Indexing and Basic Data Operations
      • Introduction to Solr Indexing
      • Post Tool
      • Uploading Data with Index Handlers
        • Transforming and Indexing Custom JSON
      • Indexing Nested Child Documents
      • Uploading Data with Solr Cell using Apache Tika
      • Uploading Structured Data Store Data with the Data Import Handler
      • Updating Parts of Documents
      • Detecting Languages During Indexing
      • De-Duplication
      • Content Streams
      • Reindexing
    • Searching
      • Overview of Searching in Solr
      • Velocity Search UI
      • Relevance
      • Query Syntax and Parsing
        • Common Query Parameters
        • The Standard Query Parser
        • The DisMax Query Parser
        • The Extended DisMax (eDismax) Query Parser
        • Function Queries
        • Local Parameters in Queries
        • Other Parsers
      • JSON Request API
        • JSON Query DSL
      • JSON Facet API
        • JSON Faceting Domain Changes
      • Faceting
        • BlockJoin Faceting
      • Highlighting
      • Spell Checking
      • Query Re-Ranking
        • Learning To Rank
      • Transforming Result Documents
      • Searching Nested Child Documents
      • Suggester
      • MoreLikeThis
      • Pagination of Results
      • Collapse and Expand Results
      • Result Grouping
      • Spatial Search
      • The Terms Component
      • The Term Vector Component
      • The Stats Component
      • The Query Elevation Component
      • The Tagger Handler
      • Response Writers
        • Velocity Response Writer
      • Near Real Time Searching
      • RealTime Get
      • Exporting Result Sets
      • Parallel SQL Interface
        • Solr JDBC - DbVisualizer
        • Solr JDBC - SQuirreL SQL
        • Solr JDBC - Apache Zeppelin
        • Solr JDBC - Python/Jython
        • Solr JDBC - R
      • Analytics Component
        • Analytics Expression Sources
        • Analytics Mapping Functions
        • Analytics Reduction Functions
    • Streaming Expressions
      • Stream Source Reference
      • Stream Decorator Reference
      • Stream Evaluator Reference
      • Streaming Expressions and Math Expressions
        • Visualization
        • Getting Started
        • Loading Data
        • Searching, Sampling and Aggregation
        • Transforming Data
        • Scalar Math
        • Vector Math
        • Variables
        • Matrices and Matrix Math
        • Text Analysis and Term Vectors
        • Probability Distributions
        • Statistics
        • Linear Regression
        • Curve Fitting
        • Time Series
        • Interpolation, Derivatives and Integrals
        • Digital Signal Processing
        • Monte Carlo Simulations
        • Machine Learning
        • Graph
        • Computational Geometry
        • Log Analytics
      • Graph Traversal
      • Stream Request Handler API
    • SolrCloud
      • Getting Started with SolrCloud
      • How SolrCloud Works
        • Shards and Indexing Data in SolrCloud
        • Distributed Requests
        • Aliases
      • SolrCloud Resilience
        • SolrCloud Recoveries and Write Tolerance
        • SolrCloud Query Routing And Read Tolerance
      • SolrCloud Configuration and Parameters
        • Setting Up an External ZooKeeper Ensemble
        • Using ZooKeeper to Manage Configuration Files
        • Collections API
          • Cluster and Node Management Commands
          • Collection Management Commands
          • Collection Aliasing
          • Shard Management Commands
          • Replica Management Commands
        • Parameter Reference
        • Command Line Utilities
        • SolrCloud with Legacy Configuration Files
        • Configsets API
      • Rule-based Replica Placement
      • Cross Data Center Replication (CDCR)
        • CDCR Architecture
        • CDCR Configuration
        • Cross Data Center Replication Operations
        • CDCR API
      • SolrCloud Autoscaling
        • Overview of SolrCloud Autoscaling
        • Autoscaling Policy and Preferences
        • SolrCloud Autoscaling Triggers
        • SolrCloud Autoscaling Trigger Actions
        • SolrCloud Autoscaling Listeners
        • SolrCloud Autoscaling Automatically Adding Replicas
        • SolrCloud Autoscaling Fault Tolerance
        • Autoscaling API
        • Migrating Rule-Based Replica Rules to Autoscaling Policies
      • Colocating Collections
    • Legacy Scaling and Distribution
      • Introduction to Scaling and Distribution
      • Distributed Search with Index Sharding
      • Index Replication
      • Combining Distribution and Replication
      • Merging Indexes
    • Circuit Breakers
    • Solr Plugins
      • Lib Directories and Directives
      • Package Management
        • Package Manager Internals
      • Adding Custom Plugins in SolrCloud Mode
    • The Well-Configured Solr Instance
      • Configuring solrconfig.xml
        • DataDir and DirectoryFactory in SolrConfig
        • Schema Factory Definition in SolrConfig
        • IndexConfig in SolrConfig
        • RequestHandlers and SearchComponents in SolrConfig
        • InitParams in SolrConfig
        • UpdateHandlers in SolrConfig
        • Query Settings in SolrConfig
        • RequestDispatcher in SolrConfig
        • Update Request Processors
        • Codec Factory
      • Solr Cores and solr.xml
        • Format of solr.xml
        • Defining core.properties
        • CoreAdmin API
        • Configsets
      • Resource Loading
      • Configuration APIs
        • Blob Store API
        • Config API
        • Request Parameters API
        • Managed Resources
      • Implicit RequestHandlers
      • JVM Settings
      • v2 API
    • Monitoring Solr
      • Metrics Reporting
      • Metrics History
      • MBean Request Handler
      • Configuring Logging
      • Using JMX with Solr
      • Monitoring Solr with Prometheus and Grafana
      • Performance Statistics Reference
      • Distributed Solr Tracing
    • Securing Solr
      • Configuring Authentication, Authorization and Audit Logging
        • Basic Authentication Plugin
        • Hadoop Authentication Plugin
        • Kerberos Authentication Plugin
        • Rule-Based Authorization Plugins
        • JWT Authentication Plugin
      • Enabling SSL
      • Audit Logging
      • ZooKeeper Access Control
      • Security UI
    • Client APIs
      • Introduction to Client APIs
      • Choosing an Output Format
      • Using SolrJ
      • Using JavaScript
      • Using Python
      • Using Solr From Ruby
      • Other Clients
    • Further Assistance
    • Solr Glossary
    • Errata
    • How to Contribute to Solr Documentation
    Solr 8.11
    • Solr Website
    • Other Formats
      • Archived PDFs
      • Other Versions Online
    • Solr Resources
      • Solr Javadocs
      • Lucene/Solr Source Code
      • Solr Community Links

    Other Clients

    The Solr Wiki contains a list of client APIs at https://cwiki.apache.org/confluence/display/solr/IntegratingSolr.

    Using Solr From Ruby Further Assistance
    ©2021 Apache Software Foundation. All rights reserved.
    Site Version: 8.11
    Site last generated: 2021-11-16

    Apache Solr