{"id":561,"date":"2020-02-14T08:13:48","date_gmt":"2020-02-14T08:13:48","guid":{"rendered":"https:\/\/www.aeologic.com\/blog\/?p=561"},"modified":"2020-03-18T08:11:29","modified_gmt":"2020-03-18T08:11:29","slug":"ultimate-solr-guide-10-solr-client-apis","status":"publish","type":"post","link":"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/","title":{"rendered":"Solr Client API’s – Ultimate Solr Guide"},"content":{"rendered":"

Hello Everyone! Today we will discuss another important aspect in solr which is widely used in enterprise-grade applications harnessing the power of solr. In most scenarios, we need to interact with data types of different types and from different sources. Solr provides with multiple client Api’s to deal with this type of scenario and do much more.<\/p>\n

Introduction to Client APIs<\/h1>\n
\n

At its heart, Solr is a Web application, but because it is built on open protocols, any type of client application can use Solr.<\/p>\n<\/div>\n

\n

HTTP is the fundamental protocol used between client applications and Solr. The client makes a request and Solr does some work and provides a response. Clients use requests to ask Solr to do things like performing queries or index documents.<\/p>\n<\/div>\n

\n

Client applications can reach Solr by creating HTTP requests and parsing the HTTP responses. Client APIs encapsulate much of the work of sending requests and parsing responses, which makes it much easier to write client applications.<\/p>\n<\/div>\n

\n

Clients use Solr\u2019s five fundamental operations to work with Solr. The operations are query, index, delete, commit, and optimize.<\/p>\n<\/div>\n

\n

Queries are executed by creating a URL that contains all the query parameters. Solr examines the request URL, performs the query, and returns the results. The other operations are similar, although in certain cases the HTTP request is a POST operation and contains information beyond whatever is included in the request URL. An index operation, for example, may contain a document in the body of the request.<\/p>\n

Choosing an Output Format<\/h1>\n
\n
\n

Many programming environments are able to send HTTP requests and retrieve responses. Parsing the responses is a slightly more thorny problem. Fortunately, Solr makes it easy to choose an output format that will be easy to handle on the client side.<\/p>\n<\/div>\n

\n

Specify a response format using the\u00a0wt<\/code> parameter in a query.<\/p>\n<\/div>\n

\n

Most client APIs hide this detail for you, so for many types of client applications, you won\u2019t ever have to specify a\u00a0wt<\/code>\u00a0parameter. In JavaScript, however, the interface to Solr is a little closer to the metal, so you will need to add this parameter yourself.<\/p>\n<\/div>\n

Client API Lineup<\/h1>\n

As of now, solr has follwoing client API’s in provision:<\/p>\n\n\n\n\n<\/colgroup>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/th>\nEnvironment<\/th>\nURL<\/th>\n<\/tr>\n<\/thead>\n
\n

SolRuby<\/p>\n<\/td>\n

\n

Ruby<\/p>\n<\/td>\n

\n

https:\/\/github.com\/rsolr\/rsolr<\/a><\/p>\n<\/td>\n<\/tr>\n

\n

DelSolr<\/p>\n<\/td>\n

\n

Ruby<\/p>\n<\/td>\n

\n

https:\/\/github.com\/avvo\/delsolr<\/a><\/p>\n<\/td>\n<\/tr>\n

\n

acts_as_solr<\/p>\n<\/td>\n

\n

Rails<\/p>\n<\/td>\n

\n

http:\/\/acts-as-solr.rubyforge.org\/<\/a>,\u00a0http:\/\/rubyforge.org\/projects\/background-solr\/<\/a><\/p>\n<\/td>\n<\/tr>\n

\n

Flare<\/p>\n<\/td>\n

\n

Rails<\/p>\n<\/td>\n

\n

http:\/\/wiki.apache.org\/solr\/Flare<\/a><\/p>\n<\/td>\n<\/tr>\n

\n

SolPHP<\/p>\n<\/td>\n

\n

PHP<\/p>\n<\/td>\n

\n

http:\/\/wiki.apache.org\/solr\/SolPHP<\/a><\/p>\n<\/td>\n<\/tr>\n

\n

SolrJ<\/p>\n<\/td>\n

\n

Java<\/p>\n<\/td>\n

\n

http:\/\/wiki.apache.org\/solr\/SolJava<\/a><\/p>\n<\/td>\n<\/tr>\n

\n

Python API<\/p>\n<\/td>\n

\n

Python<\/p>\n<\/td>\n

\n

http:\/\/wiki.apache.org\/solr\/SolPython<\/a><\/p>\n<\/td>\n<\/tr>\n

\n

PySolr<\/p>\n<\/td>\n

\n

Python<\/p>\n<\/td>\n

\n

http:\/\/code.google.com\/p\/pysolr\/<\/a><\/p>\n<\/td>\n<\/tr>\n

\n

SolPerl<\/p>\n<\/td>\n

\n

Perl<\/p>\n<\/td>\n

\n

http:\/\/wiki.apache.org\/solr\/SolPerl<\/a><\/p>\n<\/td>\n<\/tr>\n

\n

Solr.pm<\/p>\n<\/td>\n

\n

Perl<\/p>\n<\/td>\n

\n

http:\/\/search.cpan.org\/~garafola\/Solr-0.03\/lib\/Solr.pm<\/a><\/p>\n<\/td>\n<\/tr>\n

\n

SolrForrest<\/p>\n<\/td>\n

\n

Forrest\/Cocoon<\/p>\n<\/td>\n

\n

http:\/\/wiki.apache.org\/solr\/SolrForrest<\/a><\/p>\n<\/td>\n<\/tr>\n

\n

SolrSharp<\/p>\n<\/td>\n

\n

C#<\/p>\n<\/td>\n

\n

http:\/\/www.codeplex.com\/solrsharp<\/a><\/p>\n<\/td>\n<\/tr>\n

\n

SolColdfusion<\/p>\n<\/td>\n

\n

ColdFusion<\/p>\n<\/td>\n

\n

http:\/\/solcoldfusion.riaforge.org\/<\/a><\/p>\n<\/td>\n<\/tr>\n

\n

SolrNet<\/p>\n<\/td>\n

\n

.NET<\/p>\n<\/td>\n

\n

https:\/\/github.com\/mausch\/SolrNet<\/a><\/p>\n<\/td>\n<\/tr>\n

\n

AJAX Solr<\/p>\n<\/td>\n

\n

AJAX<\/p>\n<\/td>\n

\n

http:\/\/github.com\/evolvingweb\/ajax-solr\/wiki<\/a><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Using JavaScript<\/h1>\n
\n

Using Solr from JavaScript clients is so straightforward that it deserves a special mention. In fact, it is so straightforward that there is no client API. You don\u2019t need to install any packages or configure anything.<\/p>\n<\/div>\n

\n

HTTP requests can be sent to Solr using the standard\u00a0XMLHttpRequest<\/code>\u00a0mechanism.<\/p>\n<\/div>\n

\n

By default, Solr sends Javascript Object Notation(JSON) responses, which are easily interpreted in JavaScript. You don\u2019t need to add anything to the request URL to have responses sent as JSON.<\/p>\n<\/div>\n

Using SolrJ<\/h1>\n

Building and Running SolrJ Applications<\/h2>\n
\n

The SolrJ API ships with Solr, so you do not have to download or install anything else. But you will need to configure your build to include SolrJ and its dependencies.<\/p>\n<\/div>\n

\n

Common Build Systems<\/h3>\n
\n

Most mainstream build systems greatly simplify dependency management, making it easy to add SolrJ to your project.<\/p>\n<\/div>\n

\n

For projects built with Ant (using\u00a0Ivy<\/a>), place the following in your\u00a0ivy.xml<\/code>:<\/p>\n

\"\"<\/p>\n

For projects built with Maven, place the following in your\u00a0pom.xml<\/code><\/p>\n

\"\"<\/p>\n

For projects built with Gradle, place the following in your\u00a0build.gradle<\/code>:<\/p>\n

\"\"<\/p>\n<\/div>\n

Adding SolrJ to the Classpath Manually<\/h3>\n
\n

If you are not using one of the above build system, it\u2019s still easy to add SolrJ to your build.<\/p>\n<\/div>\n

\n

At build time, all that is required is the SolrJ jar itself:\u00a0solr-solrj-7.4.0.jar<\/code>. To compile code manually that uses SolrJ, use a\u00a0javac<\/code>\u00a0command similar to:<\/p>\n

\"\"<\/p>\n

At runtime, you need a few of SolrJ\u2019s dependencies, in addition to SolrJ itself. For convenience, these dependencies are made available in the\u00a0dist\/solrj-lib<\/code>\u00a0directory. Run your project with a classpath like:<\/p>\n

\"\"<\/p>\n

Querying in SolrJ<\/h2>\n
\n

SolrClient<\/code>\u00a0has a number of\u00a0query()<\/code>\u00a0methods for fetching results from Solr. Each of these methods takes in a\u00a0SolrParams<\/code>,an object encapsulating arbitrary query-parameters. And each method outputs a\u00a0QueryResponse<\/code>, a wrapper which can be used to access the result documents and other related metadata.<\/p>\n<\/div>\n

\n

The following snippet uses a SolrClient to query Solr\u2019s “techproducts” example collection, and iterate over the results.<\/p>\n

\"\"<\/p>\n

SolrParams<\/code>\u00a0has a\u00a0SolrQuery<\/code>\u00a0subclass, which provides some convenience methods that greatly simplifies query creation. The following snippet shows how the query from the previous example can be built using some of the convenience methods in\u00a0SolrQuery<\/code>:<\/p>\n

\"\"<\/p>\n

Indexing in SolrJ<\/h2>\n
\n

Indexing is also simple using SolrJ. Users build the documents they want to index as instances of\u00a0SolrInputDocument<\/code>, and provide them as arguments to one of the\u00a0add()<\/code>\u00a0methods on\u00a0SolrClient<\/code>.<\/p>\n<\/div>\n

\n

The following example shows how to use SolrJ to add a document to Solr\u2019s “techproducts” example collection:<\/p>\n

\"\"<\/p>\n

So , this is it about solr client API’s. We will be back with another post very soon.10 Solr Client API’s<\/p>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n","protected":false},"excerpt":{"rendered":"

Hello Everyone! Today we will discuss another important aspect in solr which is widely used in enterprise-grade applications harnessing the power of solr. In most scenarios, we need to interact with data types of different types and from different sources. Solr provides with multiple client Api’s to deal with this type of scenario and do much more. Introduction to Client APIs At its heart, Solr is a Web application, but because it is built on open protocols, any type of client application can use Solr. HTTP is the fundamental protocol used between client applications and Solr. The client makes a request and Solr does some work and provides a response. Clients use requests to ask Solr to do things like performing queries or index documents. Client applications can reach Solr by creating HTTP requests and parsing the HTTP responses. Client APIs encapsulate much of the work of sending requests and parsing responses, which makes it much easier to write client applications. Clients use Solr\u2019s five fundamental operations to work with Solr. The operations are query, index, delete, commit, and optimize. Queries are executed by creating a URL that contains all the query parameters. Solr examines the request URL, performs the query, and returns the results. The other operations are similar, although in certain cases the HTTP request is a POST operation and contains information beyond whatever is included in the request URL. An index operation, for example, may contain a document in the body of the request. Choosing an Output Format Many programming environments are able to send HTTP requests and retrieve responses. Parsing the responses is a slightly more thorny problem. Fortunately, Solr makes it easy to choose an output format that will be easy to handle on the client side. Specify a response format using the\u00a0wt parameter in a query. Most client APIs hide this detail for you, so for many types of client applications, you won\u2019t ever have to specify a\u00a0wt\u00a0parameter. In JavaScript, however, the interface to Solr is a little closer to the metal, so you will need to add this parameter yourself. Client API Lineup As of now, solr has follwoing client API’s in provision: Name Environment URL SolRuby Ruby https:\/\/github.com\/rsolr\/rsolr DelSolr Ruby https:\/\/github.com\/avvo\/delsolr acts_as_solr Rails http:\/\/acts-as-solr.rubyforge.org\/,\u00a0http:\/\/rubyforge.org\/projects\/background-solr\/ Flare Rails http:\/\/wiki.apache.org\/solr\/Flare SolPHP PHP http:\/\/wiki.apache.org\/solr\/SolPHP SolrJ Java http:\/\/wiki.apache.org\/solr\/SolJava Python API Python http:\/\/wiki.apache.org\/solr\/SolPython PySolr Python http:\/\/code.google.com\/p\/pysolr\/ SolPerl Perl http:\/\/wiki.apache.org\/solr\/SolPerl Solr.pm Perl http:\/\/search.cpan.org\/~garafola\/Solr-0.03\/lib\/Solr.pm SolrForrest Forrest\/Cocoon http:\/\/wiki.apache.org\/solr\/SolrForrest SolrSharp C# http:\/\/www.codeplex.com\/solrsharp SolColdfusion ColdFusion http:\/\/solcoldfusion.riaforge.org\/ SolrNet .NET https:\/\/github.com\/mausch\/SolrNet AJAX Solr AJAX http:\/\/github.com\/evolvingweb\/ajax-solr\/wiki Using JavaScript Using Solr from JavaScript clients is so straightforward that it deserves a special mention. In fact, it is so straightforward that there is no client API. You don\u2019t need to install any packages or configure anything. HTTP requests can be sent to Solr using the standard\u00a0XMLHttpRequest\u00a0mechanism. By default, Solr sends Javascript Object Notation(JSON) responses, which are easily interpreted in JavaScript. You don\u2019t need to add anything to the request URL to have responses sent as JSON. Using SolrJ Building and Running SolrJ Applications The SolrJ API ships with Solr, so you do not have to download or install anything else. But you will need to configure your build to include SolrJ and its dependencies. Common Build Systems Most mainstream build systems greatly simplify dependency management, making it easy to add SolrJ to your project. For projects built with Ant (using\u00a0Ivy), place the following in your\u00a0ivy.xml: For projects built with Maven, place the following in your\u00a0pom.xml For projects built with Gradle, place the following in your\u00a0build.gradle: Adding SolrJ to the Classpath Manually If you are not using one of the above build system, it\u2019s still easy to add SolrJ to your build. At build time, all that is required is the SolrJ jar itself:\u00a0solr-solrj-7.4.0.jar. To compile code manually that uses SolrJ, use a\u00a0javac\u00a0command similar to: At runtime, you need a few of SolrJ\u2019s dependencies, in addition to SolrJ itself. For convenience, these dependencies are made available in the\u00a0dist\/solrj-lib\u00a0directory. Run your project with a classpath like: Querying in SolrJ SolrClient\u00a0has a number of\u00a0query()\u00a0methods for fetching results from Solr. Each of these methods takes in a\u00a0SolrParams,an object encapsulating arbitrary query-parameters. And each method outputs a\u00a0QueryResponse, a wrapper which can be used to access the result documents and other related metadata. The following snippet uses a SolrClient to query Solr\u2019s “techproducts” example collection, and iterate over the results. SolrParams\u00a0has a\u00a0SolrQuery\u00a0subclass, which provides some convenience methods that greatly simplifies query creation. The following snippet shows how the query from the previous example can be built using some of the convenience methods in\u00a0SolrQuery: Indexing in SolrJ Indexing is also simple using SolrJ. Users build the documents they want to index as instances of\u00a0SolrInputDocument, and provide them as arguments to one of the\u00a0add()\u00a0methods on\u00a0SolrClient. The following example shows how to use SolrJ to add a document to Solr\u2019s “techproducts” example collection: So , this is it about solr client API’s. We will be back with another post very soon.10 Solr Client API’s<\/p>\n","protected":false},"author":3,"featured_media":574,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[41],"tags":[84,7,86,85],"class_list":["post-561","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-solr","tag-client-api","tag-solr","tag-solr-client-apis","tag-solrj"],"yoast_head":"\nSolr Client API's - Ultimate Solr Guide - Aeologic Blog<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Solr Client API's - Ultimate Solr Guide - Aeologic Blog\" \/>\n<meta property=\"og:description\" content=\"Hello Everyone! Today we will discuss another important aspect in solr which is widely used in enterprise-grade applications harnessing the power of solr. In most scenarios, we need to interact with data types of different types and from different sources. Solr provides with multiple client Api’s to deal with this type of scenario and do much more. Introduction to Client APIs At its heart, Solr is a Web application, but because it is built on open protocols, any type of client application can use Solr. HTTP is the fundamental protocol used between client applications and Solr. The client makes a request and Solr does some work and provides a response. Clients use requests to ask Solr to do things like performing queries or index documents. Client applications can reach Solr by creating HTTP requests and parsing the HTTP responses. Client APIs encapsulate much of the work of sending requests and parsing responses, which makes it much easier to write client applications. Clients use Solr\u2019s five fundamental operations to work with Solr. The operations are query, index, delete, commit, and optimize. Queries are executed by creating a URL that contains all the query parameters. Solr examines the request URL, performs the query, and returns the results. The other operations are similar, although in certain cases the HTTP request is a POST operation and contains information beyond whatever is included in the request URL. An index operation, for example, may contain a document in the body of the request. Choosing an Output Format Many programming environments are able to send HTTP requests and retrieve responses. Parsing the responses is a slightly more thorny problem. Fortunately, Solr makes it easy to choose an output format that will be easy to handle on the client side. Specify a response format using the\u00a0wt parameter in a query. Most client APIs hide this detail for you, so for many types of client applications, you won\u2019t ever have to specify a\u00a0wt\u00a0parameter. In JavaScript, however, the interface to Solr is a little closer to the metal, so you will need to add this parameter yourself. Client API Lineup As of now, solr has follwoing client API’s in provision: Name Environment URL SolRuby Ruby https:\/\/github.com\/rsolr\/rsolr DelSolr Ruby https:\/\/github.com\/avvo\/delsolr acts_as_solr Rails http:\/\/acts-as-solr.rubyforge.org\/,\u00a0http:\/\/rubyforge.org\/projects\/background-solr\/ Flare Rails http:\/\/wiki.apache.org\/solr\/Flare SolPHP PHP http:\/\/wiki.apache.org\/solr\/SolPHP SolrJ Java http:\/\/wiki.apache.org\/solr\/SolJava Python API Python http:\/\/wiki.apache.org\/solr\/SolPython PySolr Python http:\/\/code.google.com\/p\/pysolr\/ SolPerl Perl http:\/\/wiki.apache.org\/solr\/SolPerl Solr.pm Perl http:\/\/search.cpan.org\/~garafola\/Solr-0.03\/lib\/Solr.pm SolrForrest Forrest\/Cocoon http:\/\/wiki.apache.org\/solr\/SolrForrest SolrSharp C# http:\/\/www.codeplex.com\/solrsharp SolColdfusion ColdFusion http:\/\/solcoldfusion.riaforge.org\/ SolrNet .NET https:\/\/github.com\/mausch\/SolrNet AJAX Solr AJAX http:\/\/github.com\/evolvingweb\/ajax-solr\/wiki Using JavaScript Using Solr from JavaScript clients is so straightforward that it deserves a special mention. In fact, it is so straightforward that there is no client API. You don\u2019t need to install any packages or configure anything. HTTP requests can be sent to Solr using the standard\u00a0XMLHttpRequest\u00a0mechanism. By default, Solr sends Javascript Object Notation(JSON) responses, which are easily interpreted in JavaScript. You don\u2019t need to add anything to the request URL to have responses sent as JSON. Using SolrJ Building and Running SolrJ Applications The SolrJ API ships with Solr, so you do not have to download or install anything else. But you will need to configure your build to include SolrJ and its dependencies. Common Build Systems Most mainstream build systems greatly simplify dependency management, making it easy to add SolrJ to your project. For projects built with Ant (using\u00a0Ivy), place the following in your\u00a0ivy.xml: For projects built with Maven, place the following in your\u00a0pom.xml For projects built with Gradle, place the following in your\u00a0build.gradle: Adding SolrJ to the Classpath Manually If you are not using one of the above build system, it\u2019s still easy to add SolrJ to your build. At build time, all that is required is the SolrJ jar itself:\u00a0solr-solrj-7.4.0.jar. To compile code manually that uses SolrJ, use a\u00a0javac\u00a0command similar to: At runtime, you need a few of SolrJ\u2019s dependencies, in addition to SolrJ itself. For convenience, these dependencies are made available in the\u00a0dist\/solrj-lib\u00a0directory. Run your project with a classpath like: Querying in SolrJ SolrClient\u00a0has a number of\u00a0query()\u00a0methods for fetching results from Solr. Each of these methods takes in a\u00a0SolrParams,an object encapsulating arbitrary query-parameters. And each method outputs a\u00a0QueryResponse, a wrapper which can be used to access the result documents and other related metadata. The following snippet uses a SolrClient to query Solr\u2019s “techproducts” example collection, and iterate over the results. SolrParams\u00a0has a\u00a0SolrQuery\u00a0subclass, which provides some convenience methods that greatly simplifies query creation. The following snippet shows how the query from the previous example can be built using some of the convenience methods in\u00a0SolrQuery: Indexing in SolrJ Indexing is also simple using SolrJ. Users build the documents they want to index as instances of\u00a0SolrInputDocument, and provide them as arguments to one of the\u00a0add()\u00a0methods on\u00a0SolrClient. The following example shows how to use SolrJ to add a document to Solr\u2019s “techproducts” example collection: So , this is it about solr client API’s. We will be back with another post very soon.10 Solr Client API’s\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/\" \/>\n<meta property=\"og:site_name\" content=\"Aeologic Blog\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/AeoLogicTech\/\" \/>\n<meta property=\"article:published_time\" content=\"2020-02-14T08:13:48+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2020-03-18T08:11:29+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/www.aeologic.com\/blog\/wp-content\/uploads\/2020\/02\/Solr-Client-APIs.png\" \/>\n\t<meta property=\"og:image:width\" content=\"1080\" \/>\n\t<meta property=\"og:image:height\" content=\"622\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"Manoj Kumar\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@aeologictech\" \/>\n<meta name=\"twitter:site\" content=\"@aeologictech\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Manoj Kumar\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"5 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":[\"Article\",\"BlogPosting\"],\"@id\":\"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/\"},\"author\":{\"name\":\"Manoj Kumar\",\"@id\":\"https:\/\/www.aeologic.com\/blog\/#\/schema\/person\/13549984ba8e5f441cc733ed20d7daa4\"},\"headline\":\"Solr Client API’s – Ultimate Solr Guide\",\"datePublished\":\"2020-02-14T08:13:48+00:00\",\"dateModified\":\"2020-03-18T08:11:29+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/\"},\"wordCount\":925,\"publisher\":{\"@id\":\"https:\/\/www.aeologic.com\/blog\/#organization\"},\"image\":{\"@id\":\"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/www.aeologic.com\/blog\/wp-content\/uploads\/2020\/02\/Solr-Client-APIs.png\",\"keywords\":[\"client api\",\"solr\",\"solr client apis\",\"solrj\"],\"articleSection\":[\"Solr\"],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/\",\"url\":\"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/\",\"name\":\"Solr Client API's - Ultimate Solr Guide - Aeologic Blog\",\"isPartOf\":{\"@id\":\"https:\/\/www.aeologic.com\/blog\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/www.aeologic.com\/blog\/wp-content\/uploads\/2020\/02\/Solr-Client-APIs.png\",\"datePublished\":\"2020-02-14T08:13:48+00:00\",\"dateModified\":\"2020-03-18T08:11:29+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/#primaryimage\",\"url\":\"https:\/\/www.aeologic.com\/blog\/wp-content\/uploads\/2020\/02\/Solr-Client-APIs.png\",\"contentUrl\":\"https:\/\/www.aeologic.com\/blog\/wp-content\/uploads\/2020\/02\/Solr-Client-APIs.png\",\"width\":1080,\"height\":622},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.aeologic.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Solr Client API’s – Ultimate Solr Guide\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.aeologic.com\/blog\/#website\",\"url\":\"https:\/\/www.aeologic.com\/blog\/\",\"name\":\"Aeologic Blog\",\"description\":\"Aeologic\",\"publisher\":{\"@id\":\"https:\/\/www.aeologic.com\/blog\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.aeologic.com\/blog\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.aeologic.com\/blog\/#organization\",\"name\":\"AeoLogic Technologies\",\"url\":\"https:\/\/www.aeologic.com\/blog\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.aeologic.com\/blog\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.aeologic.com\/blog\/wp-content\/uploads\/2022\/05\/new-logo-aeo.jpg\",\"contentUrl\":\"https:\/\/www.aeologic.com\/blog\/wp-content\/uploads\/2022\/05\/new-logo-aeo.jpg\",\"width\":385,\"height\":162,\"caption\":\"AeoLogic Technologies\"},\"image\":{\"@id\":\"https:\/\/www.aeologic.com\/blog\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/AeoLogicTech\/\",\"https:\/\/x.com\/aeologictech\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.aeologic.com\/blog\/#\/schema\/person\/13549984ba8e5f441cc733ed20d7daa4\",\"name\":\"Manoj Kumar\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.aeologic.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/24ce77602da5eb5715d74a95733f6c7548e2af73f5a493f9bc0bf55f611d025e?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/24ce77602da5eb5715d74a95733f6c7548e2af73f5a493f9bc0bf55f611d025e?s=96&d=mm&r=g\",\"caption\":\"Manoj Kumar\"},\"description\":\"Manoj Kumar is a seasoned Digital Marketing Manager and passionate Tech Blogger with deep expertise in SEO, AI trends, and emerging digital technologies. He writes about innovative solutions that drive growth and transformation across industry. Featured on - YOURSTORY | TECHSLING | ELEARNINGINDUSTRY | DATASCIENCECENTRAL | TIMESOFINDIA | MEDIUM | DATAFLOQ\",\"sameAs\":[\"https:\/\/www.aeologic.com\/\",\"https:\/\/www.linkedin.com\/in\/manoj-kumar-rajput\/\"],\"url\":\"https:\/\/www.aeologic.com\/blog\/author\/manoj\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Solr Client API's - Ultimate Solr Guide - Aeologic Blog","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/","og_locale":"en_US","og_type":"article","og_title":"Solr Client API's - Ultimate Solr Guide - Aeologic Blog","og_description":"Hello Everyone! Today we will discuss another important aspect in solr which is widely used in enterprise-grade applications harnessing the power of solr. In most scenarios, we need to interact with data types of different types and from different sources. Solr provides with multiple client Api’s to deal with this type of scenario and do much more. Introduction to Client APIs At its heart, Solr is a Web application, but because it is built on open protocols, any type of client application can use Solr. HTTP is the fundamental protocol used between client applications and Solr. The client makes a request and Solr does some work and provides a response. Clients use requests to ask Solr to do things like performing queries or index documents. Client applications can reach Solr by creating HTTP requests and parsing the HTTP responses. Client APIs encapsulate much of the work of sending requests and parsing responses, which makes it much easier to write client applications. Clients use Solr\u2019s five fundamental operations to work with Solr. The operations are query, index, delete, commit, and optimize. Queries are executed by creating a URL that contains all the query parameters. Solr examines the request URL, performs the query, and returns the results. The other operations are similar, although in certain cases the HTTP request is a POST operation and contains information beyond whatever is included in the request URL. An index operation, for example, may contain a document in the body of the request. Choosing an Output Format Many programming environments are able to send HTTP requests and retrieve responses. Parsing the responses is a slightly more thorny problem. Fortunately, Solr makes it easy to choose an output format that will be easy to handle on the client side. Specify a response format using the\u00a0wt parameter in a query. Most client APIs hide this detail for you, so for many types of client applications, you won\u2019t ever have to specify a\u00a0wt\u00a0parameter. In JavaScript, however, the interface to Solr is a little closer to the metal, so you will need to add this parameter yourself. Client API Lineup As of now, solr has follwoing client API’s in provision: Name Environment URL SolRuby Ruby https:\/\/github.com\/rsolr\/rsolr DelSolr Ruby https:\/\/github.com\/avvo\/delsolr acts_as_solr Rails http:\/\/acts-as-solr.rubyforge.org\/,\u00a0http:\/\/rubyforge.org\/projects\/background-solr\/ Flare Rails http:\/\/wiki.apache.org\/solr\/Flare SolPHP PHP http:\/\/wiki.apache.org\/solr\/SolPHP SolrJ Java http:\/\/wiki.apache.org\/solr\/SolJava Python API Python http:\/\/wiki.apache.org\/solr\/SolPython PySolr Python http:\/\/code.google.com\/p\/pysolr\/ SolPerl Perl http:\/\/wiki.apache.org\/solr\/SolPerl Solr.pm Perl http:\/\/search.cpan.org\/~garafola\/Solr-0.03\/lib\/Solr.pm SolrForrest Forrest\/Cocoon http:\/\/wiki.apache.org\/solr\/SolrForrest SolrSharp C# http:\/\/www.codeplex.com\/solrsharp SolColdfusion ColdFusion http:\/\/solcoldfusion.riaforge.org\/ SolrNet .NET https:\/\/github.com\/mausch\/SolrNet AJAX Solr AJAX http:\/\/github.com\/evolvingweb\/ajax-solr\/wiki Using JavaScript Using Solr from JavaScript clients is so straightforward that it deserves a special mention. In fact, it is so straightforward that there is no client API. You don\u2019t need to install any packages or configure anything. HTTP requests can be sent to Solr using the standard\u00a0XMLHttpRequest\u00a0mechanism. By default, Solr sends Javascript Object Notation(JSON) responses, which are easily interpreted in JavaScript. You don\u2019t need to add anything to the request URL to have responses sent as JSON. Using SolrJ Building and Running SolrJ Applications The SolrJ API ships with Solr, so you do not have to download or install anything else. But you will need to configure your build to include SolrJ and its dependencies. Common Build Systems Most mainstream build systems greatly simplify dependency management, making it easy to add SolrJ to your project. For projects built with Ant (using\u00a0Ivy), place the following in your\u00a0ivy.xml: For projects built with Maven, place the following in your\u00a0pom.xml For projects built with Gradle, place the following in your\u00a0build.gradle: Adding SolrJ to the Classpath Manually If you are not using one of the above build system, it\u2019s still easy to add SolrJ to your build. At build time, all that is required is the SolrJ jar itself:\u00a0solr-solrj-7.4.0.jar. To compile code manually that uses SolrJ, use a\u00a0javac\u00a0command similar to: At runtime, you need a few of SolrJ\u2019s dependencies, in addition to SolrJ itself. For convenience, these dependencies are made available in the\u00a0dist\/solrj-lib\u00a0directory. Run your project with a classpath like: Querying in SolrJ SolrClient\u00a0has a number of\u00a0query()\u00a0methods for fetching results from Solr. Each of these methods takes in a\u00a0SolrParams,an object encapsulating arbitrary query-parameters. And each method outputs a\u00a0QueryResponse, a wrapper which can be used to access the result documents and other related metadata. The following snippet uses a SolrClient to query Solr\u2019s “techproducts” example collection, and iterate over the results. SolrParams\u00a0has a\u00a0SolrQuery\u00a0subclass, which provides some convenience methods that greatly simplifies query creation. The following snippet shows how the query from the previous example can be built using some of the convenience methods in\u00a0SolrQuery: Indexing in SolrJ Indexing is also simple using SolrJ. Users build the documents they want to index as instances of\u00a0SolrInputDocument, and provide them as arguments to one of the\u00a0add()\u00a0methods on\u00a0SolrClient. The following example shows how to use SolrJ to add a document to Solr\u2019s “techproducts” example collection: So , this is it about solr client API’s. We will be back with another post very soon.10 Solr Client API’s","og_url":"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/","og_site_name":"Aeologic Blog","article_publisher":"https:\/\/www.facebook.com\/AeoLogicTech\/","article_published_time":"2020-02-14T08:13:48+00:00","article_modified_time":"2020-03-18T08:11:29+00:00","og_image":[{"width":1080,"height":622,"url":"https:\/\/www.aeologic.com\/blog\/wp-content\/uploads\/2020\/02\/Solr-Client-APIs.png","type":"image\/png"}],"author":"Manoj Kumar","twitter_card":"summary_large_image","twitter_creator":"@aeologictech","twitter_site":"@aeologictech","twitter_misc":{"Written by":"Manoj Kumar","Est. reading time":"5 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":["Article","BlogPosting"],"@id":"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/#article","isPartOf":{"@id":"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/"},"author":{"name":"Manoj Kumar","@id":"https:\/\/www.aeologic.com\/blog\/#\/schema\/person\/13549984ba8e5f441cc733ed20d7daa4"},"headline":"Solr Client API’s – Ultimate Solr Guide","datePublished":"2020-02-14T08:13:48+00:00","dateModified":"2020-03-18T08:11:29+00:00","mainEntityOfPage":{"@id":"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/"},"wordCount":925,"publisher":{"@id":"https:\/\/www.aeologic.com\/blog\/#organization"},"image":{"@id":"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/#primaryimage"},"thumbnailUrl":"https:\/\/www.aeologic.com\/blog\/wp-content\/uploads\/2020\/02\/Solr-Client-APIs.png","keywords":["client api","solr","solr client apis","solrj"],"articleSection":["Solr"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/","url":"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/","name":"Solr Client API's - Ultimate Solr Guide - Aeologic Blog","isPartOf":{"@id":"https:\/\/www.aeologic.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/#primaryimage"},"image":{"@id":"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/#primaryimage"},"thumbnailUrl":"https:\/\/www.aeologic.com\/blog\/wp-content\/uploads\/2020\/02\/Solr-Client-APIs.png","datePublished":"2020-02-14T08:13:48+00:00","dateModified":"2020-03-18T08:11:29+00:00","breadcrumb":{"@id":"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/#primaryimage","url":"https:\/\/www.aeologic.com\/blog\/wp-content\/uploads\/2020\/02\/Solr-Client-APIs.png","contentUrl":"https:\/\/www.aeologic.com\/blog\/wp-content\/uploads\/2020\/02\/Solr-Client-APIs.png","width":1080,"height":622},{"@type":"BreadcrumbList","@id":"https:\/\/www.aeologic.com\/blog\/ultimate-solr-guide-10-solr-client-apis\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.aeologic.com\/blog\/"},{"@type":"ListItem","position":2,"name":"Solr Client API’s – Ultimate Solr Guide"}]},{"@type":"WebSite","@id":"https:\/\/www.aeologic.com\/blog\/#website","url":"https:\/\/www.aeologic.com\/blog\/","name":"Aeologic Blog","description":"Aeologic","publisher":{"@id":"https:\/\/www.aeologic.com\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.aeologic.com\/blog\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.aeologic.com\/blog\/#organization","name":"AeoLogic Technologies","url":"https:\/\/www.aeologic.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.aeologic.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/www.aeologic.com\/blog\/wp-content\/uploads\/2022\/05\/new-logo-aeo.jpg","contentUrl":"https:\/\/www.aeologic.com\/blog\/wp-content\/uploads\/2022\/05\/new-logo-aeo.jpg","width":385,"height":162,"caption":"AeoLogic Technologies"},"image":{"@id":"https:\/\/www.aeologic.com\/blog\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/AeoLogicTech\/","https:\/\/x.com\/aeologictech"]},{"@type":"Person","@id":"https:\/\/www.aeologic.com\/blog\/#\/schema\/person\/13549984ba8e5f441cc733ed20d7daa4","name":"Manoj Kumar","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.aeologic.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/24ce77602da5eb5715d74a95733f6c7548e2af73f5a493f9bc0bf55f611d025e?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/24ce77602da5eb5715d74a95733f6c7548e2af73f5a493f9bc0bf55f611d025e?s=96&d=mm&r=g","caption":"Manoj Kumar"},"description":"Manoj Kumar is a seasoned Digital Marketing Manager and passionate Tech Blogger with deep expertise in SEO, AI trends, and emerging digital technologies. He writes about innovative solutions that drive growth and transformation across industry. Featured on - YOURSTORY | TECHSLING | ELEARNINGINDUSTRY | DATASCIENCECENTRAL | TIMESOFINDIA | MEDIUM | DATAFLOQ","sameAs":["https:\/\/www.aeologic.com\/","https:\/\/www.linkedin.com\/in\/manoj-kumar-rajput\/"],"url":"https:\/\/www.aeologic.com\/blog\/author\/manoj\/"}]}},"_links":{"self":[{"href":"https:\/\/www.aeologic.com\/blog\/wp-json\/wp\/v2\/posts\/561","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.aeologic.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.aeologic.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.aeologic.com\/blog\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/www.aeologic.com\/blog\/wp-json\/wp\/v2\/comments?post=561"}],"version-history":[{"count":0,"href":"https:\/\/www.aeologic.com\/blog\/wp-json\/wp\/v2\/posts\/561\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.aeologic.com\/blog\/wp-json\/wp\/v2\/media\/574"}],"wp:attachment":[{"href":"https:\/\/www.aeologic.com\/blog\/wp-json\/wp\/v2\/media?parent=561"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.aeologic.com\/blog\/wp-json\/wp\/v2\/categories?post=561"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.aeologic.com\/blog\/wp-json\/wp\/v2\/tags?post=561"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}