hbase-driver documentation¶
Get started · 中文使用手册 · GitHub · PyPI
Native Python access to Apache HBase — install, connect, and build reliable data workflows without a Thrift server.
A virtual environment is optional. Start with the complete runnable example, or find the guide for your task below. 中文用户可直接阅读中文详细手册。
This documentation describes the current repository implementation. Start with the task you want to accomplish rather than reading the API reference from top to bottom. Examples use the public Client API and byte strings; they do not require Thrift.
Choose a learning path¶
| Your goal | Start here | Continue with |
|---|---|---|
| Install and read/write your first row | Getting started | Runnable recipes |
| Understand namespaces, row keys, and values | Data model and encoding | Scanning and filters |
| Connect from a service or Docker | Configuration and connection lifecycle | Troubleshooting |
| Implement pagination, counters, or buffered writes | Runnable recipes | API reference |
| Manage tables, namespaces, or snapshots | Administration guide | Current limitations |
| Move from another client | Java/Thrift migration | HappyBase migration |
| Measure or diagnose throughput | Performance guide | Development environment |
| Contribute a fix or documentation example | Test guide | Documentation maintenance |
Before production use¶
Read current limitations. A method being present does not mean every option is implemented end-to-end. In particular, do not assume global scan limits, scan time ranges, automatic failover, or a single RPC for batch writes.
The examples were validated on Python 3.11 and HBase 2.6.1 using temporary tables. This is not a compatibility guarantee for every Python/HBase combination. Cookbook recipes contain assertions and describe their setup; other snippets are contextual examples. See the verification scope for the difference between the published site build and HBase integration checks.
Other references¶
- Changelog — historical release notes, not a live test report.
- Complete runnable example — copyable script that creates a unique scratch table and cleans it up.
- Apache HBase reference — general HBase concepts; Python API details are specific to this driver.
This site follows the repository's main branch, not an immutable package-version snapshot. Check your installed version and current limitations. Documentation updates deploy independently of PyPI releases; the package's description and project-link metadata change only with a package release. See publishing and maintenance.