Загрузка laravelsolr - Загрузка исходного кода laravelsolr

laravelsolr

Ларавел-Сольр

Пакет Laravel для бесшовной интеграции с Apache Solr, предоставляющий простые в использовании команды для управления ядром и удобный интерфейс для операций Solr.

Функции

Создание, обновление и удаление ядер Solr с помощью ремесленных команд.
Управляйте полями Solr с отношениями родитель-потомок
Свободный интерфейс построения запросов для поиска Solr
Поддержка отношений между родительскими и дочерними документами.
Объединения между коллекциями
Возможности фасетного поиска
Полное тестовое покрытие

Установка

composer require haiderjabbar/laravelsolr:dev-main

Добавьте поставщика услуг в свой config/app.php :

 ' providers ' => [
    // ...
    HaiderJabbar  LaravelSolr  LaravelSolrServiceProvider ::class,
];

Вам следует опубликовать файл конфигурации config/solr.php с помощью:

php artisan vendor:publish --provider= " HaiderJabbarLaravelSolrLaravelSolrServiceProvider "

Доступные команды

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

# 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

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

# Update existing Solr core fields
php artisan solr:update-fields

# Delete fields from a Solr core
php artisan solr:delete-fields

Основное использование

Добавление документов

 use HaiderJabbar  LaravelSolr  Models  SolrModel ;

$ coreName = ' your_core_name ' ;
$ data = [
    ' id ' => ' unique_id ' ,
    ' name ' => ' document_name ' ,
    // ... other fields
];

$ result = SolrModel :: addDocument ( $ coreName , $ data );

Обновление документов

 $ result = SolrModel :: updateDocument ( $ coreName , $ data );

Удаление документов

 $ result = SolrModel :: deleteDocumentById ( $ coreName , $ id );

Операции с родительскими и дочерними документами

 // Add child documents to a parent
$ result = SolrModel :: addChildToParent ( $ coreName , $ parentId , " child " , $ childData );

Пример контроллера

 use HaiderJabbar  LaravelSolr  Services  SolrQueryBuilder ;
use Illuminate  Http  Request ;
use HaiderJabbar  LaravelSolr  Models  SolrModel ;


class SolrController extends Controller
{
    public function addDocument ( Request $ request )
    {
        $ coreName = ' testCore ' ;
        $ data = [
            ' id ' => 1 ,
            ' name ' => ' name '
        ];
    
        $ result = SolrModel :: addDocument ( $ coreName , $ data );
    
        return $ result
            ? response ()-> json ([ ' message ' => ' Document added successfully ' ])
            : response ()-> json ([ ' message ' => ' Failed to add document ' ], 500 );
    }

    public function addChildDocument ( Request $ request , $ parentId )
    {
        $ coreName = ' testCore ' ;
        $ childData = $ request -> input ( ' childData ' );
        
        $ result = SolrModel :: addChildToParent ( $ coreName , $ parentId , " child " , $ childData );

        if ( $ result ) {
            return response ()-> json ([ ' message ' => ' Child documents added successfully ' ]);
        }
        return response ()-> json ([ ' message ' => ' Failed to add child documents ' ], 500 );
    }
}

Конструктор запросов

laravelsolr предоставляет мощный и гибкий интерфейс для построения запросов Solr с помощью класса SolrQueryBuilder :

Основное использование

 use HaiderJabbar  LaravelSolr  Services  SolrQueryBuilder ;

$ builder = new SolrQueryBuilder ( $ coreName );

Методы поиска

 // Basic search
$ builder -> search ( ' field ' , ' = ' , ' value ' , $ boost );

// OR search condition
$ builder -> orSearch ( ' field ' , ' value ' , $ boost );

// Where clause
$ builder -> where ( ' field ' , ' = ' , ' value ' , $ priority );

// OR where clause
$ builder -> orWhere ( ' field ' , ' = ' , ' value ' , $ priority );

// WHERE IN clause
$ builder -> whereIn ( ' field ' , [ ' value1 ' , ' value2 ' ]);

// Filter (fq parameter)
$ builder -> filter ( ' field ' , ' = ' , ' value ' );

Доступные операторы:

= Точное совпадение
!= Не равно
< Меньше чем
> Больше, чем
<= Меньше или равно
>= Больше или равно
like Содержит
in В массиве значений

Сортировка и нумерация страниц

 $ builder
    -> sort ( ' field asc ' )    // Add sorting
    -> start ( 0 )             // Starting offset (pagination)
    -> rows ( 10 );            // Number of rows to return

Выбор поля

 $ builder -> fl ([ ' field1 ' , ' field2 ' , ' score ' ]); // Select specific fields to return

Запросы родительско-дочерних документов

 // Get parent with child
$ builder
    -> whereParent ( ' id ' , ' = ' , ' parent_id ' , 20 )
    -> returnBothParentAndChild ()
    -> get ();

// Get only children
$ builder
    -> whereParent ( ' id ' , ' = ' , ' parent_id ' , 20 )
    -> returnOnlyChild ()
    -> fl ([ ' * ' , ' score ' ])
    -> get ();

// Get parent only
$ builder
    -> whereParent ( ' id ' , ' = ' , ' parent_id ' , 20 )
    -> returnOnlyParent ()
    -> get ();

// Query where parent and child
$ builder
    -> whereParent ( ' id ' , ' = ' , ' parent_id ' , 20 )
    -> whereChild ( ' childId ' , ' = ' , ' child_id ' , 20 )
    -> get ();

Межколлекционные соединения

 // Simple join
$ builder -> crossCollectionJoin (
    ' otherCore ' ,           // From index
    ' fromField ' ,          // Field in from index
    ' toField ' ,            // Field in current index
    ' field:value '         // Optional query
);

// Complex join with conditions
$ builder -> whereJoin ( ' otherCore ' , ' fromField ' , ' toField ' , function ( $ q ) {
    $ q -> where ( ' field1 ' , ' = ' , ' value1 ' )
      -> where ( ' field2 ' , ' = ' , ' value2 ' );
});

// Cross collection join example
$ result = $ builder
    -> whereParent ( ' id ' , ' = ' , ' parent_id ' , 20 )
    -> whereJoin ( ' otherCore ' , ' id ' , ' id ' , function ( $ q ) {
        $ q -> where ( " id " , " = " , " value1 " , 20 )
         -> where ( " id " , " = " , " value2 " , 20 );
    })
    -> returnBothParentAndChild ()
    -> getWithJoinedDocuments ( " otherCore " , " id " , " id " );

Фасетный поиск

 // Basic faceted search
$ builder
    -> facet ( true )
    -> facetFields ([ ' field1 ' , ' field2 ' ])
    -> get ();

// Complex faceted search
$ builder
    -> whereParent ( ' id ' , ' = ' , ' parent_id ' , 20 )
    -> whereChild ( ' childId ' , ' = ' , ' child_id ' , 20 )
    -> facetFields ([ ' id ' ])
    -> facet ( true )
    -> fl ([ ' * ' , ' score ' ])
    -> get ();

Выполнение запроса

 // Basic query execution
$ results = $ builder -> get ();

// Get results with facets
$ results = $ builder -> getWithFacets ();

// Get results with joined documents
$ results = $ builder -> getWithJoinedDocuments ( ' otherCore ' , ' fromId ' , ' toId ' );

Полный пример

 $ builder = new SolrQueryBuilder ( $ coreName );

$ results = $ builder
    -> whereParent ( ' category ' , ' = ' , ' electronics ' , 20 )
    -> whereChild ( ' price ' , ' >= ' , 100 )
    -> facet ( true )
    -> facetFields ([ ' brand ' , ' color ' ])
    -> sort ( ' price desc ' )
    -> start ( 0 )
    -> rows ( 20 )
    -> fl ([ ' id ' , ' name ' , ' price ' , ' score ' ])
    -> returnBothParentAndChild ()
    -> get ();

Конфигурация среды

Обязательно укажите URL-адрес Solr в файле .env :

 SOLR_URL = http://localhost:8983/solr

Структура каталогов

 laravelsolr/
├── src/
│   ├── Console/Commands/
│   │   ├── CreateSolrCore.php
│   │   ├── CreateSolrFields.php
│   │   ├── DeleteSolrCore.php
│   │   ├── DeleteSolrFields.php
│   │   ├── UpdateSolrCore.php
│   │   └── UpdateSolrFields.php
│   ├── Models/
│   │   └── SolrModel.php
│   ├── Schema/
│   │   └── SolrSchemaBuilder.php
│   ├── Services/
│   │   ├── CoreSolrService.php
│   │   ├── FieldsSolrService.php
│   │   └── SolrQueryBuilder.php
│   ├── laravelsolr.php
│   ├── LaravelSolrServiceProvider.php
│   └── SolrServiceProvider.php
└── tests/
    └── Unit/
        ├── Console/Commands/
        ├── Models/
        └── Services/

Тестирование

Пакет включает в себя комплексные тесты для всех функций. Чтобы запустить тесты:

vendor/bin/phpunit

Содействие

Вклады приветствуются! Пожалуйста, не стесняйтесь отправить запрос на включение.

Лицензия

Этот пакет представляет собой программное обеспечение с открытым исходным кодом, лицензированное по лицензии MIT.

Расширять