TRowset.md

HDO Documentación

Clase TRowSet

Esta clase se utiliza para enviar sentencias al servidor que devuelvan un conjuto de resultados.

Una vez obtenida la información se guardará en un array local navegable.

Incorpora métodos para poder realizar altas, bajas y modificaciones.

En cualquier momento se podrá refrescar el resultado obteniendo la información actual desde el servidor.

La velocidad está optimizada ya que incorpora un sistema de reciclaje de datos.

Hay dos maneras de obtener objetos de esta clase:

Al estilo xBase:

oRS := TRowSet():new( <oHDO>, <cStatement> )

y al estilo java:

oRS := <oHDO>:rowSet( <cStatement> )

Una vez creado el objeto lo siguiente sería establecer los atributos si son necesarios y enlazar las variables harbour con los parámetros de la sentencia por su posición.

Cuando el sistema esté configurado a nuestras necesidades se envía el metodo :load() que carga la información en el cliente desde el servidor.

Un ejemplo básico:

...
local cName , aRec
local oRS

oRS := oDb:rowSet( "SELECT * FROM test WHERE first = ?;" ) // Crea el objeto RowSet
oRS:setAttribute( ATTR_STR_PAD, .t. ) // Hace que se rellene de espacios los campos string
oRS:bindParam(  1, @cName ) // Vincula la variable cName con el primer y único parámetro, el 1

cName := "Lailton"

oRS:load() // Carga el resultado desde el serbidor al cliente. Es como si se ejecutara:
// SELECT * FROM test WHERE first = 'Lailton';

...

oRS:goTo( 10 ) // Va al registro
? oRS:fieldGet( 1 ), oRS:fieldGet( "first" ) // Muestra un campo por posición o por nombre
aRec := oRS:getValues() // Carga el contenido del registro en una array

cName := "Jose" // Cambia el valor de la variable vinculada
oRS:reLoad() // Recarga el cliente desde el servidor con el nuevo valor. Se ejecuta:
// SELECT * FROM test WHERE first = 'Jose';

...

Métodos

new()

Sintaxis:

TRowSet():new( , )

Argumentos:

• Objeto que representa la conexión con la base de datos.

• Sentencia SQL para obtener los campos seleccionados, de una o mas tablas.

Devuelve:

Una referencia al objeto TRowSet recien creado.

Descripción:

Es el método constructor de la clase.

Ejemplo:

oRowset := TRowSet():new( oDataBase, "SELECT * FROM test WHERE last like 'R%'" )

bindParam()

Sintaxis:

bindParam( , )

Argumentos:

• Identificador del parámetro, posicion del parametro de sustición en el comando SQL.

  En algunos gestores como SQLite se puede usar el nombre precedido de "":"", por ejemplo:

  :bindParam( ":code", @cCode )

  En próximas versiones de HDO se implementará esta sintaxis para todos las bases de datos.

• Nombre de la variable de Harbour a vincular al parámetro de la sentencia SQL.

  Importante, se debe pasar por referencia o sea precedida por @.

Devuelve:

Vedadero, en caso de éxito, falso en caso de error.

Descripción:

Vincula una variable de harbour a un parámetro de sustitución con el signo de interrogación o con el :nombre (si el gestor lo admite) correspondiente de la sentencia SQL.

Ejemplo:

	....
	local cLast
	
	oRowset := TRowSet():new( oDataBase, "SELECT * FROM test WHERE last like ?" )
	oRowset:bindParam( 1, @cLast )
	
	cLast := "Pepito"
	
	oRowSet:load()

Tambié se puede usar así, si el gestor lo permite, como en SQLite:

	...
	local cLast
	
	oRowset := TRowSet():new( oDataBase, "SELECT * FROM test WHERE last like :lastname" )
	oRowset:bindParam( ":lastaname", @cLast )
	
	cLast := "pepito"
	
	oRowSet:load()

bindValue()

Sintaxis:

bindValue( , )

Argumentos:

• Identificador del parámetro, posicion del parametro de sustición en el comando SQL.

• Valor a vincular al parámetro de la sentencia SQL.

Devuelve:

Vedadero, en caso de éxito, falso en caso de error.

Descripción:

Vincula un valor a un parámetro de sustitución con el signo de interrogación correspondiente de la sentencia SQL.

Ejemplo:

	oRowset := TRowSet():new( oDataBase, "SELECT * FROM test WHERE last like ?" )
	oRowset:bindParam( 1, "R%" )
	oRowSet:load()

getQueryStr()

Sintaxis:

getQueryStr()

Devuelve:

La sentencia SQL con la que se invoco el la creación del RowSet.

Descripción:

Muestra la sentecia completa con la que se creo el objeto RowSet.

Ejemplo:

	oRowset := TRowSet():new( oDataBase, "SELECT * FROM test WHERE last like R%" )
	oRowset:getQueryStr() // --> "SELECT * FROM test WHERE last like R%"

bindParamCount()

Sintaxis:

bindParamCount()

Devuelve:

El número de parametros de sustitución de la sentecncia SQL del RowSet.

Descripción:

Muestra el número de parametros de la sentecia completa con la que se creo el objeto RowSet.

Ejemplo:

	oRowset := TRowSet():new( oDataBase, "SELECT * FROM test WHERE last like ?" )
	oRowset:bindParam( 1, "R%" )
	oRowSet:bindParamCount() // --> 1

errorCode()

Sintaxis:

errorCode()

Devuelve:

El último código de error, en la ejecución de RowSet.

Descripción:

Muestra el código de error en la última ejecución de RowSet, o ceros, si no hubo errores.

Ejemplo:

	oRowset := TRowSet():new( oDataBase, "SELECT * FROM test WHERE last like ?" )
	oRowset:errorCode() // --> 00000

errorNo()

Sintaxis:

errorNo()

Devuelve:

El último número de error, en la ejecución de RowSet.

Descripción:

Muestra el número de error en la última ejecución de RowSet, o cero, si no hubo errores.

Ejemplo:

	oRowset := TRowSet():new( oDataBase, "SELECT * FROM test WHERE last like ?" )
	oRowset:errorNo() // --> 0

errorStr()

Sintaxis:

errorStr()

Devuelve:

El último texto de error, en la ejecución de RowSet.

Descripción:

Muestra el texto de error en la última ejecución de RowSet, o cero, si no hubo errores.

Ejemplo:

oRowset := TRowSet():new( oDataBase, "SELECT * FROM            test WHERE last like ?" )
oRowset:errorStr() // --> ""

getAttribute()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

oDb := THDO():new( _DBMS )
if oDb:connect( _DB, _CONN )
try
   oRS := oDb:rowSet( STMT_SEL )
   // Prueba de setAttribute y getAttribute
   msg( oRS:getAttribute( STMT_ATTR_STR_PAD ), "STMT_ATTR_STR_PAD" )
   oRS:setAttribute( STMT_ATTR_STR_PAD, .f. )
   msg( oRS:getAttribute( STMT_ATTR_STR_PAD ), "STMT_ATTR_STR_PAD" )

   msg( oRS:getAttribute( STMT_ATTR_TINY_AS_BOOL ), "STMT_ATTR_TINY_AS_BOOL" )
   oRS:setAttribute( STMT_ATTR_TINY_AS_BOOL, .t. )
   msg( oRS:getAttribute( STMT_ATTR_TINY_AS_BOOL ), "STMT_ATTR_TINY_AS_BOOL" )
			
   msg( oRS:getAttribute( STMT_ATTR_CURSOR_TYPE ), "STMT_ATTR_CURSOR_TYPE" )
   oRS:setAttribute( STMT_ATTR_CURSOR_TYPE, CURSOR_TYPE_READ_ONLY )			
   msg( oRS:getAttribute( STMT_ATTR_CURSOR_TYPE ), "STMT_ATTR_CURSOR_TYPE" )

   msg( oRS:getAttribute( STMT_ATTR_PREFETCH_ROWS ), "STMT_ATTR_PREFETCH_ROWS" )
   oRS:setAttribute( STMT_ATTR_PREFETCH_ROWS, 100 )			
   msg( oRS:getAttribute( STMT_ATTR_PREFETCH_ROWS ), "STMT_ATTR_PREFETCH_ROWS" )

   msg( oRS:getAttribute( STMT_ATTR_UPDATE_MAX_LENGTH ), "STMT_ATTR_UPDATE_MAX_LENGTH" )    oRS:setAttribute( STMT_ATTR_UPDATE_MAX_LENGTH, .f. )			
   msg( oRS:getAttribute( STMT_ATTR_UPDATE_MAX_LENGTH ), "STMT_ATTR_UPDATE_MAX_LENGTH" )
   ...
   ...

setAttribute()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

oDb := THDO():new( _DBMS )
if oDb:connect( _DB, _CONN )
try
   oRS := oDb:rowSet( STMT_SEL )
   // Prueba de setAttribute y getAttribute
   msg( oRS:getAttribute( STMT_ATTR_STR_PAD ), "STMT_ATTR_STR_PAD" )
   oRS:setAttribute( STMT_ATTR_STR_PAD, .f. )
   msg( oRS:getAttribute( STMT_ATTR_STR_PAD ), "STMT_ATTR_STR_PAD" )

   msg( oRS:getAttribute( STMT_ATTR_TINY_AS_BOOL ), "STMT_ATTR_TINY_AS_BOOL" )
   oRS:setAttribute( STMT_ATTR_TINY_AS_BOOL, .t. )
   msg( oRS:getAttribute( STMT_ATTR_TINY_AS_BOOL ), "STMT_ATTR_TINY_AS_BOOL" )
			
   msg( oRS:getAttribute( STMT_ATTR_CURSOR_TYPE ), "STMT_ATTR_CURSOR_TYPE" )
   oRS:setAttribute( STMT_ATTR_CURSOR_TYPE, CURSOR_TYPE_READ_ONLY )			
   msg( oRS:getAttribute( STMT_ATTR_CURSOR_TYPE ), "STMT_ATTR_CURSOR_TYPE" )

   msg( oRS:getAttribute( STMT_ATTR_PREFETCH_ROWS ), "STMT_ATTR_PREFETCH_ROWS" )
   oRS:setAttribute( STMT_ATTR_PREFETCH_ROWS, 100 )			
   msg( oRS:getAttribute( STMT_ATTR_PREFETCH_ROWS ), "STMT_ATTR_PREFETCH_ROWS" )

   msg( oRS:getAttribute( STMT_ATTR_UPDATE_MAX_LENGTH ), "STMT_ATTR_UPDATE_MAX_LENGTH" )    oRS:setAttribute( STMT_ATTR_UPDATE_MAX_LENGTH, .f. )			
   msg( oRS:getAttribute( STMT_ATTR_UPDATE_MAX_LENGTH ), "STMT_ATTR_UPDATE_MAX_LENGTH" )
   ...
   ...

load()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

local oDb, oRS
oDb := THDO():new( _DBMS )

if oDb:connect( _DB, _CONN )
try
	oRS := oDb:rowSet( "SELECT * FROM test limit 1" ) //
	oRS:load()		
...
...

refresh()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

static procedure Borrar()
local lContinue := msgSN( "el socio: " + oRS:fieldGet( 2 ), ;
                          "Realmente esta seguro de borrar" )

if lContinue
   id := oRS:fieldGet( 1 )
   msgEspera()
   oDelete:execute()
   oRS:refresh()
endif

return

reload()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

free()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

goTop()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

goBottom()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

goTo()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

skip()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

skipper()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

fieldCount()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

fCount()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

fieldName()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

fieldType()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

fieldLen()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

fieldDec()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

fieldPos()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

fieldGet()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

recNo()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

recCount()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

lastRec()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

eof()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

bof()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

fieldNames()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

first()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

last()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

next()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

prior()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

moveBy()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

columnCount()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

getColCount()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

getMetaColumn()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

getMetaField()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

getColName()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

getColType()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

getColLen()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

getColDec()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

getColPos()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

getValue()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

getValueByName()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

getValueByPos()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

fetchColumn()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

rowCount()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

rows()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

listColNames()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

getListColNames()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

find()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

findNext()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

findString()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

findStringNext()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

setInsertStmt()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

setupDateStmt()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

setDeleteStmt()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

insert()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

update()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

delete()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

listValues()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

getValues()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

getValuesArray()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

getValuesHash()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

setFilter()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

clearFilter()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

throwException()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo:

throw()

Sintaxis:

Argumentos:

Devuelve:

Descripción:

Ejemplo: