Xandra v0.7.2 Xandra.Page

A struct that represents a page of rows.

This struct represents a page of rows that have been returned by the Cassandra server in response to a query such as SELECT, but have not yet been parsed into Elixir values.

This struct implements the Enumerable protocol and is therefore a stream. It is through this protocol that a Xandra.Page struct can be parsed into Elixir values. The simplest way of getting a list of single rows out of a Xandra.Page struct is to use something like Enum.to_list/1. Each element emitted when streaming out of a Xandra.Page struct is a map of string column names to their corresponding value.

Examples

statement = "SELECT name, age FROM users"
%Xandra.Page{} = page = Xandra.execute!(conn, statement, _params = [])
Enum.each(page, fn %{"name" => name, "age" => age} ->
  IO.puts "Read user with name #{name} (age #{age}) out of the database"
end)

Summary

Functions

Tells whether more pages are available to fetch after the given one

Types

t()
t

Functions

more_pages_available?(page)
more_pages_available?(t) :: boolean

Tells whether more pages are available to fetch after the given one.

This function can be used to check whether more pages are available to fetch after the given page. This is useful when implementing manual paging. See also the documentation for Xandra.execute/4.