Question 1

How do I install and configure SearchSync with Algolia?

Accepted Answer

Install via npm or yarn in your Directus root, then create a .searchsyncrc file with type 'algolia', appId, and key. Use the CLI to reindex if needed, and restart Directus for automatic sync to take effect.

Question 2

Does SearchSync support real-time updates for all search engines?

Accepted Answer

Yes, it automatically syncs changes on Directus content events, but sync latency depends on the search engine's API and network conditions. For true real-time, ensure low-latency connections and monitor performance.

Question 3

SearchSync vs building a custom Directus hook for search indexing: which is better?

Accepted Answer

SearchSync offers a pre-built, configurable solution with multi-engine support, reducing development time. Custom hooks provide more control but require coding from scratch; choose SearchSync for standard engines and quick setup.

Question 4

How to handle large datasets with SearchSync without crashing?

Accepted Answer

Configure the batchLimit in your settings (e.g., 100 items per batch) to manage memory usage during indexing. Use the CLI reindex command for full rebuilds, and monitor Directus logs for any performance issues.

Question 5

Can SearchSync index relational data from Directus, like nested fields?

Accepted Answer

Yes, specify fields in dot notation (e.g., 'category.title') in the collections configuration. You can also use the transform function to flatten or customize relational data before indexing, as shown in the JS example.

Question 6

What happens if the search engine is down during indexing in SearchSync?

Accepted Answer

The README doesn't cover error handling; likely, indexing attempts will fail silently or throw errors. Developers need to implement retry logic or external monitoring, as SearchSync lacks built-in failure recovery mechanisms.

Search Sync

What is Search Sync?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions