Skip to content

docs(readme): document Manticore Columnar Library workflows - #216

Open
donhardman wants to merge 4 commits into
masterfrom
doc/polish-readme
Open

donhardman wants to merge 4 commits into
masterfrom
doc/polish-readme

Conversation

@donhardman

Copy link
Copy Markdown
Member

README.md now provides comprehensive installation, build, usage, benchmark, release, and contribution documentation for Manticore Columnar Library.

  • Document columnar, indexing, vector search, and embedding capabilities
  • Replace installation and build guidance with Docker, Debian/Ubuntu, and source workflows
  • Expand platform requirements, compatibility, benchmarks, releases, and contribution guidance

README.md now provides comprehensive installation, build, usage,
benchmark, release, and contribution documentation for Manticore
Columnar Library.

- Document columnar, indexing, vector search, and embedding capabilities
- Replace installation and build guidance with Docker, Debian/Ubuntu,
  and source workflows
- Expand platform requirements, compatibility, benchmarks, releases, and
  contribution guidance
- Document JSON secondary-index configuration and columnar attribute
  limitations
- Clarify benchmark summary methodology
@donhardman
donhardman requested a review from sanikolaev October 21, 2026 07:00

@sanikolaev sanikolaev left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The README now presents MCL as a standalone storage, indexing, and
vector search library, and clarifies its relationship with Manticore
Search, platform compatibility, embeddings, and source builds.
- Clarify library capabilities and embedding execution options
- Simplify and revise the listed benefits of using MCL with Manticore
  Search
Comment thread README.md
sudo apt install ./manticore-repo.noarch.deb
sudo apt update
sudo apt install manticore-columnar-lib
sudo apt install manticore

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This installs manticore, not the library.

Comment thread README.md
## Benchmarks

### Log analytics - 6x faster than Elasticsearch
In 2022, the Manticore team published these comparisons of Manticore Search with columnar storage against Elasticsearch and ClickHouse on [db-benchmarks.com](https://db-benchmarks.com/). The test framework is [open source](https://github.com/db-benchmarks/db-benchmarks). The figures below are the "Relative query processing time" summaries from the published charts, which are based on geometric means of per-query response-time ratios. They reflect the software versions of that time.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have fresher benchmarks on db-benchmarks.com.

Comment thread README.md
## Versions and releases

### Big data - 1.7B NYC taxi rides - 1.8x faster than Clickhouse
- The latest GitHub release is [14.2.1](https://github.com/manticoresoftware/columnar/releases/tag/14.2.1). It is the version in the current `manticore-columnar-lib` packages and in Manticore Search 29.9.0.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would try to avoid this. Otherwise we'll have to update the readme after each new release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants