Search icon CANCEL
Subscription
0
Cart icon
Your Cart (0 item)
Close icon
You have no products in your basket yet
Save more on your purchases! discount-offer-chevron-icon
Savings automatically calculated. No voucher code required.
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
€19.99 €22.99
Paperback
€28.99
Subscription
Free Trial
Renews at $19.99p/m

What do you get with a Packt Subscription?

Free for first 7 days. $19.99 p/m after that. Cancel any time!
Product feature icon Unlimited ad-free access to the largest independent learning library in tech. Access this title and thousands more!
Product feature icon 50+ new titles added per month, including many first-to-market concepts and exclusive early access to books as they are being written.
Product feature icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Product feature icon Thousands of reference materials covering every tech concept you need to stay up to date.
Subscribe now
View plans & pricing
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

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 a Packt Subscription?

Free for first 7 days. $19.99 p/m after that. Cancel any time!
Product feature icon Unlimited ad-free access to the largest independent learning library in tech. Access this title and thousands more!
Product feature icon 50+ new titles added per month, including many first-to-market concepts and exclusive early access to books as they are being written.
Product feature icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Product feature icon Thousands of reference materials covering every tech concept you need to stay up to date.
Subscribe now
View plans & pricing

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 57.98
Apache Solr PHP Integration
€28.99
Administrating Solr
€28.99
Total 57.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 included in a Packt subscription? Chevron down icon Chevron up icon

A subscription provides you with full access to view all Packt and licnesed content online, this includes exclusive access to Early Access titles. Depending on the tier chosen you can also earn credits and discounts to use for owning content

How can I cancel my subscription? Chevron down icon Chevron up icon

To cancel your subscription with us simply go to the account page - found in the top right of the page or at https://subscription.packtpub.com/my-account/subscription - From here you will see the ‘cancel subscription’ button in the grey box with your subscription information in.

What are credits? Chevron down icon Chevron up icon

Credits can be earned from reading 40 section of any title within the payment cycle - a month starting from the day of subscription payment. You also earn a Credit every month if you subscribe to our annual or 18 month plans. Credits can be used to buy books DRM free, the same way that you would pay for a book. Your credits can be found in the subscription homepage - subscription.packtpub.com - clicking on ‘the my’ library dropdown and selecting ‘credits’.

What happens if an Early Access Course is cancelled? Chevron down icon Chevron up icon

Projects are rarely cancelled, but sometimes it's unavoidable. If an Early Access course is cancelled or excessively delayed, you can exchange your purchase for another course. For further details, please contact us here.

Where can I send feedback about an Early Access title? Chevron down icon Chevron up icon

If you have any feedback about the product you're reading, or Early Access in general, then please fill out a contact form here and we'll make sure the feedback gets to the right team. 

Can I download the code files for Early Access titles? Chevron down icon Chevron up icon

We try to ensure that all books in Early Access have code available to use, download, and fork on GitHub. This helps us be more agile in the development of the book, and helps keep the often changing code base of new versions and new technologies as up to date as possible. Unfortunately, however, there will be rare cases when it is not possible for us to have downloadable code samples available until publication.

When we publish the book, the code files will also be available to download from the Packt website.

How accurate is the publication date? Chevron down icon Chevron up icon

The publication date is as accurate as we can be at any point in the project. Unfortunately, delays can happen. Often those delays are out of our control, such as changes to the technology code base or delays in the tech release. We do our best to give you an accurate estimate of the publication date at any given time, and as more chapters are delivered, the more accurate the delivery date will become.

How will I know when new chapters are ready? Chevron down icon Chevron up icon

We'll let you know every time there has been an update to a course that you've bought in Early Access. You'll get an email to let you know there has been a new chapter, or a change to a previous chapter. The new chapters are automatically added to your account, so you can also check back there any time you're ready and download or read them online.

I am a Packt subscriber, do I get Early Access? Chevron down icon Chevron up icon

Yes, all Early Access content is fully available through your subscription. You will need to have a paid for or active trial subscription in order to access all titles.

How is Early Access delivered? Chevron down icon Chevron up icon

Early Access is currently only available as a PDF or through our online reader. As we make changes or add new chapters, the files in your Packt account will be updated so you can download them again or view them online immediately.

How do I buy Early Access content? Chevron down icon Chevron up icon

Early Access is a way of us getting our content to you quicker, but the method of buying the Early Access course is still the same. Just find the course you want to buy, go through the check-out steps, and you’ll get a confirmation email from us with information and a link to the relevant Early Access courses.

What is Early Access? Chevron down icon Chevron up icon

Keeping up to date with the latest technology is difficult; new versions, new frameworks, new techniques. This feature gives you a head-start to our content, as it's being created. With Early Access you'll receive each chapter as it's written, and get regular updates throughout the product's development, as well as the final course as soon as it's ready.We created Early Access as a means of giving you the information you need, as soon as it's available. As we go through the process of developing a course, 99% of it can be ready but we can't publish until that last 1% falls in to place. Early Access helps to unlock the potential of our content early, to help you start your learning when you need it most. You not only get access to every chapter as it's delivered, edited, and updated, but you'll also get the finalized, DRM-free product to download in any format you want when it's published. As a member of Packt, you'll also be eligible for our exclusive offers, including a free course every day, and discounts on new and popular titles.