README

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

SEAL
Typesense Adapter

The TypesenseAdapter write the documents into a Typesense server instance.

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

Installation

Use composer for install the package:

composer require cmsig/seal cmsig/seal-typesense-adapter

Usage.

The following code shows how to create an Engine using this Adapter:

<?php

use Http\Client\Curl\Client as CurlClient;
use Http\Discovery\Psr17FactoryDiscovery;
use CmsIg\Seal\Adapter\Typesense\TypesenseAdapter;
use CmsIg\Seal\Engine;
use Typesense\Client;

$client = new Client(
    [
        'api_key' => 'S3CR3T',
        'nodes' => [
            [
                'host' => '127.0.0.1',
                'port' => '8108',
                'protocol' => 'http',
            ],
        ],
        'client' => new CurlClient(Psr17FactoryDiscovery::findResponseFactory(), Psr17FactoryDiscovery::findStreamFactory()),
    ]
);

$engine = new Engine(
    new TypesenseAdapter($client),
    $schema,
);

Via DSN for your favorite framework:

typesense://S3CR3T@127.0.0.1:8108

Or with TLS enabled (uses https and defaults to port 443):

typesense://S3CR3T@127.0.0.1?tls=true
typesense://S3CR3T@127.0.0.1:443?tls=true

Authors

• Alexander Schranz
• The Community Contributors