Download the PHP package blomstra/search without Composer

On this page you can find all versions of the php package blomstra/search. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of blomstra/search

Informations about the package search

Search replaces the native Flarum search functionality which relies on MySQL badly performing fulltext search with one that is completely relying on the proven elasticsearch engine.

Features

Requirements

Installation

Enable the extension in the admin area and configure the Elasticsearch endpoint and index name in the extension settings.

Setting up the index

First install

Run the build command once. It creates a timestamped concrete index, immediately aliases your configured index name to it, and begins queuing documents. Search is available and improves as the queue processes:

Subsequent rebuilds (zero-downtime)

When you need to rebuild the full index (e.g. after a mapping change):

After the queue drains, fill any gaps from content posted during the build:

If you kept a backup and want to roll back:

Once satisfied with the new index, drop the backup:

Blue-green rebuild (manual promotion)

Use --staging to keep the old index live until you explicitly promote:

Resuming or cancelling an interrupted build

If a build is interrupted, re-run it with the appropriate flag:

Filling gaps in an existing index

If documents are missing from the live index (e.g. due to queue failures):

Updating the mapping only

To push a mapping change to the live index without rebuilding:

Command reference

Command Description
build Rebuild the index and promote automatically once all jobs are queued. On first install, aliases immediately so search is live during seeding.
build --keep-backup Rebuild and promote, retaining the old index as a backup for rollback.
build --staging Build into a staging index without promoting — use promote when ready (blue-green workflow).
build --resume Resume an interrupted build from where each seeder left off.
build --fresh Drop the staging index and start completely fresh.
promote Atomically swap the alias to the staging index. Prompts for confirmation (blue-green workflow).
promote --keep-backup Promote and retain the replaced live index as a backup for rollback.
rollback Restore the backup index to live. Deletes the index that was live.
discard --pending Drop the staging index without promoting (cancels an in-progress build).
discard --backup Drop the backup index (cleanup after --keep-backup).
mapping Push updated mapping to the live index without rebuilding or reseeding.
fill Seed only documents missing from the live index.
build --only=discussions Seed only the specified document type (discussions or posts).
build --throttle=N Wait N seconds between batches (reduces queue pressure).
build --max-id=N Limit seeding to documents with ID ≤ N.
promote --i-am-sure Skip the promotion confirmation prompt (for scripts and CI).

FAQ

Queue configuration

"Can I dispatch indexing jobs to a specific queue?"

Yes:

"I have a different question"

Reach out ot us via https://support.on-floxum.com/t/ext-search . If you have an active subscription, please mention what plan you are on.

Icon made by Freepik from Flaticon.

All versions of search with dependencies

PHP Build Version
Package Version
Requires php Version >= 8.0
flarum/core Version ^1.2.0
elasticsearch/elasticsearch Version 7.*
spatie/elasticsearch-query-builder Version ^1.3.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package blomstra/search contains the following files

Loading the files please wait ...