muscles-data-elasticsearch 0.1.0

Elasticsearch SearchIndexPort adapter for muscles-data

muscles-data-elasticsearch

Elasticsearch adapter package for muscles-data.

This package is intentionally separate from muscles-data: the core package owns typed ports, resource runtime and diagnostics, while this package owns the Elasticsearch-backed SearchIndexPort implementation.

Related packages

• Core runtime and port contracts: muscles-data
• OpenSearch search adapter: muscles-data-opensearch
• Redis key-value/lock/stream adapter: muscles-data-redis
• Qdrant vector adapter: muscles-data-qdrant
• MongoDB document-store adapter: muscles-data-mongodb
• S3 object-store adapter: muscles-data-s3
• SQLAlchemy direct SQL resource adapter: muscles-data-sqlalchemy
• Executable example: example_data_elasticsearch_1

Usage

Register the factory in the project composition root:

from muscles_data.catalog import DataAdapterCatalog
from muscles_data.ports import SearchIndexPort
from muscles_data.runtime import DataRuntime
from muscles_data_elasticsearch import ElasticsearchSearchFactory

catalog = DataAdapterCatalog.with_defaults()
catalog.register(ElasticsearchSearchFactory())

runtime = DataRuntime(config=config, catalog=catalog)
search = runtime.require_port("search.elastic", SearchIndexPort)

Resource config stays in the project:

data:
  resources:
    search.elastic:
      type: elasticsearch
      url_env: ELASTICSEARCH_URL
      api_key: ${ELASTICSEARCH_API_KEY}
      index: docs
      timeout: 3
      verify_certs: true

The adapter creates the Elasticsearch client and index lazily on search, index/delete, explicit native access or data.doctor. Application code should use SearchIndexPort; direct client access is only an advanced escape hatch with native_client: true.

Missing indexes are created with a default mapping for text, title and metadata; mapping and settings resource options can customize it. upsert_documents() uses Elasticsearch bulk operations.

See muscular-example/example_data_elasticsearch_1 for an executable example.