migrate2vespa
A schema migration planner for Vespa, currently supporting Elasticsearch and OpenSearch.
Given a mapping—and optionally settings, sample documents, and representative queries—it:
- Creates a migration manifest showing how each field and configuration maps
to Vespa, with every decision classified as
DIRECT,ADAPT,REVIEW, orREDESIGN. - Generates a starter Vespa application for the parts of the schema that can be converted safely.
The tool works entirely from local files. It makes no network connections or LLM calls.
Built by Searchplex.
Quickstart
Requires Python 3.11–3.13.
python3 -m pip install migrate2vespa
migrate2vespa ./es-app
Results go to ./es-app/out/ by default. Try the fixture:
git clone https://github.com/searchplexai/migrate2vespa.git
cd migrate2vespa
python3 -m pip install -e .
migrate2vespa fixtures/quickstart
On success, the tool prints the command for deploying the generated app.
Input
es-app/
├── mapping.json # required
├── settings.json # optional analysis settings
├── documents.jsonl # optional representative documents
└── queries/ # optional _search request bodies
Use the filenames shown above. Documents may use Elasticsearch's _id and
_source format or a plain id field.
Queries help the tool understand how fields are used. They are not converted to YQL.
Run one index at a time. Passing mapping.json directly runs without settings,
documents, or queries.
Output
es-app/out/
├── migration-manifest.yaml
└── vespa-app/ # absent when generation is blocked or skipped
├── services.xml
├── schemas/<schema>.sd
└── feed/documents.jsonl
The manifest explains what the tool found, what it converted, and what still needs attention.
The Vespa app is generated when it is safe to do so. Unsupported fields may be left out and listed in the manifest. If that would make the app unsafe, generation stops.
See docs/overview.md for more detail.
Supported
| Surface | Behavior |
|---|---|
| Fields | text, keyword, boolean, integer, long, float, double, recognized date, float dense_vector without explicit index_options, and OpenSearch knn_vector without a method definition |
| Adaptations | Multi-fields, observed arrays and scalar objects, lowercase normalizers, supported dates and vectors; ignore_above on keyword multi-fields |
| Query evidence | match, match_phrase, multi_match, term, terms, range, sort, basic aggregations, knn; custom scoring → redesign |
Unrecognized constructs are recorded, not guessed.
Default text fields use Vespa's linguistics, which can differ from Elasticsearch's
standard analyzer; the manifest records this caveat.
Custom and non-default built-in analyzers need a Vespa linguistics decision;
the tool does not silently generate an equivalent analyzer. For OpenSearch
knn_vector, include settings with index.knn: true to establish ANN indexing.
OpenSearch method definitions require review.
Elasticsearch vector index_options also require review; the tool does not
translate the declared vector indexing configuration.
With copy_to, source fields remain available but the copied destination is
left out until its behavior is designed.
CLI
migrate2vespa ./es-app --analyze-only
migrate2vespa ./es-app --output ./migration-work
migrate2vespa generate ./es-app/out/migration-manifest.yaml
Exit codes are 0 for success, 2 for invalid input, 3 when generation is
blocked, and 1 for an unexpected error.
Development
python3 -m pip install -e '.[dev]'
python3 -m pytest -q
scripts/validate-with-vespa-docker.sh # needs Docker + Vespa CLI
See CONTRIBUTING.md.
Copyright © 2026 Searchplex. Licensed under the Apache License 2.0.
Metadata
Release files for migrate2vespa 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| migrate2vespa-0.1.1.tar.gz | 75.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| migrate2vespa-0.1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 139.4 kB
Release files / migrate2vespa-0.1.1.tar.gz
| Download URL | migrate2vespa-0.1.1.tar.gz |
|---|---|
| Size | 75.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cf30d9f46afdfc4f3ff811a9f3cde9d3887fc5722289c2ce18ceb4223016889c
|
|
BLAKE2b-256 checksum How to use checksums |
5fdce410b02d54f4beb20911a0d4b31a5bcf46b8e1f1d523d2bab84237897b55
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.
Transparency logRelease files / migrate2vespa-0.1.1-py3-none-any.whl
| Download URL | migrate2vespa-0.1.1-py3-none-any.whl |
|---|---|
| Size | 64.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
900935b7d68612c399477b8ea220eccaac6d7d57535ef68c91012e3c4de14620
|
|
BLAKE2b-256 checksum How to use checksums |
ba341e59eea3be94987e6c16b2d8b05be058336e085ae0fe80380e33ac0c1703
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.
Transparency log