Skip to content

Commit d4fe855

Browse files
committed
doc: clarify description of cython deserializers
1 parent 99428c0 commit d4fe855

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

docs/api/cassandra/protocol.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,13 @@ and ``NumpyProtocolHandler``. They can be used as follows:
4141
s.client_protocol_handler = LazyProtocolHandler # for a result iterator
4242
s.client_protocol_handler = NumpyProtocolHandler # for a dict of NumPy arrays as result
4343
44-
These protocol handlers comprise different column parsers (with corresponding names), and return
45-
results as described below:
44+
These protocol handlers comprise different parsers, and return results as described below:
4645

47-
.. autofunction:: cython_protocol_handler
46+
- ProtocolHandler: this default implementation is a drop-in replacement for the pure-Python version.
47+
The rows are all parsed upfront, before results are returned.
48+
49+
- LazyProtocolHandler: near drop-in replacement for the above, except that it returns an iterator over rows,
50+
lazily decoded into the default row format (this is more efficient since all decoded results are not materialized at once)
51+
52+
- NumpyProtocolHander: deserializes results directly into NumPy arrays. This facilitates efficient integration with
53+
analysis toolkits such as Pandas.

0 commit comments

Comments
 (0)