Metadata-Version: 2.4
Name: muscles-data-elasticsearch
Version: 0.2.0
Summary: Elasticsearch SearchIndexPort adapter for muscles-data
Author-email: "Denis B." <denis@butko.info>
Project-URL: Homepage, https://github.com/butkoden/muscles-data-elasticsearch
Project-URL: Repository, https://github.com/butkoden/muscles-data-elasticsearch
Project-URL: Documentation, https://github.com/butkoden/muscles-data-elasticsearch#readme
Project-URL: PyPI, https://pypi.org/project/muscles-data-elasticsearch/
Project-URL: Releases, https://github.com/butkoden/muscles-data-elasticsearch/releases
Project-URL: muscles-data, https://pypi.org/project/muscles-data/
Project-URL: muscles-data-opensearch, https://pypi.org/project/muscles-data-opensearch/
Project-URL: muscles-data-qdrant, https://pypi.org/project/muscles-data-qdrant/
Project-URL: muscles-data-redis, https://pypi.org/project/muscles-data-redis/
Project-URL: muscles-data-mongodb, https://pypi.org/project/muscles-data-mongodb/
Project-URL: muscles-data-s3, https://pypi.org/project/muscles-data-s3/
Project-URL: muscles-data-sqlalchemy, https://pypi.org/project/muscles-data-sqlalchemy/
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: muscles-data<1.0.0,>=0.2.0
Requires-Dist: elasticsearch<9.0,>=8.0
Provides-Extra: dev
Requires-Dist: pytest<9.0,>=8.0; extra == "dev"

# 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`](https://github.com/butkoden/muscles-data)
- OpenSearch search adapter:
  [`muscles-data-opensearch`](https://github.com/butkoden/muscles-data-opensearch)
- Redis key-value/lock/stream adapter:
  [`muscles-data-redis`](https://github.com/butkoden/muscles-data-redis)
- Qdrant vector adapter:
  [`muscles-data-qdrant`](https://github.com/butkoden/muscles-data-qdrant)
- MongoDB document-store adapter:
  [`muscles-data-mongodb`](https://github.com/butkoden/muscles-data-mongodb)
- S3 object-store adapter:
  [`muscles-data-s3`](https://github.com/butkoden/muscles-data-s3)
- SQLAlchemy direct SQL resource adapter:
  [`muscles-data-sqlalchemy`](https://github.com/butkoden/muscles-data-sqlalchemy)
- Executable example:
  [`example_data_elasticsearch_1`](https://github.com/butkoden/muscular-example/tree/master/example_data_elasticsearch_1)

## Usage

For application, register this adapter once when `App` builds
its shared `DataAdapterCatalog`, alongside `NativeSqlFactory` and any other
configured adapters:

```python
catalog.register(ElasticsearchSearchFactory())
```

The `search.elastic` resource itself is declared in the application's central
`data.resources` configuration shown below. A package resolves the port from
the existing runtime; it does not build another catalog or `DataRuntime`:

```python
from muscles.data.ports import SearchIndexPort

search = app.resource.connect("search.elastic", SearchIndexPort)
```

Resource config stays in the project:

```yaml
data:
  resources:
    search.elastic:
      type: elasticsearch
      url_env: ELASTICSEARCH_URL
      api_key: !environ 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.
