Search icon CANCEL
Subscription
0
Cart icon
Your Cart (0 item)
Close icon
You have no products in your basket yet
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Newsletter Hub
Free Learning
Arrow right icon
timer SALE ENDS IN
0 Days
:
00 Hours
:
00 Minutes
:
00 Seconds
Apache Solr PHP Integration
Apache Solr PHP Integration

Apache Solr PHP Integration: Build a fully-featured and scalable search application using PHP to unlock the search functions provided by Solr with this book and ebook.

eBook
$15.99 $22.99
Paperback
$38.99
Subscription
Free Trial
Renews at $19.99p/m

What do you get with Print?

Product feature icon Instant access to your digital eBook copy whilst your Print order is Shipped
Product feature icon Paperback book shipped to your preferred address
Product feature icon Download this book in EPUB and PDF formats
Product feature icon Access this title in our online reader with advanced features
Product feature icon DRM FREE - Read whenever, wherever and however you want
OR
Modal Close icon
Payment Processing...
tick Completed

Shipping Address

Billing Address

Shipping Methods
Table of content icon View table of contents Preview book icon Preview Book

Apache Solr PHP Integration

Chapter 2. Inserting, Updating, and Deleting Documents from Solr

We will start this chapter by discussing the Solr schema. We will explore the default schema provided by Solr. Further, we will explore:

  • Pushing sample data into Solr

  • Adding sample documents to the Solr index

  • Using PHP to add documents to the Solr index

  • Updating documents in Solr using PHP

  • Deleting documents in Solr using PHP

  • Using commit, rollback, and index optimization

The Solr schema


The Solr schema mostly consists of fields and field types. It defines the fields that are to be stored in the Solr index and the processing that should happen on data being indexed or searched in those fields. Internally, the schema is used to assign properties to the fields used for creating a document that is to be indexed using the Lucene API. The default schema available with Solr can be located in <solr_home>/example/solr/collection1/conf/schema.xml. Here, collection1 is the name of the core.

Note

A Solr server can have multiple cores and each core can have its own schema.

Let us open up the schema.xml file and go through it. In the XML file, we can see that there is a section for fields inside which there are multiple fields. Also, there is another section for types. The types section contains different entries of fieldType, which define the type of field in terms of how the field will be processed during indexing and during query. Let us understand how to create...

Adding sample documents to the Solr index


Let us push in some sample data into Solr. Go to <solr_dir>/example/exampledocs. Execute the following commands to add all sample documents into our Solr index:

java -Durl=http://localhost:8080/solr/update -Dtype=application/csv -jar post.jar books.csv
java -Durl=http://localhost:8080/solr/update  -jar post.jar *.xml
java -Durl=http://localhost:8080/solr/update -Dtype=application/json -jar post.jar books.json

To check how many documents have been indexed go to the following URL:

http://localhost:8080/solr/collection1/select/?q=*:*

This is a query to Solr that asks to return all the documents in the index. The numFound field in the XML output specifies the number of documents in our Solr index.

We are working with the default schema. To check the schema, go to the following URL:

http://localhost:8080/solr/#/collection1/schema

The following screenshot shows the content of a sample schema file schema.xml:

We can see that there are multiple fields: id...

Using PHP to add documents to the Solr index


Let us see the code to add documents to Solr using the Solarium library. When we execute the following query we can see that there are three books of the author George R R Martin in our Solr index:

http://localhost:8080/solr/collection1/select/?q=martin

Let us add the remaining two books, which have also been published to our index:

  1. Create a solarium client using the following code:

    $client = new Solarium\Client($config);
  2. Create an instance of the update query using the following code:

    $updateQuery = $client->createUpdate();
  3. Create the documents you want to add and add fields to the document.

    $doc1 = $updateQuery->createDocument();
    $doc1->id = 112233445;
    $doc1->cat = 'book';
    $doc1->name = 'A Feast For Crows';
    $doc1->price = 8.99;
    $doc1->inStock = 'true';
    $doc1->author = 'George R.R. Martin';
    $doc1->series_t = '"A Song of Ice and Fire"';
    $doc1->sequence_i = 4;
    $doc1->genre_s = 'fantasy';
  4. Similarly, another document $doc2...

Updating documents in Solr using PHP


Let us see how we can use PHP code along with Solarium library to update documents in Solr.

  1. First check if there are any documents with the word smith in our index.

    http://localhost:8080/solr/collection1/select/?q=smith
  2. We can see numFound=0, which means that there are no such documents. Let us add a book to our index with the last name of the author as smith.

    $updateQuery = $client->createUpdate();
    $testdoc = $updateQuery->createDocument();
    $testdoc->id = 123456789;
    $testdoc->cat = 'book';
    $testdoc->name = 'Test book';
    $testdoc->price = 5.99;
    $testdoc->author = 'Hello Smith';
    $updateQuery->addDocument($testdoc);
    $updateQuery->addCommit();
    $client->update($updateQuery);
  3. If we run the same select query again, we can see that now there is one document in our index with the author as Smith. Let us now update the author's name to Jack Smith and the price tag to 7.59:

    $testdoc = $updateQuery->createDocument();
    $testdoc->id = 123456789...

Deleting documents in Solr using PHP


Now let us go ahead and delete this document from Solr.

$deleteQuery = $client->createUpdate();
$deleteQuery->addDeleteQuery('author:Smith');
$deleteQuery->addCommit();
$client->update($deleteQuery);

Now, if we run the following query on Solr, the document is not found:

http://localhost:8080/solr/collection1/select/?q=smith

What we did here was that we created a query in Solr to search for all documents where the author field contains the smith word and then passed it as a delete query.

We can add multiple delete queries via the addDeleteQueries method. This can be used to delete multiple sets of documents in a single call.

$deleteQuery->addDeleteQuery(array('author:Burst', 'author:Alexander'));

When this query is executed, all documents where the author field is either Burst or Alexander are deleted from the index.

In addition to deleting by a query, we can also delete by ID. Each book that we have added to our index has an id field, which we...

Commit, rollback, and index optimization


The commitWithin parameter that we have been passing as arguments to our addDocument() function specifies the time for the commit to happen for this add document operation. This leaves the control of when to do the commit to Solr itself. Solr optimizes the number of commits to a minimum while still fulfilling the update latency requirements.

The rollback option is exposed via the addRollback() function. Rollback can be done since the last commit and before current commit. Once a commit has been done, the changes cannot be rolled back.

$rollbackQuery = $client->createUpdate();
$rollbackQuery->addRollback();

Index optimization is one of the tasks that is not necessarily required. But an optimized index has better performance than a non-optimized index. To optimize an index using the PHP code, we can use the addOptimize(boolean $softCommit, boolean $waitSearcher, int $maxSegments) function. It has parameters to enable soft commit, wait until a new...

Summary


In this chapter we started off by discussing the Solr schema. We got a basic understanding of how the Solr schema works. We then added some sample documents to our Solr index. Then we saw multiple pieces of code to add, update, and delete documents to our Solr index. We also saw how to use cURL to delete documents. We discussed how commit and rollback work on the Solr index. We also saw an example of how to use rollback in our code. We discussed index optimization using PHP code and the benefits of optimizing the Solr index.

In the next chapter we will see how to execute search queries on Solr using PHP code and explore different query modes available with Solr.

Left arrow icon Right arrow icon

Key benefits

  • Understand the tools that can be used to communicate between PHP and Solr, and how they work internally
  • Explore the essential search functions of Solr such as sorting, boosting, faceting, and highlighting using your PHP code
  • Take a look at some advanced features of Solr such as spell checking, grouping, and auto complete with implementations using PHP code

Description

The Search tool is a very powerful for any website. No matter what type of website, the search tool helps visitors find what they are looking for using key words and narrow down the results using facets. Solr is the popular, blazing fast, open source enterprise search platform from the Apache Lucene project. It is highly scalable, providing distributed search and index replication, and it powers the search and navigation features of many of the world's largest websites.This book is a practical, hands-on, end-to-end guide that provides you with all the tools required to build a fully-featured search application using Apache Solr and PHP. The book contains practical examples and step-by-step instructions.Starting off with the basics of installing Apache Solr and integrating it with Php, the book then proceeds to explore the features provided by Solr to improve searches using Php. You will learn how to build and maintain a Solr index using Php, discover the query modes available with Solr, and how to use them to tune the Solr queries to retrieve relevant results. You will look at how to build and use facets in your search, how to tune and use fast result highlighting, and how to build a spell check and auto complete feature using Solr. You will finish by learning some of the advanced concepts required to runa large-scale enterprise level search infrastructure.

Who is this book for?

If you are a developer who knows PHP and is interested in integrating search into your applications, this is the book for you. No advanced knowledge of Solr is required. Very basic knowledge of system commands and the command-line interface on both Linux and Windows is required. You should also be familiar with the concept of Web servers.

What you will learn

  • Install Solr and integrate it with PHP
  • Insert, update, and delete documents from the Solr index using PHP
  • Perform select queries using the dismax and edismax query modes
  • Sort, boost, and re-use select queries using PHP
  • Employ faceting and result highlighting
  • Debug and fine-tune Solr search queries for relevance
  • Implement the spell checker and auto complete features using Solr and PHP
  • Search for documents similar to a particular document and Retrieve index stats using PHP
  • Deploy distributed searching using sharing and load-balancing of Solr queries
Estimated delivery fee Deliver to United States

Economy delivery 10 - 13 business days

Free $6.95

Premium delivery 6 - 9 business days

$21.95
(Includes tracking information)

Product Details

Country selected
Publication date, Length, Edition, Language, ISBN-13
Publication date : Nov 25, 2013
Length: 118 pages
Edition : 1st
Language : English
ISBN-13 : 9781782164920
Vendor :
Apache
Category :
Languages :
Tools :

What do you get with Print?

Product feature icon Instant access to your digital eBook copy whilst your Print order is Shipped
Product feature icon Paperback book shipped to your preferred address
Product feature icon Download this book in EPUB and PDF formats
Product feature icon Access this title in our online reader with advanced features
Product feature icon DRM FREE - Read whenever, wherever and however you want
OR
Modal Close icon
Payment Processing...
tick Completed

Shipping Address

Billing Address

Shipping Methods
Estimated delivery fee Deliver to United States

Economy delivery 10 - 13 business days

Free $6.95

Premium delivery 6 - 9 business days

$21.95
(Includes tracking information)

Product Details

Publication date : Nov 25, 2013
Length: 118 pages
Edition : 1st
Language : English
ISBN-13 : 9781782164920
Vendor :
Apache
Category :
Languages :
Tools :

Packt Subscriptions

See our plans and pricing
Modal Close icon
$19.99 billed monthly
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Simple pricing, no contract
$199.99 billed annually
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just $5 each
Feature tick icon Exclusive print discounts
$279.99 billed in 18 months
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just $5 each
Feature tick icon Exclusive print discounts

Frequently bought together


Stars icon
Total $ 77.98
Apache Solr PHP Integration
$38.99
Administrating Solr
$38.99
Total $ 77.98 Stars icon

Table of Contents

8 Chapters
Installing and Integrating Solr and PHP Chevron down icon Chevron up icon
Inserting, Updating, and Deleting Documents from Solr Chevron down icon Chevron up icon
Select Query on Solr and Query Modes (DisMax/eDisMax) Chevron down icon Chevron up icon
Advanced Queries – Filter Queries and Faceting Chevron down icon Chevron up icon
Highlighting Results Using PHP and Solr Chevron down icon Chevron up icon
Debug and Stats Component Chevron down icon Chevron up icon
Spell Check in Solr Chevron down icon Chevron up icon
Advanced Solr – Grouping, the MoreLikeThis Query, and Distributed Search Chevron down icon Chevron up icon

Customer reviews

Rating distribution
Full star icon Full star icon Full star icon Half star icon Empty star icon 3.8
(5 Ratings)
5 star 20%
4 star 60%
3 star 0%
2 star 20%
1 star 0%
James Hollenbeck Jan 29, 2014
Full star icon Full star icon Full star icon Full star icon Full star icon 5
"Apache Solr PHP Integration" is a great resource for hitting the ground running when you are bound to the fast-paced environment of large-scale PHP application design and big-data search. As usual with Packt books, it is great to see the expected ease-of-install directions, telling you what you need to get started, and enough to get the a full-featured launch off the ground.In just a few short pages, you will have a fully functioning Jetty and/or Tomcat Solr solution that is sure to meet both personal and commercial needs. Next, the choice to use Solarium and Composer is a perfect marriage to introduce where resource management is going and how to keep up with the times.Lastly, and most importantly, this book will give you the perfect foundation you will need to get fully search-able instances of Solr running while using PHP-Solarium with both simple and advanced queries - allowing you to become a great asset to any company dealing with large, search-able data sets.
Amazon Verified review Amazon
Chris Pitt Jan 30, 2014
Full star icon Full star icon Full star icon Full star icon Empty star icon 4
Solr can sometimes feel more prickly than a bag of porcupines. That’s when you need this book.First, and least important, is that there is no syntax highlighting. I say this every time I review a Packt book, and it’s always as annoying to find.That aside, this book is well edited. The points are succinct, the grammar palatable and the diction easy to follow.The book begins with some installation instructions for getting PHP and Solr running. I was at first concerned with the presentation of numerous ways to query the same result, few of which concerned PHP examples, but that quickly passed as the book develops into a handbook for the well-supported PHP library Solarium.At only 118 pages, I feel it would reach a wider audience by including Solarium in the title, but that’s up to the marketing department I guess…The content ranges, in difficulty, from the basics of Solr usage to advanced querying and formatting. Along the way, you can learn about how indexing and schemas work in Solr. The book demonstrates every aspect of Solr which it explains, in simple PHP examples.Unlike most books, the length and presentation of this book allow you to go through it all in a single sitting. It may take a bit longer if you are only first coming into contact with Solr, but every bit of help is provided to get you familiar with how things work.My experiences with Solr have not always been good, and I would have loved to get my hands on this book in those times. Instead of prattling on about how much I enjoyed it, I recommend you get it for yourself. After all, it costs about the same as a good pizza.
Amazon Verified review Amazon
Kwabena Boadu Mar 04, 2014
Full star icon Full star icon Full star icon Full star icon Empty star icon 4
Really good book for both beginners and experts in PHP development interested in integrating Apache Solr into their existing PHP applications
Amazon Verified review Amazon
Evgeny Feb 04, 2014
Full star icon Full star icon Full star icon Full star icon Empty star icon 4
This book covers the basics of integrating PHP applications with Apache Solr. I definitely like how along with the usual examples one would expect from a book like this the author also introduces the reader to tools like Composer and Solarium - definitely a good way to encourage best practices. Not to diminish the importance of examples for common scenarios that could be copied and pasted pretty much as is in order to give one's PHP and Solr setup a whirl.Overall definitely a good read for those starting out with Solr.
Amazon Verified review Amazon
Marc Franz Neininger Dec 09, 2014
Full star icon Full star icon Empty star icon Empty star icon Empty star icon 2
Das Buch ist nicht ausführlich genug. Mit der Dokumentation und den mitgelieferten Beispielen ist man genauso schnell und deutlich billiger
Amazon Verified review Amazon
Get free access to Packt library with over 7500+ books and video courses for 7 days!
Start Free Trial

FAQs

What is the delivery time and cost of print book? Chevron down icon Chevron up icon

Shipping Details

USA:

'

Economy: Delivery to most addresses in the US within 10-15 business days

Premium: Trackable Delivery to most addresses in the US within 3-8 business days

UK:

Economy: Delivery to most addresses in the U.K. within 7-9 business days.
Shipments are not trackable

Premium: Trackable delivery to most addresses in the U.K. within 3-4 business days!
Add one extra business day for deliveries to Northern Ireland and Scottish Highlands and islands

EU:

Premium: Trackable delivery to most EU destinations within 4-9 business days.

Australia:

Economy: Can deliver to P. O. Boxes and private residences.
Trackable service with delivery to addresses in Australia only.
Delivery time ranges from 7-9 business days for VIC and 8-10 business days for Interstate metro
Delivery time is up to 15 business days for remote areas of WA, NT & QLD.

Premium: Delivery to addresses in Australia only
Trackable delivery to most P. O. Boxes and private residences in Australia within 4-5 days based on the distance to a destination following dispatch.

India:

Premium: Delivery to most Indian addresses within 5-6 business days

Rest of the World:

Premium: Countries in the American continent: Trackable delivery to most countries within 4-7 business days

Asia:

Premium: Delivery to most Asian addresses within 5-9 business days

Disclaimer:
All orders received before 5 PM U.K time would start printing from the next business day. So the estimated delivery times start from the next day as well. Orders received after 5 PM U.K time (in our internal systems) on a business day or anytime on the weekend will begin printing the second to next business day. For example, an order placed at 11 AM today will begin printing tomorrow, whereas an order placed at 9 PM tonight will begin printing the day after tomorrow.


Unfortunately, due to several restrictions, we are unable to ship to the following countries:

  1. Afghanistan
  2. American Samoa
  3. Belarus
  4. Brunei Darussalam
  5. Central African Republic
  6. The Democratic Republic of Congo
  7. Eritrea
  8. Guinea-bissau
  9. Iran
  10. Lebanon
  11. Libiya Arab Jamahriya
  12. Somalia
  13. Sudan
  14. Russian Federation
  15. Syrian Arab Republic
  16. Ukraine
  17. Venezuela
What is custom duty/charge? Chevron down icon Chevron up icon

Customs duty are charges levied on goods when they cross international borders. It is a tax that is imposed on imported goods. These duties are charged by special authorities and bodies created by local governments and are meant to protect local industries, economies, and businesses.

Do I have to pay customs charges for the print book order? Chevron down icon Chevron up icon

The orders shipped to the countries that are listed under EU27 will not bear custom charges. They are paid by Packt as part of the order.

List of EU27 countries: www.gov.uk/eu-eea:

A custom duty or localized taxes may be applicable on the shipment and would be charged by the recipient country outside of the EU27 which should be paid by the customer and these duties are not included in the shipping charges been charged on the order.

How do I know my custom duty charges? Chevron down icon Chevron up icon

The amount of duty payable varies greatly depending on the imported goods, the country of origin and several other factors like the total invoice amount or dimensions like weight, and other such criteria applicable in your country.

For example:

  • If you live in Mexico, and the declared value of your ordered items is over $ 50, for you to receive a package, you will have to pay additional import tax of 19% which will be $ 9.50 to the courier service.
  • Whereas if you live in Turkey, and the declared value of your ordered items is over € 22, for you to receive a package, you will have to pay additional import tax of 18% which will be € 3.96 to the courier service.
How can I cancel my order? Chevron down icon Chevron up icon

Cancellation Policy for Published Printed Books:

You can cancel any order within 1 hour of placing the order. Simply contact customercare@packt.com with your order details or payment transaction id. If your order has already started the shipment process, we will do our best to stop it. However, if it is already on the way to you then when you receive it, you can contact us at customercare@packt.com using the returns and refund process.

Please understand that Packt Publishing cannot provide refunds or cancel any order except for the cases described in our Return Policy (i.e. Packt Publishing agrees to replace your printed book because it arrives damaged or material defect in book), Packt Publishing will not accept returns.

What is your returns and refunds policy? Chevron down icon Chevron up icon

Return Policy:

We want you to be happy with your purchase from Packtpub.com. We will not hassle you with returning print books to us. If the print book you receive from us is incorrect, damaged, doesn't work or is unacceptably late, please contact Customer Relations Team on customercare@packt.com with the order number and issue details as explained below:

  1. If you ordered (eBook, Video or Print Book) incorrectly or accidentally, please contact Customer Relations Team on customercare@packt.com within one hour of placing the order and we will replace/refund you the item cost.
  2. Sadly, if your eBook or Video file is faulty or a fault occurs during the eBook or Video being made available to you, i.e. during download then you should contact Customer Relations Team within 14 days of purchase on customercare@packt.com who will be able to resolve this issue for you.
  3. You will have a choice of replacement or refund of the problem items.(damaged, defective or incorrect)
  4. Once Customer Care Team confirms that you will be refunded, you should receive the refund within 10 to 12 working days.
  5. If you are only requesting a refund of one book from a multiple order, then we will refund you the appropriate single item.
  6. Where the items were shipped under a free shipping offer, there will be no shipping costs to refund.

On the off chance your printed book arrives damaged, with book material defect, contact our Customer Relation Team on customercare@packt.com within 14 days of receipt of the book with appropriate evidence of damage and we will work with you to secure a replacement copy, if necessary. Please note that each printed book you order from us is individually made by Packt's professional book-printing partner which is on a print-on-demand basis.

What tax is charged? Chevron down icon Chevron up icon

Currently, no tax is charged on the purchase of any print book (subject to change based on the laws and regulations). A localized VAT fee is charged only to our European and UK customers on eBooks, Video and subscriptions that they buy. GST is charged to Indian customers for eBooks and video purchases.

What payment methods can I use? Chevron down icon Chevron up icon

You can pay with the following card types:

  1. Visa Debit
  2. Visa Credit
  3. MasterCard
  4. PayPal
What is the delivery time and cost of print books? Chevron down icon Chevron up icon

Shipping Details

USA:

'

Economy: Delivery to most addresses in the US within 10-15 business days

Premium: Trackable Delivery to most addresses in the US within 3-8 business days

UK:

Economy: Delivery to most addresses in the U.K. within 7-9 business days.
Shipments are not trackable

Premium: Trackable delivery to most addresses in the U.K. within 3-4 business days!
Add one extra business day for deliveries to Northern Ireland and Scottish Highlands and islands

EU:

Premium: Trackable delivery to most EU destinations within 4-9 business days.

Australia:

Economy: Can deliver to P. O. Boxes and private residences.
Trackable service with delivery to addresses in Australia only.
Delivery time ranges from 7-9 business days for VIC and 8-10 business days for Interstate metro
Delivery time is up to 15 business days for remote areas of WA, NT & QLD.

Premium: Delivery to addresses in Australia only
Trackable delivery to most P. O. Boxes and private residences in Australia within 4-5 days based on the distance to a destination following dispatch.

India:

Premium: Delivery to most Indian addresses within 5-6 business days

Rest of the World:

Premium: Countries in the American continent: Trackable delivery to most countries within 4-7 business days

Asia:

Premium: Delivery to most Asian addresses within 5-9 business days

Disclaimer:
All orders received before 5 PM U.K time would start printing from the next business day. So the estimated delivery times start from the next day as well. Orders received after 5 PM U.K time (in our internal systems) on a business day or anytime on the weekend will begin printing the second to next business day. For example, an order placed at 11 AM today will begin printing tomorrow, whereas an order placed at 9 PM tonight will begin printing the day after tomorrow.


Unfortunately, due to several restrictions, we are unable to ship to the following countries:

  1. Afghanistan
  2. American Samoa
  3. Belarus
  4. Brunei Darussalam
  5. Central African Republic
  6. The Democratic Republic of Congo
  7. Eritrea
  8. Guinea-bissau
  9. Iran
  10. Lebanon
  11. Libiya Arab Jamahriya
  12. Somalia
  13. Sudan
  14. Russian Federation
  15. Syrian Arab Republic
  16. Ukraine
  17. Venezuela