muscles-data-opensearch 0.1.0

OpenSearch SearchIndexPort adapter for muscles-data

muscles-data-opensearch

OpenSearch 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 OpenSearch-backed SearchIndexPort implementation.

Related packages

• Core runtime and port contracts: muscles-data
• Elasticsearch search adapter: muscles-data-elasticsearch
• 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_opensearch_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_opensearch import OpenSearchSearchFactory

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

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

Resource config stays in the project:

data:
  resources:
    search.public:
      type: opensearch
      url: ${OPENSEARCH_URL}
      username: ${OPENSEARCH_USER}
      password: ${OPENSEARCH_PASSWORD}
      index: docs
      timeout: 3
      verify_certs: true

The adapter creates the OpenSearch client and a missing index lazily on search, index/delete, explicit native access or data.doctor. New indexes receive a default mapping for text, title and metadata; mapping and settings resource options customize it. Application code should use SearchIndexPort; direct client access is only an advanced escape hatch with native_client: true.

See muscular-example/example_data_opensearch_1 for an executable example.