diff options
| author | Taras Voinarovskyi <voyn1991@gmail.com> | 2018-02-21 23:05:31 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-02-21 23:05:31 +0200 |
| commit | 0c0c7eae13f3b2b8e3ed7c443adef39cb6802a67 (patch) | |
| tree | 2cb5e5660842baa9dcd08a7f716c3a4461f20de7 /docs | |
| parent | 92635d9bfff5593ba865003dd3010a0feb280140 (diff) | |
| download | kafka-python-0c0c7eae13f3b2b8e3ed7c443adef39cb6802a67.tar.gz | |
Use hardware accelerated CRC32C function if available (#1389)
* Use hardware accelerated CRC32C function if available
* Add doc notice of optional `crc32c` package
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/install.rst | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/install.rst b/docs/install.rst index cc0e82d..fe740f6 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -70,3 +70,16 @@ Install the `python-snappy` module .. code:: bash pip install python-snappy + + +Optional crc32c install +*********************** +Highly recommended if you are using Kafka 11+ brokers. For those `kafka-python` +uses a new message protocol version, that requires calculation of `crc32c`, +which differs from `zlib.crc32` hash implementation. By default `kafka-python` +calculates it in pure python, which is quite slow. To speed it up we optionally +support https://pypi.python.org/pypi/crc32c package if it's installed. + +.. code:: bash + + pip install crc32c |