hazelcast::client::sql::sql_page Class Reference

A finite set of rows returned to the client. More...

#include <sql_page.h>

Classes
class	sql_row

Public Member Functions
	sql_page (std::vector< sql_column_type > column_types, std::vector< column > columns, bool last, std::shared_ptr< sql_row_metadata > row_metadata=nullptr)
	Constructs an sql_page from the response returned from the server.
const std::vector< sql_column_type > &	column_types () const
	Returns the types of the columns in each row.
bool	last () const
std::size_t	column_count () const
	Returns the number of columns in each row.
std::size_t	row_count () const
	Returns the number of rows in this page.
const std::vector< sql_row > &	rows () const
	Returns the rows of this page.

Friends
class	sql_result
class	protocol::codec::builtin::sql_page_codec

Detailed Description

A finite set of rows returned to the client.

Definition at line 42 of file sql_page.h.

Constructor & Destructor Documentation

sql_page()

hazelcast::client::sql::sql_page::sql_page	(	std::vector< sql_column_type >	column_types,
		std::vector< column >	columns,
		bool	last,
		std::shared_ptr< sql_row_metadata >	row_metadata = nullptr )

Constructs an sql_page from the response returned from the server.

Parameters

column_types	The types of the columns in each row of the page.
columns	The values of each column for all rows of the page.
last	true if this is the last page in \sql_result, false otherwise.
row_metadata	The metadata of the rows of the page.

Definition at line 1200 of file sql.cpp.

  : page_data_{ new page_data{ std::move(column_types),
                               std::move(columns),
                               std::move(row_metadata),
                               nullptr } }
  , last_(last)
{
}

Member Function Documentation

column_count()

std::size_t hazelcast::client::sql::sql_page::column_count

(

)

const

Returns the number of columns in each row.

Returns

the number of columns in each row.

Definition at line 1235 of file sql.cpp.

{
    return page_data_->column_count();
}

column_types()

const std::vector< sql_column_type > & hazelcast::client::sql::sql_page::column_types

(

)

const

Returns the types of the columns in each row.

Returns

the vector of column types in each row

Definition at line 1223 of file sql.cpp.

{
    return page_data_->column_types_;
}

last()

bool hazelcast::client::sql::sql_page::last

(

)

const

Returns

true if this is the last page of the sql_result, false otherwise

Definition at line 1229 of file sql.cpp.

{
    return last_;
}

row_count()

std::size_t hazelcast::client::sql::sql_page::row_count

(

)

const

Returns the number of rows in this page.

Returns

the number of rows in this page.

Definition at line 1241 of file sql.cpp.

{
    return page_data_->row_count();
}

rows()

const std::vector< sql_page::sql_row > & hazelcast::client::sql::sql_page::rows

(

)

const

Returns the rows of this page.

Returns

the vector of rows in this page.

Definition at line 1247 of file sql.cpp.

{
    return rows_;
}

Friends And Related Symbol Documentation

protocol::codec::builtin::sql_page_codec

friend class protocol::codec::builtin::sql_page_codec

friend

Definition at line 169 of file sql_page.h.

sql_result

friend class sql_result

friend

Definition at line 168 of file sql_page.h.

---

The documentation for this class was generated from the following files:

• hazelcast/include/hazelcast/client/sql/sql_page.h
• hazelcast/src/hazelcast/client/sql.cpp