Skip to content

flesh out ResultSet upgrade guide (PYTHON-464) #796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mambocab merged 1 commit into from
Jul 13, 2017
Merged

flesh out ResultSet upgrade guide (PYTHON-464) #796

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions docs/upgrading.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,16 @@ materialize a list using the iterator:
results = session.execute("SELECT * FROM system.local")
row_list = list(results)

For backward compatability, :class:`~.ResultSet` supports indexing. If
the result is paged, all pages will be materialized. A warning will
be logged if a paged query is implicitly materialized.
For backward compatability, :class:`~.ResultSet` supports indexing. When
accessed at an index, a `~.ResultSet` object will materialize all its pages:

.. code-block:: python

results = session.execute("SELECT * FROM system.local")
first_result = results[0] # materializes results, fetching all pages

This can send requests and load (possibly large) results into memory, so
`~.ResultSet` will log a warning on implicit materialization.

Trace information is not attached to executed Statements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down