A Firebird connection. More...

#include <Wt/Dbo/backend/Firebird.h>

Inheritance diagram for Wt::Dbo::backend::Firebird:

Public Member Functions
	Firebird ()
	Creates a Firebird backend connection. More...

	Firebird (const std::string &ServerName, const std::string &DatabaseName, const std::string &UserName, const std::string &UserPassword, const std::string &RoleName, const std::string &CharSet=std::string(), const std::string &CreateParams=std::string())
	Creates and opens a Firebird backend connection.

	Firebird (IBPP::Database db)
	Creates and opens a Firebird backend connection.

	Firebird (const Firebird &other)
	Copy constructor. More...

virtual	~Firebird ()
	Destructor. More...

bool	connect (const std::string &ServerName, const std::string &DatabaseName, const std::string &UserName, const std::string &UserPassword, const std::string &RoleName, const std::string &CharSet=std::string(), const std::string &CreateParams=std::string())
	Tries to connect. More...

virtual std::unique_ptr< SqlConnection >	clone () const override
	Clones the connection. More...

IBPP::Database	connection ()
	Returns the underlying connection handle.

virtual void	startTransaction () override
	Starts a transaction. More...

virtual void	commitTransaction () override
	Commits a transaction. More...

virtual void	rollbackTransaction () override
	Rolls back a transaction. More...

virtual std::unique_ptr< SqlStatement >	prepareStatement (const std::string &sql) override
	Prepares a statement. More...

virtual void	prepareForDropTables () override
	Execute code before dropping the tables. More...

Methods that return dialect information
virtual std::string	autoincrementSql () const override
	Returns the 'autoincrement' SQL type modifier. More...

virtual std::vector< std::string >	autoincrementCreateSequenceSql (const std::string &table, const std::string &id) const override
	Returns the SQL statement(s) required to create an id sequence. More...

virtual std::vector< std::string >	autoincrementDropSequenceSql (const std::string &table, const std::string &id) const override
	Returns the SQL statement(s) required to drop an id sequence. More...

virtual std::string	autoincrementType () const override
	Returns the 'autoincrement' SQL type. More...

virtual std::string	autoincrementInsertSuffix (const std::string &id) const override
	Returns the suffix for an 'autoincrement' insert statement. More...

virtual const char *	dateTimeType (SqlDateTimeType type) const override
	Returns the date/time type. More...

virtual const char *	blobType () const override
	Returns the blob type. More...

virtual std::string	textType (int size) const override
	Returns the text type. More...

virtual const char *	booleanType () const override
	Returns the boolean type. More...

virtual LimitQuery	limitQueryMethod () const override

virtual bool	supportAlterTable () const override
	Returns true if the backend support Alter Table. More...

virtual bool	usesRowsFromTo () const override
	Returns whether the SQL dialect uses 'ROWS ? TO ?', limit or rownum for partial select results. More...

Public Member Functions inherited from Wt::Dbo::SqlConnection
virtual	~SqlConnection ()
	Destructor.

virtual void	executeSql (const std::string &sql)
	Executes an SQL statement. More...

virtual void	executeSqlStateful (const std::string &sql)
	Executes a connection-stateful SQL statement. More...

virtual SqlStatement *	getStatement (const std::string &id) const
	Returns the statement with the given id. More...

virtual void	saveStatement (const std::string &id, std::unique_ptr< SqlStatement > statement)
	Saves a statement with the given id. More...

void	setProperty (const std::string &name, const std::string &value)
	Sets a property. More...

std::string	property (const std::string &name) const
	Returns a property. More...

virtual std::string	autoincrementInsertInfix (const std::string &id) const
	Returns the infix for an 'autoincrement' insert statement. More...

virtual std::string	longLongType () const
	Returns the 64-bit integer type. More...

virtual bool	supportUpdateCascade () const
	Returns true if the database supports Update Cascade. More...

virtual bool	requireSubqueryAlias () const
	Returns the true if the database require subquery alias. More...

virtual bool	supportDeferrableFKConstraint () const
	Returns true if the backend supports "deferrable initially deferred" foreign key constraints. More...

virtual const char *	alterTableConstraintString () const
	Returns the command used in alter table .. drop constraint .. More...

Detailed Description

A Firebird connection.

This class provides the backend implementation for Firebird databases. It supports Firebird databases with version 2.1 or higher.

Warning: The Firebird backend is UNMAINTAINED, and may not work at all with recent versions of Firebird. This backend is based on IBPP, a project which has not seen any activity in a very long time. Emweb has no plans to continue supporting the Firebird backend.

Constructor & Destructor Documentation

◆ Firebird() [1/2]

Wt::Dbo::backend::Firebird::Firebird ( )

Creates a Firebird backend connection.

The connection is not yet open, and requires a connect() before it can be used.

◆ Firebird() [2/2]

Wt::Dbo::backend::Firebird::Firebird ( const Firebird & other )

Copy constructor.

This creates a new backend connection with the same settings as another connection.

◆ ~Firebird()

Wt::Dbo::backend::Firebird::~Firebird ( )

virtual

Destructor.

Closes the connection.

Member Function Documentation

◆ autoincrementCreateSequenceSql()

std::vector< std::string > Wt::Dbo::backend::Firebird::autoincrementCreateSequenceSql	(	const std::string &	table,
		const std::string &	id
	)		const

overridevirtual

Returns the SQL statement(s) required to create an id sequence.

This is used by Session::createTables() to create the id sequence for a table. The table's name and primary key are passed as arguments to this function and can be used to construct an SQL sequence that is unique for the table.

Implements Wt::Dbo::SqlConnection.

◆ autoincrementDropSequenceSql()

std::vector< std::string > Wt::Dbo::backend::Firebird::autoincrementDropSequenceSql	(	const std::string &	table,
		const std::string &	id
	)		const

overridevirtual

Returns the SQL statement(s) required to drop an id sequence.

This is used by Session::dropTables() to drop the id sequence for a table. The table's name and primary key are passed as arguments to this function and can be used to construct an SQL sequence that is unique for the table.

Implements Wt::Dbo::SqlConnection.

◆ autoincrementInsertSuffix()

std::string Wt::Dbo::backend::Firebird::autoincrementInsertSuffix ( const std::string & id ) const

overridevirtual

Returns the suffix for an 'autoincrement' insert statement.

This is appended to the insert statement, since some back-ends need to be indicated that they should return the autoincrement id.

Implements Wt::Dbo::SqlConnection.

◆ autoincrementSql()

std::string Wt::Dbo::backend::Firebird::autoincrementSql ( ) const

overridevirtual

Returns the 'autoincrement' SQL type modifier.

This is used by Session::createTables() to create the id column.

Implements Wt::Dbo::SqlConnection.

◆ autoincrementType()

std::string Wt::Dbo::backend::Firebird::autoincrementType ( ) const

overridevirtual

Returns the 'autoincrement' SQL type.

This is used by Session::createTables() to create the id column.

Implements Wt::Dbo::SqlConnection.

◆ blobType()

const char * Wt::Dbo::backend::Firebird::blobType ( ) const

overridevirtual

Returns the blob type.

See also: SqlStatement::bind(int, const std::vector<unsigned char>&)

Implements Wt::Dbo::SqlConnection.

◆ booleanType()

const char * Wt::Dbo::backend::Firebird::booleanType ( ) const

overridevirtual

Returns the boolean type.

This method will return "boolean" by default.

Reimplemented from Wt::Dbo::SqlConnection.

◆ clone()

std::unique_ptr< SqlConnection > Wt::Dbo::backend::Firebird::clone ( ) const

overridevirtual

Clones the connection.

Returns a new connection object that is configured like this object. This is used by connection pool implementations to create its connections.

Implements Wt::Dbo::SqlConnection.

◆ commitTransaction()

void Wt::Dbo::backend::Firebird::commitTransaction ( )

overridevirtual

Commits a transaction.

This function commits a transaction.

Implements Wt::Dbo::SqlConnection.

◆ connect()

bool Wt::Dbo::backend::Firebird::connect	(	const std::string &	ServerName,
		const std::string &	DatabaseName,
		const std::string &	UserName,
		const std::string &	UserPassword,
		const std::string &	RoleName,
		const std::string &	CharSet = `std::string()`,
		const std::string &	CreateParams = `std::string()`
	)

Tries to connect.

Throws an exception if there was a problem, otherwise returns true.

◆ dateTimeType()

const char * Wt::Dbo::backend::Firebird::dateTimeType ( SqlDateTimeType type ) const

overridevirtual

Returns the date/time type.

See also: SqlStatement::bind(int, const std::chrono::system_clock::time_point&, SqlDateTimeType)

Implements Wt::Dbo::SqlConnection.

◆ prepareForDropTables()

void Wt::Dbo::backend::Firebird::prepareForDropTables ( )

overridevirtual

Execute code before dropping the tables.

This method is called before calling Session::dropTables(). The default implementation is empty.

Reimplemented from Wt::Dbo::SqlConnection.

◆ prepareStatement()

std::unique_ptr< SqlStatement > Wt::Dbo::backend::Firebird::prepareStatement ( const std::string & sql )

overridevirtual

Prepares a statement.

Returns the prepared statement.

Implements Wt::Dbo::SqlConnection.

◆ rollbackTransaction()

void Wt::Dbo::backend::Firebird::rollbackTransaction ( )

overridevirtual

Rolls back a transaction.

This function rolls back a transaction.

Implements Wt::Dbo::SqlConnection.

◆ startTransaction()

void Wt::Dbo::backend::Firebird::startTransaction ( )

overridevirtual

Starts a transaction.

This function starts a transaction.

Implements Wt::Dbo::SqlConnection.

◆ supportAlterTable()

bool Wt::Dbo::backend::Firebird::supportAlterTable ( ) const

overridevirtual

Returns true if the backend support Alter Table.

This method will return false by default.

Reimplemented from Wt::Dbo::SqlConnection.

◆ textType()

std::string Wt::Dbo::backend::Firebird::textType ( int size ) const

overridevirtual

Returns the text type.

This is the text type for a string. If size = -1, then a type should be returned which does not require size information, otherwise a type should be returned that limits the size of the stored string to size.

This method will return "text" by default if size = -1, and "varchar(size)" otherwise.

See also: SqlStatement::bind(int column, const std::string& value)

Reimplemented from Wt::Dbo::SqlConnection.

◆ usesRowsFromTo()

virtual bool Wt::Dbo::backend::Firebird::usesRowsFromTo ( ) const

overridevirtual

Returns whether the SQL dialect uses 'ROWS ? TO ?', limit or rownum for partial select results.

This is an alternative SQL dialect option to the (non-standard) 'OFFSET ? LIMIT ?' syntax.

The default implementation returns LimitQuery::Limit.

Reimplemented from Wt::Dbo::SqlConnection.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Firebird() [1/2]

◆ Firebird() [2/2]

◆ ~Firebird()

Member Function Documentation

◆ autoincrementCreateSequenceSql()

◆ autoincrementDropSequenceSql()

◆ autoincrementInsertSuffix()

◆ autoincrementSql()

◆ autoincrementType()

◆ blobType()

◆ booleanType()

◆ clone()

◆ commitTransaction()

◆ connect()

◆ dateTimeType()

◆ prepareForDropTables()

◆ prepareStatement()

◆ rollbackTransaction()

◆ startTransaction()

◆ supportAlterTable()

◆ textType()

◆ usesRowsFromTo()