NAME
	/precompiled/sql/mysql_result - result of an Mysql query (ALPHA)

DESCRIPTION
	/precompiled/sql/mysql_result is a pre-compiled Pike program. It
	contains the result of a Mysql-query. /precompiled/sql/mysql_result
	is a part of the mysql module.

	Mysql is available from http://www.tcx.se/ .

KEYWORDS
	sql, database

SEE ALSO
	/precompiled/sql/mysql


============================================================================
NAME
	create - make a new mysql_result object

SYNTAX
	#include <mysql.h>

	object(Mysql_result) mysql->query(string q);
	or
	object(Mysql_result) mysql->list_dbs();
	or
	object(Mysql_result) mysql->list_dbs(string wild);
	or
	object(Mysql_result) mysql->list_tables();
	or
	object(Mysql_result) mysql->list_tables(string wild);
	or
	object(Mysql_result) mysql->list_processes();

DESCRIPTION
	Creates a Mysql result table.

SEE ALSO
	mysql->query, mysql->list_dbs, mysql->list_tables,
	mysql->list_processes, /precompiled/sql/mysql


============================================================================
NAME
	num_rows - number of rows in the result

SYNTAX
	#include <mysql.h>

	int mysql_result->num_rows();

DESCRIPTION
	Returns the number of rows in the result.

SEE ALSO
	mysql_result->num_fields


============================================================================
NAME
	num_fields - number of fields in the result

SYNTAX
	#include <mysql.h>

	int mysql_result->num_fields();

DESCRIPTION
	Returns the number of fields in the result.

SEE ALSO
	mysql_result->num_rows


============================================================================
NAME
	field_seek - skip to specified field (OPTIONAL)

SYNTAX
	#include <mysql.h>

	void mysql_result->field_seek(int field_no);

DESCRIPTION
	Places the field cursor at the specified position. This affects
	which field mysql_result->fetch_field() will return next.

	Fields are numbered starting with 0.

NOTA BENE
	This function exists only if SUPPORT_FIELD_SEEK was defined when
	compiling the mysql-module.

SEE ALSO
	mysql_result->fetch_field, mysql_result->fetch_fields


============================================================================
NAME
	eof - at end of result table

SYNTAX
	#include <mysql.h>

	int mysql_result->eof();

DESCRIPTION
	Returns non-zero when all rows have been read.

SEE ALSO
	mysql_result->fetch_row


============================================================================
NAME
	fetch_field - return specification of current field (OPTIONAL)

SYNTAX
	#include <mysql.h>

	int|mapping(string:mixed) mysql_result->fetch_field();

DESCRIPTION
	Returns a mapping with information about the current field, and
	advances the field cursor one step. Returns 0 if there are no more
	fields.

	The mapping contains the same entries as those returned by
	mysql->list_fields(), except that the "default" entry is missing.

NOTA BENE
	This function exists only if SUPPORT_FIELD_SEEK was defined when
	compiling the mysql-module.

BUGS
	The "flags" entry should be parsed.

SEE ALSO
	mysql_result->fetch_fields, mysql_result->field_seek,
	sql->list_fields


============================================================================
NAME
	fetch_fields - return specification of all remaining fields

SYNTAX
	#include <mysql.h>

	array(int|mapping(string:mixed)) mysql_result->fetch_fields();

DESCRIPTION
	Returns an array with one mapping for every remaining field in the
	result table.

	It returns data similar to mysql->list_fields(), except for that
	the "default" entry is missing.

NOTA BENE
	Resets the field cursor to 0.

	This function exists even if SUPPORT_FIELD_SEEK wasn't defined when
	the Mysql-module was compiled.

BUGS
	See mysql_result->fetch_field.

SEE ALSO
	mysql_result->fetch_field, mysql_result->field_seek,
	mysql->list_fields


============================================================================
NAME
	seek - skip ahead a number of rows

SYNTAX
	#include <mysql.h>

	void mysql_result->seek(int r);

DESCRIPTION
	Skips ahead the specified number of rows.

BUGS
	Can only seek forward (limitation in Mysql).

SEE ALSO
	mysql_result->fetch_row


============================================================================
NAME
	fetch_row - fetch the next row from the result

SYNTAX
	#include <mysql.h>

	int|array(string|int) mysql_result->fetch_row();

DESCRIPTION
	Returns an array with the contents of the next row in the result.
	Advances the row cursor to the next row. Returns 0 at end of table.

SEE ALSO
	mysql_result->seek


