ResultSet Class Reference

Collaboration diagram for ResultSet:

Public Member Functions
	__init__ (self, Any response)
"ResultSet"	raise_on_error (self)
bool	is_empty (self)
bool	has_next (self)
Record	next (self)
"ResultSet"	__iter__ (self)
Record	__next__ (self)
Iterator[Record]	records (self)
str	__str__ (self)
Iterable[Dict[str, Any]]	as_primitive_by_row (self)
Dict[str, List[Any]]	as_primitive_by_column (self)
"DataFrame"	as_pandas_df (self)
Optional[str]	as_ascii_table (self, Optional["Console"] console=None, str style="table", Optional[int] width=None, int min_width=8, Optional[int] max_width=None, int padding=1, bool collapse_padding=False)
Record	one (self)
Optional[Record]	one_or_none (self)
	print (self, str style="table", Optional[int] width=None, int min_width=8, Optional[int] max_width=None, int padding=1, bool collapse_padding=False)

Public Attributes
	result_table
	column_names
	size
	status_code
	status_message
	is_succeeded
	latency_us
	plan_desc
	extra_info

Static Public Attributes
List	column_names [str]
Optional	result_table [ResultTable]
str	status_code
str	status_message
int	latency_us
PlanInfoNode	plan_desc
int	size
ExtraInfo	extra_info

Detailed Description

Definition at line 211 of file result_set.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
		Any	response
	)

Definition at line 221 of file result_set.py.

Member Function Documentation

__iter__()

"ResultSet" __iter__

(

self

)

Definition at line 312 of file result_set.py.

__next__()

Record __next__

(

self

)

Definition at line 315 of file result_set.py.

__str__()

str __str__

(

self

)

Definition at line 332 of file result_set.py.

as_ascii_table()

Optional[str] as_ascii_table	(		self,
		Optional["Console"]	console = None,
		str	style = "table",
		Optional[int]	width = None,
		int	min_width = 8,
		Optional[int]	max_width = None,
		int	padding = 1,
		bool	collapse_padding = False
	)

Print query results in a formatted table or row-by-row format.

Return the string if console is not provided.

Definition at line 372 of file result_set.py.

Here is the call graph for this function:

Here is the caller graph for this function:

as_pandas_df()

"DataFrame" as_pandas_df

(

self

)

Convert result set to pandas DataFrame.

Definition at line 348 of file result_set.py.

Here is the call graph for this function:

as_primitive_by_column()

Dict[str, List[Any]] as_primitive_by_column

(

self

)

Definition at line 341 of file result_set.py.

as_primitive_by_row()

Iterable[Dict[str, Any]] as_primitive_by_row

(

self

)

Definition at line 337 of file result_set.py.

has_next()

bool has_next

(

self

)

Return True if there are more rows to consume.

Mirrors Java ResultSet.hasNext().

Definition at line 281 of file result_set.py.

Here is the call graph for this function:

Here is the caller graph for this function:

is_empty()

bool is_empty

(

self

)

Return True when the result set contains no rows.

Definition at line 273 of file result_set.py.

next()

Record next

(

self

)

Decode and return the next row as a Record.

Mirrors Java ResultSet.next(): each call advances the internal
cursor and decodes exactly one row on demand.

Raises
------
    StopIteration: when no more rows are available.

Definition at line 290 of file result_set.py.

Here is the call graph for this function:

Here is the caller graph for this function:

one()

Record one

(

self

)

Definition at line 447 of file result_set.py.

one_or_none()

Optional[Record] one_or_none

(

self

)

Definition at line 450 of file result_set.py.

print()

print	(		self,
		str	style = "table",
		Optional[int]	width = None,
		int	min_width = 8,
		Optional[int]	max_width = None,
		int	padding = 1,
		bool	collapse_padding = False
	)

Print the results directly to console with rich formatting.

Definition at line 456 of file result_set.py.

Here is the call graph for this function:

raise_on_error()

"ResultSet" raise_on_error

(

self

)

Definition at line 259 of file result_set.py.

records()

Iterator[Record] records

(

self

)

Generator that yields all remaining Records.

Compatible with existing code that calls ``for record in result.records()``.

Definition at line 324 of file result_set.py.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

column_names [1/2]

List column_names [str]

static

Definition at line 212 of file result_set.py.

column_names [2/2]

column_names

Definition at line 227 of file result_set.py.

extra_info [1/2]

ExtraInfo extra_info

static

Definition at line 219 of file result_set.py.

extra_info [2/2]

extra_info

Definition at line 249 of file result_set.py.

is_succeeded

is_succeeded

Definition at line 243 of file result_set.py.

latency_us [1/2]

int latency_us

static

Definition at line 216 of file result_set.py.

latency_us [2/2]

latency_us

Definition at line 247 of file result_set.py.

plan_desc [1/2]

PlanInfoNode plan_desc

static

Definition at line 217 of file result_set.py.

plan_desc [2/2]

plan_desc

Definition at line 248 of file result_set.py.

result_table [1/2]

Optional result_table [ResultTable]

static

Definition at line 213 of file result_set.py.

result_table [2/2]

result_table

Definition at line 226 of file result_set.py.

size [1/2]

int size

static

Definition at line 218 of file result_set.py.

size [2/2]

size

Definition at line 228 of file result_set.py.

status_code [1/2]

str status_code

static

Definition at line 214 of file result_set.py.

status_code [2/2]

status_code

Definition at line 241 of file result_set.py.

status_message [1/2]

str status_message

static

Definition at line 215 of file result_set.py.

status_message [2/2]

status_message

Definition at line 242 of file result_set.py.

---

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

• src/nebulagraph_python/result_set.py