Referencia de la Clase FLSqlQuery

#include <FLSqlQuery.h>

Diagrama de herencias de FLSqlQuery

Lista de todos los miembros.

Tipos públicos
typedef QDict< FLParameterQuery >	FLParameterQueryDict
typedef QDict< FLGroupByQuery >	FLGroupByQueryDict
Métodos públicos
	FLSqlQuery (QObject *parent=0, const QString &connectionName="default")
	~FLSqlQuery ()
bool	exec ()
void	addParameter (const FLParameterQuery *p)
void	addGroup (const FLGroupByQuery *g)
void	setName (const QString &n)
QString	name () const
QString	select () const
QString	from () const
QString	where () const
QString	orderBy () const
void	setSelect (const QString &s, const QString &sep=QString::fromLatin1(","))
void	setFrom (const QString &f)
void	setWhere (const QString &w)
void	setOrderBy (const QString &w)
QString	sql ()
FLParameterQueryDict *	parameterDict () const
FLGroupByQueryDict *	groupDict () const
QStringList	fieldList () const
void	setGroupDict (FLGroupByQueryDict *gd)
void	setParameterDict (FLParameterQueryDict *pd)
void	showDebug ()
QVariant	value (const QString &n, bool raw=false) const
bool	isNull (const QString &n) const
QVariant	value (int i, bool raw=false) const
QString	posToFieldName (const int p) const
int	fieldNameToPos (const QString &n) const
QStringList	tablesList () const
void	setTablesList (const QString &tl)
void	setValueParam (const QString &name, const QVariant &v)
QVariant	valueParam (const QString &name) const
int	size () const
FLTableMetaData::FLFieldMetaDataList *	fieldMetaDataList ()
FLSqlDatabase *	db () const
bool	isValid () const
bool	isActive () const
bool	isNull (int field) const
int	at () const
QString	lastQuery () const
int	numRowsAffected () const
QSqlError	lastError () const
bool	isSelect () const
int	QSqlQuery_size () const
const QSqlDriver *	driver () const
const QSqlResult *	result () const
bool	isForwardOnly () const
void	setForwardOnly (bool forward)
bool	exec (const QString &query)
QVariant	QSqlQuery_value (int i) const
bool	seek (int i, bool relative=FALSE)
bool	next ()
bool	prev ()
bool	first ()
bool	last ()
bool	prepare (const QString &query)
void	bindValue (const QString &placeholder, const QVariant &val)
void	bindValue (int pos, const QVariant &val)
void	addBindValue (const QVariant &val)
void	bindValue (const QString &placeholder, const QVariant &val, QSql::ParameterType type)
void	bindValue (int pos, const QVariant &val, QSql::ParameterType type)
void	addBindValue (const QVariant &val, QSql::ParameterType type)
QVariant	boundValue (const QString &placeholder) const
QVariant	boundValue (int pos) const
QMap< QString, QVariant >	boundValues () const
QString	executedQuery () const

---

Descripción detallada

Maneja consultas con caracter�sticas espec�ficas para AbanQ, hereda de QSqlQuery.

Ofrece la funcionalidad para manejar consultas de QSqlQuery y adem�s ofrece m�todos para trabajar con consultas parametrizadas y niveles de agrupamiento.

Autor:

InfoSiAL S.L.

---

Documentación de los 'Typedef' miembros de la clase

typedef QDict<FLGroupByQuery> FLSqlQuery::FLGroupByQueryDict

Tipo de datos diccionaro de grupos

typedef QDict<FLParameterQuery> FLSqlQuery::FLParameterQueryDict

Tipo de datos diccionario de parametros

---

Documentación del constructor y destructor

FLSqlQuery::FLSqlQuery	(	QObject *	parent = 0,
		const QString &	connectionName = "default"
	)

constructor

FLSqlQuery::~FLSqlQuery

(

)

destructor

---

Documentación de las funciones miembro

void FLSqlQuery::addBindValue

(

const QVariant &

val

)

[inline]

void FLSqlQuery::addBindValue	(	const QVariant &	val,
		QSql::ParameterType	type
	)		[inline]

void FLSqlQuery::addGroup

(

const FLGroupByQuery *

g

)

A�ade la descripci�n de un grupo al diccionario de grupos.

Parámetros:

g	Objeto FLGroupByQuery con la descripci�n del grupo a a�adir

void FLSqlQuery::addParameter

(

const FLParameterQuery *

p

)

A�ade la descripci�n par�metro al diccionario de par�metros.

Parámetros:

p	Objeto FLParameterQuery con la descripci�n del par�metro a a�adir

int FLSqlQuery::at

(

)

const [inline]

void FLSqlQuery::bindValue	(	const QString &	placeholder,
		const QVariant &	val
	)		[inline]

void FLSqlQuery::bindValue	(	int	pos,
		const QVariant &	val
	)		[inline]

void FLSqlQuery::bindValue	(	const QString &	placeholder,
		const QVariant &	val,
		QSql::ParameterType	type
	)		[inline]

void FLSqlQuery::bindValue	(	int	pos,
		const QVariant &	val,
		QSql::ParameterType	type
	)		[inline]

QVariant FLSqlQuery::boundValue

(

const QString &

placeholder

)

const [inline]

QVariant FLSqlQuery::boundValue

(

int

pos

)

const [inline]

QMap<QString, QVariant> FLSqlQuery::boundValues

(

)

const [inline]

FLSqlDatabase * FLSqlQuery::db

(

)

const [inline]

Para obtener la base de datos sobre la que trabaja

const QSqlDriver* FLSqlQuery::driver

(

)

const [inline]

bool FLSqlQuery::exec

(

)

Ejecuta la consulta

bool FLSqlQuery::exec

(

const QString &

query

)

[inline]

QString FLSqlQuery::executedQuery

(

)

const [inline]

QStringList FLSqlQuery::fieldList

(

)

const [inline]

Para obtener la lista de nombres de los campos.

Devuelve:

Lista de cadenas de texto con los nombres de los campos de la consulta

FLTableMetaData::FLFieldMetaDataList * FLSqlQuery::fieldMetaDataList

(

)

Para obtener la lista de definiciones de campos de la consulta

Devuelve:

Objeto con la lista de deficiones de campos de la consulta

int FLSqlQuery::fieldNameToPos

(

const QString &

n

)

const

Devuelve la posici�n de una campo en la consulta, dado su nombre.

Parámetros:

n	Nombre del campo

Devuelve:

Posicion del campo en la consulta. Si no existe el campo devuelve -1

bool FLSqlQuery::first

(

)

[inline]

QString FLSqlQuery::from

(

)

const [inline]

Para obtener la parte FROM de la sentencia SQL de la consulta

FLSqlQuery::FLGroupByQueryDict * FLSqlQuery::groupDict

(

)

const [inline]

Para obtener los niveles de agrupamiento de la consulta.

Devuelve:

Diccionario de niveles de agrupamiento

bool FLSqlQuery::isActive

(

)

const [inline]

bool FLSqlQuery::isForwardOnly

(

)

const [inline]

bool FLSqlQuery::isNull

(

int

field

)

const [inline]

bool FLSqlQuery::isNull

(

const QString &

n

)

const

Indica si un campo de la consulta es nulo o no

Dado un nombre de un campo de la consulta, este m�todo devuelve true si el campo de la consulta es nulo. El nombre debe corresponder con el que se coloco en la parte SELECT de la sentenica SQL de la consulta.

Parámetros:

n	Nombre del campo de la consulta

bool FLSqlQuery::isSelect

(

)

const [inline]

bool FLSqlQuery::isValid

(

)

const [inline]

bool FLSqlQuery::last

(

)

[inline]

QSqlError FLSqlQuery::lastError

(

)

const [inline]

QString FLSqlQuery::lastQuery

(

)

const [inline]

QString FLSqlQuery::name

(

)

const [inline]

Para obtener el nombre de la consulta

Reimplementado de QObject.

bool FLSqlQuery::next

(

)

[inline]

int FLSqlQuery::numRowsAffected

(

)

const [inline]

QString FLSqlQuery::orderBy

(

)

const [inline]

Para obtener la parte ORDER BY de la sentencia SQL de la consulta

FLSqlQuery::FLParameterQueryDict * FLSqlQuery::parameterDict

(

)

const [inline]

Para obtener los parametros de la consulta.

Devuelve:

Diccionario de par�metros

QString FLSqlQuery::posToFieldName

(

const int

p

)

const

Devuelve el nombre de campo, dada su posicion en la consulta.

Parámetros:

p	Posicion del campo en la consulta, empieza en cero y de izquierda a derecha

Devuelve:

Nombre del campo correspondiente. Si no existe el campo devuelve QString::null

bool FLSqlQuery::prepare

(

const QString &

query

)

[inline]

bool FLSqlQuery::prev

(

)

[inline]

int FLSqlQuery::QSqlQuery_size

(

)

const [inline]

QVariant FLSqlQuery::QSqlQuery_value

(

int

i

)

const [inline]

const QSqlResult* FLSqlQuery::result

(

)

const [inline]

bool FLSqlQuery::seek	(	int	i,
		bool	relative = FALSE
	)		[inline]

QString FLSqlQuery::select

(

)

const [inline]

Para obtener la parte SELECT de la sentencia SQL de la consulta

void FLSqlQuery::setForwardOnly

(

bool

forward

)

[inline]

void FLSqlQuery::setFrom

(

const QString &

f

)

Para establecer la parte FROM de la sentencia SQL de la consulta.

Parámetros:

f	Cadena de texto con la parte FROM de la sentencia SQL que genera la consulta

void FLSqlQuery::setGroupDict

(

FLGroupByQueryDict *

gd

)

Asigna un diccionario de par�metros, al diccionario de par�metros de la consulta.

El diccionario de par�metros del tipo FLGroupByQueryDict , ya construido, es asignado como el nuevo diccionario de grupos de la consulta, en el caso de que ya exista un diccionario de grupos, este es destruido y sobreescrito por el nuevo. El diccionario pasado a este m�todo pasa a ser propiedad de la consulta, y ella es la encargada de borrarlo. Si el diccionario que se pretende asignar es nulo o vac�o este m�todo no hace nada.

Parámetros:

gd	Diccionario de par�metros

void FLSqlQuery::setName

(

const QString &

n

)

[inline]

Para establecer el nombre de la consulta.

Parámetros:

n	Nombre de la consulta

void FLSqlQuery::setOrderBy

(

const QString &

w

)

Para establecer la parte ORDER BY de la sentencia SQL de la consulta.

Parámetros:

s	Cadena de texto con la parte ORDER BY de la sentencia SQL que genera la consulta

void FLSqlQuery::setParameterDict

(

FLParameterQueryDict *

pd

)

Asigna un diccionario de grupos, al diccionario de grupos de la consulta.

El diccionario de grupos del tipo FLParameterQueryDict , ya construido, es asignado como el nuevo diccionario de par�metros de la consulta, en el caso de que ya exista un diccionario de par�metros, este es destruido y sobreescrito por el nuevo. El diccionario pasado a este m�todo pasa a ser propiedad de la consulta, y ella es la encargada de borrarlo. Si el diccionario que se pretende asignar es nulo o vac�o este m�todo no hace nada.

Parámetros:

pd	Diccionario de par�metros

void FLSqlQuery::setSelect	(	const QString &	s,
		const QString &	sep = QString::fromLatin1(",")
	)

Para establecer la parte SELECT de la sentencia SQL de la consulta.

Parámetros:

s	Cadena de texto con la parte SELECT de la sentencia SQL que genera la consulta. Esta cadena NO debe incluir la palabra reservada SELECT, ni tampoco el caracter '*' como comod�n. Solo admite la lista de campos que deben aparecer en la consulta separados por la cadena indicada en el par�metro 'sep'
sep	Cadena utilizada como separador en la lista de campos. Por defecto se utiliza la coma.

void FLSqlQuery::setTablesList

(

const QString &

tl

)

Establece la lista de nombres de las tablas de la consulta

Parámetros:

tl	Cadena de texto con los nombres de las tablas separados por comas, p.e. "tabla1,tabla2,tabla3"

void FLSqlQuery::setValueParam	(	const QString &	name,
		const QVariant &	v
	)

Establece el valor de un par�metro.

Parámetros:

name	Nombre del par�metro
v	Valor para el par�metros

void FLSqlQuery::setWhere

(

const QString &

w

)

Para establecer la parte WHERE de la sentencia SQL de la consulta.

Parámetros:

s	Cadena de texto con la parte WHERE de la sentencia SQL que genera la consulta

void FLSqlQuery::showDebug

(

)

Este m�todo muestra el contenido de la consulta, por la s�lida est�ndar.

Est� pensado s�lo para tareas de depuraci�n

int FLSqlQuery::size

(

)

const

Redefinicion del m�todo size() de QSqlQuery

QString FLSqlQuery::sql

(

)

Para obtener la sentencia completa SQL de la consulta.

Este m�todo une las tres partes de la consulta (SELECT, FROM Y WHERE), sustituye los par�metros por el valor que tienen en el diccionario y devuelve todo en una cadena de texto.

Devuelve:

Cadena de texto con la sentencia completa SQL que genera la consulta

QStringList FLSqlQuery::tablesList

(

)

const [inline]

Para obtener la lista de nombres de las tablas de la consulta.

Devuelve:

Lista de nombres de las tablas que entran a formar parte de la consulta

QVariant FLSqlQuery::value	(	int	i,
		bool	raw = false
	)		const

Sobrecarga de FLSqlQuery::value(const QString &n, bool raw)

Parámetros:

i	Posicion del campo

QVariant FLSqlQuery::value	(	const QString &	n,
		bool	raw = false
	)		const

Obtiene el valor de un campo de la consulta.

Dado un nombre de un campo de la consulta, este m�todo devuelve un objeto QVariant con el valor de dicho campo. El nombre debe corresponder con el que se coloco en la parte SELECT de la sentenica SQL de la consulta.

Parámetros:

n	Nombre del campo de la consulta
raw	Si TRUE y el valor del campo es una referencia a un valor grande (ver FLManager::storeLargeValue()) devuelve el valor de esa referencia, en vez de contenido al que apunta esa referencia

QVariant FLSqlQuery::valueParam

(

const QString &

name

)

const

Obtiene el valor de un par�metro.

Parámetros:

name	Nombre del par�metro.

QString FLSqlQuery::where

(

)

const [inline]

Para obtener la parte WHERE de la sentencia SQL de la consulta

---

La documentación para esta clase fue generada a partir de los siguientes ficheros:

• src/flbase/FLSqlQuery.h
• src/flbase/FLSqlQuery.cpp