Quickstart

Install

uv add oridecon-search

For a specific backend, install with extras:

# MeiliSearch (default)
uv add "oridecon-search[meilisearch]"
# Elasticsearch
uv add "oridecon-search[elasticsearch]"
# PostgreSQL full-text
uv add "oridecon-search[postgres]"
# All backends
uv add "oridecon-search[search-all]"

Minimal Example

import asyncio

from oridecon import Application, OrideconConfig
from oridecon.search import SearchProvider, SearchConfig
from oridecon.search.config import BackendType


async def main():
    config = OrideconConfig.from_yaml("application.yaml")
    app = Application(name="my-app", config=config)
    app.add_provider(SearchProvider.with_memory())

    async with app.boot():
        # Resolve the search engine
        from oridecon.contracts.search import SearchEngineProtocol

        engine = await app.container.resolve(SearchEngineProtocol)

        # Index a document
        await engine.index_document("doc-1", {"title": "Hello world", "content": "Oridecon search works"})

        # Search
        result = await engine.search("hello")
        print(f"Found {result.total} result(s)")
        for hit in result.results:
            print(f"  - {hit.data['title']} (score: {hit.score})")


asyncio.run(main())

Wiring

Add SearchProvider to your Application. The provider auto-discovers SearchConfig from the search: section of your YAML config:

from oridecon.search import SearchProvider

app.add_provider(SearchProvider.configure(SearchConfig(
    backend_type=BackendType.MEILISEARCH,
)))

Or use the declarative SearchModule:

from oridecon.search import SearchModule
from oridecon.search.config import SearchConfig

app.add_module(SearchModule.configure(SearchConfig(backend_type="meilisearch")))

Next Steps

Guide — mental model, core concepts, best practices
Configuration — every config key with defaults and env vars
How-Tos — common recipes