KexiDB::Parser Class Reference

#include <parser.h>

Detailed Description

Parser for SQL statements.

The best and prefeerred way to run queries is using the KexiDB::Parser functionality and use the resulting QuerySchema object since this offers a database-backend-independent way to deal with SQL statements on the one hand and offers high level functionality on the other. Also BLOBs like images are handled that way.

For example if we like to use the SELECT statement "SELECT dir.path, media.filename FROM dir, media WHERE dir.id=media.dirId AND media.id=%s" we are able to use the Connection::prepareStatement method which takes the type of the statement (in our case PreparedStatement::SelectStatement ), a list of fields (in our case dir.path and media.filename) and returns a PreparedStatement::Ptr instance. By using the QuerySchema::addRelationship and QuerySchema::addToWhereExpression methods the SQL statement could be extended with relationships and WHERE expressions.

For more, see KexiDB::PreparedStatement and Connection::selectStatement() . A more complex example that looks at what the user has defined and carefully builds KexiDB::QuerySchema object, including the WHERE expression can be found in the Query Designer's source code in the method KexiQueryDesignerGuiEditor::buildSchema().

Definition at line 112 of file parser.h.

Public Types

enum OPCode {
OP_None = 0, OP_Error, OP_CreateTable, OP_AlterTable,
OP_Select, OP_Insert, OP_Update, OP_Delete
}

The operation-code of the statement. More...

Public Member Functions

Parser (Connection *connection)

constructs an empty object of the parser

~Parser ()

bool parse (const QString &statement)

clears previous results and runs the parser

void clear ()

rests results

OPCode operation () const

QString operationString () const

TableSchema * table ()

QuerySchema * query ()

Connection * db () const

ParserError error () const

QString statement () const

void setOperation (OPCode op)

void createTable (const char *t)

void setQuerySchema (QuerySchema *query)

QuerySchema * select () const

void setError (const ParserError &err)

bool isReservedKeyword (const char *str)

Protected Member Functions

void init ()

Protected Attributes

ParserError m_error

detailed information about last error.

ParserPrivate * d

Member Enumeration Documentation

enum KexiDB::Parser::OPCode

The operation-code of the statement.

Enumeration values:

OP_None

OP_Error No statement parsed or reseted.

OP_CreateTable Error while parsing.

OP_AlterTable Create a table.

OP_Select Alter an existing table.

OP_Insert Query-statement.

OP_Update Insert new content.

OP_Delete Delete existing content.

Definition at line 119 of file parser.h.

Constructor & Destructor Documentation

Parser::Parser ( Connection * connection )

constructs an empty object of the parser

Parameters:

connection is used for things like wildcard resolution. If 0 parser works in "pure mode"

Definition at line 31 of file parser.cpp.
References d, and KexiDB::ParserPrivate::db.

Parser::~Parser ( )

Definition at line 37 of file parser.cpp.
References d.

Member Function Documentation

void Parser::clear ( )

rests results

Definition at line 125 of file parser.cpp.
References KexiDB::ParserPrivate::clear(), and d.
Referenced by parse(), and parseData().

void Parser::createTable ( const char * t )

Definition at line 84 of file parser.cpp.
References d, and KexiDB::ParserPrivate::table.
Referenced by yyparse().

Connection * Parser::db ( ) const

Returns:
a pointer to the used database connection or 0 if not set You can call this method only once every time after doing parse(). Next time, the call will return 0.

Definition at line 71 of file parser.cpp.
References d, and KexiDB::ParserPrivate::db.
Referenced by buildSelectQuery().

ParserError Parser::error ( ) const

Returns:
detailed information about last error. If no error occurred ParserError isNull()

Definition at line 73 of file parser.cpp.
References d, and KexiDB::ParserPrivate::error.
Referenced by parseData(), KexiQueryDesignerSQLView::slotCheckQuery(), and yyerror().

void Parser::init ( ) [protected]

Definition at line 101 of file parser.cpp.
References d, and KexiDB::ParserPrivate::initialized.
Referenced by parse().

bool Parser::isReservedKeyword ( const char * str )

Returns:
true if the

Parameters:

str is an reserved keyword (see tokens.cpp for a list of reserved keywords).

Definition at line 110 of file parser.cpp.
References d, and KexiDB::ParserPrivate::reservedKeywords.
Referenced by yyerror().

Parser::OPCode Parser::operation ( ) const

Returns:
the resulting operation or OP_Error if failed

Definition at line 42 of file parser.cpp.
References d, and KexiDB::ParserPrivate::operation.
Referenced by parseData().

QString Parser::operationString ( ) const

Returns:
the resulting operation as string.

Definition at line 45 of file parser.cpp.
References d, OP_AlterTable, OP_CreateTable, OP_Delete, OP_Error, OP_Insert, OP_Select, OP_Update, and KexiDB::ParserPrivate::operation.

bool Parser::parse ( const QString & statement )

clears previous results and runs the parser

Definition at line 116 of file parser.cpp.
References clear(), d, init(), parseData(), and KexiDB::ParserPrivate::statement.
Referenced by KexiQueryPart::loadSchemaData(), and KexiQueryDesignerSQLView::slotCheckQuery().

QuerySchema * Parser::query ( )

Returns:
a pointer to KexiDBSelect if 'SELECT ...' was called or 0 on any other operation or error. Returned object is owned by you. You can call this method only once every time after doing parse(). Next time, the call will return 0.

Definition at line 69 of file parser.cpp.
References d, and KexiDB::ParserPrivate::select.
Referenced by KexiQueryPart::loadSchemaData(), and KexiQueryDesignerSQLView::slotCheckQuery().

QuerySchema * Parser::select ( ) const

Definition at line 79 of file parser.cpp.
References d, and KexiDB::ParserPrivate::select.

void Parser::setError ( const ParserError & err )

Definition at line 81 of file parser.cpp.
References d, and KexiDB::ParserPrivate::error.
Referenced by parseData(), setError(), and yyerror().

void Parser::setOperation ( OPCode op )

Definition at line 77 of file parser.cpp.
References d, and KexiDB::ParserPrivate::operation.
Referenced by yyerror(), and yyparse().

void Parser::setQuerySchema ( QuerySchema * query )

Definition at line 93 of file parser.cpp.
References d, and KexiDB::ParserPrivate::select.
Referenced by yyparse().

QString Parser::statement ( ) const

Returns:
the statement passed on the last parse method-call.

Definition at line 75 of file parser.cpp.
References d, and KexiDB::ParserPrivate::statement.
Referenced by yyerror().

TableSchema * Parser::table ( )

Returns:
a pointer to a KexiDBTable on CREATE TABLE or 0 on any other operation or error. Returned object is owned by you. You can call this method only once every time after doing parse(). Next time, the call will return 0.

Definition at line 67 of file parser.cpp.
References d, and KexiDB::ParserPrivate::table.
Referenced by yyparse().

Member Data Documentation

ParserPrivate* KexiDB::Parser::d [protected]

Definition at line 234 of file parser.h.
Referenced by clear(), createTable(), db(), error(), init(), isReservedKeyword(), operation(), operationString(), parse(), Parser(), query(), select(), setError(), setOperation(), setQuerySchema(), statement(), table(), and ~Parser().

ParserError KexiDB::Parser::m_error [protected]

detailed information about last error.

Definition at line 233 of file parser.h.

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


Public Types
enum	OPCode { OP_None = 0, OP_Error, OP_CreateTable, OP_AlterTable, OP_Select, OP_Insert, OP_Update, OP_Delete }
	The operation-code of the statement. More...
Public Member Functions
	Parser (Connection *connection)
	constructs an empty object of the parser
	~Parser ()
bool	parse (const QString &statement)
	clears previous results and runs the parser
void	clear ()
	rests results
OPCode	operation () const
QString	operationString () const
TableSchema *	table ()
QuerySchema *	query ()
Connection *	db () const
ParserError	error () const
QString	statement () const
void	setOperation (OPCode op)
void	createTable (const char *t)
void	setQuerySchema (QuerySchema *query)
QuerySchema *	select () const
void	setError (const ParserError &err)
bool	isReservedKeyword (const char *str)
Protected Member Functions
void	init ()
Protected Attributes
ParserError	m_error
	detailed information about last error.
ParserPrivate *	d

Kexi API Documentation (2.0 alpha)

KexiDB::Parser Class Reference

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation