Laravel Idea for PhpStorm - Full-featured IDE for productive artisans!

Laravel Solr

Published on by

Laravel Solr image

If you have ever had a need to implement search into your application you've probably heard of Apache Solr. Solr is a fast, open source search platform built on the full-text, vector, and geospatial search capabilities of Apache Lucene.

Developer Haider Jabbar Abdullah has built a package called Laravel-Solr to provide a seamless integration with Apache Solr. This will allow Laravel developers to efficiently utilize Solr’s powerful search capabilities right in their applications.

Key Features

  • Easy installation and setup
  • Comprehensive methods for indexing and searching
  • Built-in support for common use cases
  • Well-documented and user-friendly

To install this package, run:

composer require haiderjabbar/laravelsolr

Next, add the service provider to your config/app.php:

'providers' => [
// ...
haiderjabbar\laravelsolr\LaravelSolrServiceProvider::class,
];

You should also publish the config/solr.php config file with:

php artisan vendor:publish --provider="haiderjabbar\laravelsolr\LaravelSolrServiceProvider"

Once you have this setup, you will want to create a core (if one does not already exist). In Solr, the term core is used to refer to a single index and associated transaction log. You can have multiple cores if needed and in doing so it will allow you to index data with different structures in the same server. This can also give you more control over how your data is presented to different audiences.

# Create a new Solr core and migration file
php artisan solr:create-core coreName

Now you can begin to add documents. Documents are Solr’s basic unit of information and it is just a set of data that describes something. So a document about a book could contain the title, author, year of publication, number of pages, and so on. When you add a document, Solr takes that information and adds it to an index. When you perform a query, Solr can quickly consult the index and return the matching documents.

We will need to define the fields that our documents will have and to do so we can run:

# Create new Solr fields with optional parent and fields
php artisan solr:create-fields coreName

This command will allow you to specify the name, type and whether or not the field is multi-valued, should be required or indexed.

When you have defined your fields you can begin to add a documents and to do so you could write:

use haiderjabbar\laravelsolr\Models\SolrModel;
 
$coreName = 'your_core_name';
$data = [
'id' => 'unique_id',
'name' => 'document_name',
// ... other fields
];
 
$result = SolrModel::addDocument($coreName, $data);

The Laravel-Solr package also comes with a QueryBuilder which allows you to have a familiar interface to search and return documents.

use haiderjabbar\laravelsolr\Services\SolrQueryBuilder;
 
$builder = new SolrQueryBuilder($coreName);
 
// Basic search
$builder->search('field', '=', 'value', $boost);
 
// Where clause
$builder->where('field', '=', 'value', $priority);
 
// Sort and Paginate
$builder
->sort('field asc') // Add sorting
->start(0) // Starting offset (pagination)
->rows(10); // Number of rows to return
 
$results = $builder->get();

Additional Commands

# Update a Solr core with a new name
php artisan solr:update-core
 
# Delete a Solr core and its migration file
php artisan solr:delete-core coreName
 
# Update existing Solr core fields
php artisan solr:update-fields
 
# Delete fields from a Solr core
php artisan solr:delete-fields

You can learn more about this package and view the source code on Github.

Yannick Lyn Fatt photo

Research Assistant at Laravel News and Full stack web developer.

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $7500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
Lucky Media logo

Lucky Media

Get Lucky Now - the ideal choice for Laravel Development, with over a decade of experience!

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
LaraJobs logo

LaraJobs

The official Laravel job board

LaraJobs
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Multi-tenant Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
Supercharge Your SaaS Development with FilamentFlow: The Ultimate Laravel Filament Boilerplate logo

Supercharge Your SaaS Development with FilamentFlow: The Ultimate Laravel Filament Boilerplate

Build your SaaS application in hours. Out-of-the-box multi-tenancy and seamless Stripe integration. Supports subscriptions and one-time purchases, allowing you to focus on building and creating without repetitive setup tasks.

Supercharge Your SaaS Development with FilamentFlow: The Ultimate Laravel Filament Boilerplate
Rector logo

Rector

Your partner for seamless Laravel upgrades, cutting costs, and accelerating innovation for successful companies

Rector
MongoDB logo

MongoDB

Enhance your PHP applications with the powerful integration of MongoDB and Laravel, empowering developers to build applications with ease and efficiency. Support transactional, search, analytics and mobile use cases while using the familiar Eloquent APIs. Discover how MongoDB's flexible, modern database can transform your Laravel applications.

MongoDB

The latest

View all →
Laravel Solr image

Laravel Solr

Read article
A Guide to Pagination in Laravel image

A Guide to Pagination in Laravel

Read article
Laravel Roundup - November image

Laravel Roundup - November

Read article
Bento Laravel SDK image

Bento Laravel SDK

Read article
Laravel 11.30 Released image

Laravel 11.30 Released

Read article
Bluesky notification channel for Laravel image

Bluesky notification channel for Laravel

Read article