# custom-codecs

**Repository Path**: mirrors_dblock/custom-codecs

## Basic Information

- **Project Name**: custom-codecs
- **Description**: OpenSearch custom lucene codecs for providing different on-disk index encoding (e.g., compression).
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-07-10
- **Last Updated**: 2026-05-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Backward Compatibility Checks](https://github.com/opensearch-project/custom-codecs/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/opensearch-project/custom-codecs/actions/workflows/ci.yml)
[![Publish snapshots to maven](https://github.com/opensearch-project/custom-codecs/actions/workflows/publish-maven-snapshots.yml/badge.svg?branch=main)](https://github.com/opensearch-project/custom-codecs/actions/workflows/publish-maven-snapshots.yml)

# Custom Codecs
Custom Codecs plugin makes it possible for users to provide custom Lucene codecs for loading through Apache Lucene's `NamedSPILoader`.
These codecs can be used to customize the on-disk representation of the opensearch indexes. For example, zstd compression can be used for
`StoredField` types through the `ZstdCodec`.

## Security

See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.

## License

This project is licensed under the Apache-2.0 License.