Module cursor

Description
Function Index
Function Details

Client side DB cursor represents record set of query.

Version: 1.2.8

Introduced in: 2014-03-08

Authors: Alexei Krasnopolski (krasnop@bellsouth.net) [web site: http://krasnopolski.org/].

Description

Client side DB cursor represents record set of query. Cursor allows easy navigate througth record set and retrieve field values by name or index. Cursor owns to process created it and can not access concurrently.

Function Index

new/1	Creates new cursor from result record set obtained after db query.
new/2	Creates new cursor with regestered name from result record set obtained after db query.
size/1	Get size (number of rows) of the cursor.
next/1	Move cursor pointer to the next position.
skip/2	Skip `I` positions and set cursor pointer to the position.
back/1	Move cursor pointer back to the previous position.
set/2	Set `I` as a new positions of the cursor pointer.
reset/1	Reset cursor pointer to the beginning position.
get/2	Get value of field with `Name`.
foreach/2	Returns list of values of `Name` field from all rows of record set.

Function Details

new/1

new(DB_result_set::tuple()) -> pid()

Creates new cursor from result record set obtained after db query.

new/2

new(Name::atom(), DB_result_set::tuple()) -> pid()

Creates new cursor with regestered name from result record set obtained after db query.

size/1

size(CursorId) -> integer()

CursorId = pid() | atom()

Get size (number of rows) of the cursor.

next/1

next(CursorId) -> boolean()

CursorId = pid() | atom()

Move cursor pointer to the next position. Returns false if pointer already on the end of cursor.

skip/2

skip(CursorId, I::integer()) -> integer()

CursorId = pid() | atom()

Skip I positions and set cursor pointer to the position. Returns number actualy skipped positions.

back/1

back(CursorId) -> boolean()

CursorId = pid() | atom()

Move cursor pointer back to the previous position. Returns false if pointer already on the beginning of cursor.

set/2

set(CursorId, I::integer()) -> boolean()

CursorId = pid() | atom()

Set I as a new positions of the cursor pointer. Returns false if I is out of the range.

reset/1

reset(CursorId) -> boolean()

CursorId = pid() | atom()

Reset cursor pointer to the beginning position.

get/2

get(CursorId, Name) -> Result

CursorId = pid() | atom()
Name = string() | integer()
Result = integer() | float() | string() | binary() | #mysql_time{} | #mysql_decimal{}

Get value of field with Name. Name can be string name of field or index in row list.

foreach/2

foreach(CursorId, Name) -> Result

CursorId = pid() | atom()
Name = string() | integer()
Result = [integer() | float() | string() | binary() | #mysql_time{} | #mysql_decimal{}]

Returns list of values of Name field from all rows of record set. Name can be string name of field or index in row list.

Generated by EDoc