Migration Guide

Migrate from any search provider to Skirre. Whether you're coming from Algolia, Meilisearch, Typesense, Elasticsearch, or a platform's built-in search, the process is straightforward.

Overview

Skirre is designed to be easy to migrate to. The API follows familiar patterns from other search engines: you create an index, push documents, configure settings, and search. Most concepts from other providers map directly to Skirre equivalents.

AI-Assisted Migration

The fastest way to migrate is with an AI assistant. Skirre provides a comprehensive API reference document designed specifically for AI consumption. Feed it to your AI assistant alongside your migration request, and it can generate the correct migration code for your specific setup.

AI migration reference
The full reference is available in two places:
  • In the SDK package: After installing @skirre/sdk, the file is at node_modules/@skirre/sdk/docs/migration.md
  • Via URL: Fetch https://www.skirre.com/llms.txt — this is a machine-readable reference following the llms.txt convention

Example prompt for your AI assistant:

text
I'm migrating from Algolia to Skirre. Here's my current setup:
- 3 indices: products, blog_posts, help_articles
- Using instantsearch.js on the frontend
- Filters on category, price, brand
- Synonyms configured for product terms

Please read the Skirre migration reference at node_modules/@skirre/sdk/docs/migration.md
and generate the migration script.

Your AI already knows the source platform. It only needs accurate knowledge of Skirre's API surface, which the reference document provides in full.

Concept Mapping

Core concepts map across all search providers:

ConceptSkirreNotes
Index / Collectionskirre.index('uid')Created with field configuration
Documentsindex.addDocuments()Schemaless JSON, upsert by primary key
Searchindex.search(query, params)Filter string, facets, sort, highlights
Searchable fieldssearchable_attributesWith per-field weights and language
Facet fieldsfilterable_attributesWith field type (string/number/boolean)
Sort fieldssortable_attributesArray of field names
Synonymssettings.synonymsOne-directional key → values map
Scoped keysTenant tokensHMAC-signed with per-index filter restrictions
Async writesTask systemAll writes return TaskInfo, poll for completion

Step-by-Step Process

  1. Get an API key — create an admin key from the dashboard or via API
  2. Map your schema — identify which fields are searchable, filterable, and sortable in your current provider and translate them to Skirre's field configuration
  3. Create the index — with your field config and primary key
  4. Configure settings — synonyms, typo tolerance, semantic search, language
  5. Transform documents — map your source format to flat JSON objects with the configured field names
  6. Batch upload — chunk documents into batches of 500–1000, use addDocumentsAndWait()
  7. Verify — test searches, check facets, confirm document count
  8. Switch search calls — update your frontend/backend to use the Skirre SDK
  9. Add event tracking — integrate click, purchase, and page view events
  10. Set up aliases — for zero-downtime reindexing in the future

Platform-Specific Notes

From Algolia

  • Filter syntax differs: Algolia uses facetFilters arrays, Skirre uses a string expression (category = "Electronics" AND price > 100)
  • Pagination is offset-based, not page-based. Convert: offset = page * hitsPerPage
  • All writes are async — use *AndWait() methods for migration scripts
  • Replicas → create separate indices with different sort configurations + aliases

From Meilisearch

  • Very similar API shape — task system, filter syntax, and SDK patterns are close
  • Field config is set at index creation time (or via settings update) rather than separate per-setting API calls
  • Searchable field weights replace Meilisearch's ordered list priority

From Typesense

  • Typesense requires a strict schema; Skirre configures which fields to index but documents are schemaless JSON
  • Filter syntax differs: Typesense uses field:value, Skirre uses field = "value"

From Elasticsearch / OpenSearch

  • No Query DSL — Skirre uses simple string filters, not nested JSON query objects
  • Facets are count-based only (no aggregation pipeline)
  • Aliases work the same conceptually — zero-downtime index swaps
Full reference
For complete type definitions, endpoint details, and migration code examples, see the AI migration reference or node_modules/@skirre/sdk/docs/migration.md.