schranz-search/spiral-bridge

An integration of schranz-search search abstraction into Spiral Framework.

Maintainers

Details

github.com/schranz-search/spiral-bridge

Source

Fund package maintenance!
alexander-schranz
paypal.me/L91

Installs: 41

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

0.5.0 2024-09-24 11:30 UTC

Requires

Requires (Dev)

Conflicts

MIT f00a01cd6a4c07c6857f8c26a12d38d3f4832e0a

  • Alexander Schranz <alexander.woop@sulu.io>

abstractionsolrsearchmoduleelasticsearchBridgeintegrationopensearchalgoliaredisearchmeilisearchtypesenseschranz-searchsearch-clientsearch-abstractionspiral-bridgesprialloupe

This package is auto-updated.

Last update: 2024-11-03 23:05:15 UTC

README

Schranz Search Logo with a Seal on it with a magnifying glass Logo created by Meine Wilma

SEAL
Spiral Integration



Integration of the Schranz Search — Search Engine Abstraction Layer (SEAL) into Spiral.

Note: This is part of the schranz-search/schranz-search project create issues in the main repository.

Note: This project is heavily under development and any feedback is greatly appreciated.

Installation

Use composer for install the package:

composer require schranz-search/spiral-bridge

Also install one of the listed adapters.

List of adapters

The following adapters are available:

Additional Wrapper adapters:

Creating your own adapter? Add the seal-php-adapter Topic to your Github Repository.

Usage

The following code shows how to configure the package:

<?php

// app/config/schranz_search.php

return [
    'schemas' => [
        'app' => [
            'dir' => 'app/schemas',
        ],
    ],
    'engines' => [
        'default' => [
            'adapter' => 'meilisearch://127.0.0.1:7700',
        ],
    ],
];

A more complex configuration can be here found:

<?php

// app/config/schranz_search.php

return [
    'schemas' => [
        'app' => [
            'dir' => 'app/schemas/app',
            'engine' => 'meilisearch',
        ],
        'other' => [
            'dir' => 'app/schemas/other',
            'engine' => 'algolia',
        ],
    ],
    'engines' => [
        'algolia' => [
            'adapter' => 'algolia://' . env('ALGOLIA_APPLICATION_ID') . ':' . env('ALGOLIA_ADMIN_API_KEY'),
        ],
        'elasticsearch' => [
            'adapter' => 'elasticsearch://127.0.0.1:9200',
        ],
        'meilisearch' => [
            'adapter' => 'meilisearch://127.0.0.1:7700',
        ],
        'memory' => [
            'adapter' => 'memory://',
        ],
        'opensearch' => [
            'adapter' => 'opensearch://127.0.0.1:9200',
        ],
        'redisearch' => [
            'adapter' => 'redis://supersecure@127.0.0.1:6379',
        ],
        'solr' => [
            'adapter' => 'solr://127.0.0.1:8983',
        ],
        'typesense' => [
            'adapter' => 'typesense://S3CR3T@127.0.0.1:8108',
        ],
        
        // ...
        'multi' => [
            'adapter' => 'multi://elasticsearch?adapters[]=opensearch',
        ],
        'read-write' => [
            'adapter' => 'read-write://elasticsearch?write=multi',
        ],
    ],
    'index_name_prefix' => '',
    'reindex_providers' => [
        \App\Search\BlogReindexProvider::class,
    ],
];

The default engine is available as Engine:

class Some {
    public function __construct(
        private readonly \Schranz\Search\SEAL\EngineInterface $engine,
    ) {
    }
}

Multiple engines can be accessed via the EngineRegistry:

class Some {
    private Engine $engine;

    public function __construct(
        private readonly \Schranz\Search\SEAL\EngineRegistry $engineRegistry,
    ) {
        $this->engine = $this->engineRegistry->get('algolia');
    }
}

How to create a Schema file and use your Engine can be found SEAL Documentation.

Commands

The package provides the following commands:

Create configured indexes

php app.php schranz:search:index-create --help

Drop configured indexes

php app.php schranz:search:index-drop --help

Authors