#include <qsql_firebird_p.h>

Inheritance diagram for QFirebirdDriver:

Collaboration diagram for QFirebirdDriver:

Public Member Functions
	QFirebirdDriver (QObject *parent=nullptr)
	~QFirebirdDriver () override
bool	hasFeature (DriverFeature feature) const override
	Returns `true` if the driver supports feature feature; otherwise returns `false`.
bool	open (const QString &db, const QString &user, const QString &password, const QString &host, int port, const QString &connOpts) override
	Derived classes must reimplement this pure virtual function to open a database connection on database db, using user name user, password password, host host, port port and connection options options.
void	close () override
	Derived classes must reimplement this pure virtual function in order to close the database connection.
QSqlResult *	createResult () const override
	Creates an empty SQL result on the database.
bool	beginTransaction () override
	This function is called to begin a transaction.
bool	commitTransaction () override
	This function is called to commit a transaction.
bool	rollbackTransaction () override
	This function is called to rollback a transaction.
QStringList	tables (QSql::TableType type) const override
	Returns a list of the names of the tables in the database.
QSqlRecord	record (const QString &tableName) const override
	Returns a QSqlRecord populated with the names of the fields in table tableName.
QSqlIndex	primaryIndex (const QString &tableName) const override
	Returns the primary index for table tableName.
QString	escapeIdentifier (const QString &identifier, IdentifierType type) const override
	Returns the identifier escaped according to the database rules.
QString	formatValue (const QSqlField &field, bool trimStrings) const override
	Returns a string representation of the field value for the database.
QVariant	handle () const override
	Returns the low-level database handle wrapped in a QVariant or an invalid variant if there is no handle.
int	maximumIdentifierLength (IdentifierType type) const override
bool	subscribeToNotification (const QString &name) override
	This function is called to subscribe to event notifications from the database.
bool	unsubscribeFromNotification (const QString &name) override
	This function is called to unsubscribe from event notifications from the database.
QStringList	subscribedToNotifications () const override
	Returns a list of the names of the event notifications that are currently subscribed to.
bool	cancelQuery () override
Public Member Functions inherited from QSqlDriver
	QSqlDriver (QObject *parent=nullptr)
	Constructs a new driver with the given parent.
	~QSqlDriver ()
	Destroys the object and frees any allocated resources.
virtual bool	isOpen () const
	Returns `true` if the database connection is open; otherwise returns false.
bool	isOpenError () const
	Returns `true` if the there was an error opening the database connection; otherwise returns `false`.
virtual QString	sqlStatement (StatementType type, const QString &tableName, const QSqlRecord &rec, bool preparedStatement) const
	Returns a SQL statement of type type for the table tableName with the values from rec.
QSqlError	lastError () const
	Returns a QSqlError object which contains information about the last error that occurred on the database.
virtual bool	isIdentifierEscaped (const QString &identifier, IdentifierType type) const
	Returns whether identifier is escaped according to the database rules.
virtual QString	stripDelimiters (const QString &identifier, IdentifierType type) const
	Returns the identifier with the leading and trailing delimiters removed, identifier can either be a table name or field name, dependent on type.
void	setNumericalPrecisionPolicy (QSql::NumericalPrecisionPolicy precisionPolicy)
	Sets \l numericalPrecisionPolicy to precisionPolicy.
QSql::NumericalPrecisionPolicy	numericalPrecisionPolicy () const
	Returns the \l numericalPrecisionPolicy.
DbmsType	dbmsType () const
QString	connectionName () const
Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.
virtual	~QObject ()
	Destroys the object, deleting all its child objects.
virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.
QString	objectName () const
Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.
void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString >	bindableObjectName ()
bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.
bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.
bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.
bool	isQmlExposed () const noexcept
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.
bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread *	thread () const
	Returns the thread in which the object lives.
bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.
int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
	Kills the timer with timer identifier, id.
void	killTimer (Qt::TimerId id)
template<typename T>
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList &	children () const
	Returns a list of child objects.
void	setParent (QObject *parent)
	Makes the object a child of parent.
void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.
void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.
QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const
bool	disconnect (const QObject receiver, const char member=nullptr) const
void	dumpObjectTree () const
	Dumps a tree of children to the debug output.
void	dumpObjectInfo () const
	Dumps information about signal connections, etc.
bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.
bool	setProperty (const char *name, QVariant &&value)
QVariant	property (const char *name) const
	Returns the value of the object's name property.
QList< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () const
	Returns a pointer to the parent object.
bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Friends
class	QFirebirdResult
class	QFirebirdResultPrivate

Additional Inherited Members
Public Types inherited from QSqlDriver
enum	DriverFeature { Transactions , QuerySize , BLOB , Unicode , PreparedQueries , NamedPlaceholders , PositionalPlaceholders , LastInsertId , BatchOperations , SimpleLocking , LowPrecisionNumbers , EventNotifications , FinishQuery , MultipleResultSets , CancelQuery }
	This enum contains a list of features a driver might support. More...
enum	StatementType { WhereStatement , SelectStatement , UpdateStatement , InsertStatement , DeleteStatement }
	This enum contains a list of SQL statement (or clause) types the driver can create. More...
enum	IdentifierType { FieldName , TableName }
	This enum contains a list of SQL identifier types. More...
enum	NotificationSource { UnknownSource , SelfSource , OtherSource }
	This enum contains a list of SQL notification sources. More...
enum	DbmsType { UnknownDbms , MSSqlServer , MySqlServer , PostgreSQL , Oracle , Sybase , SQLite , Interbase , DB2 , MimerSQL , FirebirdSQL }
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
Signals inherited from QSqlDriver
void	notification (const QString &name, QSqlDriver::NotificationSource source, const QVariant &payload)
Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe
static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe
static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)
static bool	disconnect (const QMetaObject::Connection &)
	Disconnects connection and resets it to \l{QMetaObject::Connection::operator bool()}{invalid}.
static bool	disconnect (QMetaObject::Connection &)
static bool	disconnect (QMetaObject::Connection &&conn)
	Disconnect a connection.
template<typename Func1, typename Func2>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)
template<typename Func1>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)
Protected Member Functions inherited from QSqlDriver
	QSqlDriver (QSqlDriverPrivate &dd, QObject *parent=nullptr)
virtual void	setOpen (bool o)
	This function sets the open state of the database to open.
virtual void	setOpenError (bool e)
	This function sets the open error state of the database to error.
virtual void	setLastError (const QSqlError &e)
	This function is used to set the value of the last error, error, that occurred on the database.
Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int	senderSignalIndex () const
int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.
bool	isSignalConnected (const QMetaMethod &signal) const
virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.
virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	disconnectNotify (const QMetaMethod &signal)
	QObject (QObjectPrivate &dd, QObject *parent=nullptr)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Properties inherited from QSqlDriver
QSql::NumericalPrecisionPolicy	numericalPrecisionPolicy
Properties inherited from QObject
QString	objectName
	the name of this object
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 29 of file qsql_firebird_p.h.

Constructor & Destructor Documentation

◆ QFirebirdDriver()

QFirebirdDriver::QFirebirdDriver ( QObject * parent = nullptr )

explicit

Definition at line 194 of file qsql_firebird.cpp.

References QFirebirdDriver().

Referenced by QFirebirdDriver().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~QFirebirdDriver()

QFirebirdDriver::~QFirebirdDriver ( )

override

Definition at line 199 of file qsql_firebird.cpp.

References close().

Here is the call graph for this function:

Member Function Documentation

◆ beginTransaction()

bool QFirebirdDriver::beginTransaction ( )

overridevirtual

This function is called to begin a transaction.

If successful, return true, otherwise return false. The default implementation does nothing and returns false.

See also: commitTransaction(), rollbackTransaction()

Reimplemented from QSqlDriver.

Definition at line 490 of file qsql_firebird.cpp.

◆ cancelQuery()

bool QFirebirdDriver::cancelQuery ( )

overridevirtual

Cross-thread cancellation (QSqlDriver::CancelQuery). This runs on a DIFFERENT thread than the one executing the query, so it must not touch any driver state beyond the mutex-guarded attachment: no setLastError, and not iStatus (the executing thread owns it) — a private status object is used instead. fb_cancel_raise asks the engine to abort the current operation at its next cancellation point; the executing call then fails with isc_cancelled, which the normal FbException -> QSqlError path reports on the executing thread. The attachment itself stays open and usable.

Reimplemented from QSqlDriver.

Definition at line 472 of file qsql_firebird.cpp.

◆ close()

void QFirebirdDriver::close ( )

overridevirtual

Derived classes must reimplement this pure virtual function in order to close the database connection.

Return true on success, false on failure.

See also: open(), setOpen()

Implements QSqlDriver.

Definition at line 412 of file qsql_firebird.cpp.

Referenced by ~QFirebirdDriver(), and open().

Here is the caller graph for this function:

◆ commitTransaction()

bool QFirebirdDriver::commitTransaction ( )

overridevirtual

This function is called to commit a transaction.

If successful, return true, otherwise return false. The default implementation does nothing and returns false.

See also: beginTransaction(), rollbackTransaction()

Reimplemented from QSqlDriver.

Definition at line 517 of file qsql_firebird.cpp.

◆ createResult()

QSqlResult * QFirebirdDriver::createResult ( ) const

overridevirtual

Creates an empty SQL result on the database.

Derived classes must reimplement this function and return a QSqlResult object appropriate for their database to the caller.

Implements QSqlDriver.

Definition at line 457 of file qsql_firebird.cpp.

References QFirebirdResult::QFirebirdResult().

Here is the call graph for this function:

◆ escapeIdentifier()

QString QFirebirdDriver::escapeIdentifier	(	const QString &	identifier,
		IdentifierType	type ) const

overridevirtual

Returns the identifier escaped according to the database rules.

identifier can either be a table name or field name, dependent on type.

The default implementation does nothing.

See also: isIdentifierEscaped()

Reimplemented from QSqlDriver.

Definition at line 535 of file qsql_firebird.cpp.

◆ formatValue()

QString QFirebirdDriver::formatValue	(	const QSqlField &	field,
		bool	trimStrings ) const

overridevirtual

Returns a string representation of the field value for the database.

This is used, for example, when constructing INSERT and UPDATE statements.

The default implementation returns the value formatted as a string according to the following rules:

\list

If field is character data, the value is returned enclosed in single quotation marks, which is appropriate for many SQL databases. Any embedded single-quote characters are escaped (replaced with two single-quote characters). If trimStrings is true (the default is false), all trailing whitespace is trimmed from the field.

If field is date/time data, the value is formatted in ISO format and enclosed in single quotation marks. If the date/time data is invalid, "NULL" is returned.

If field is \l{QByteArray}{bytearray} data, and the driver can edit binary fields, the value is formatted as a hexadecimal string.

For any other field type, toString() is called on its value and the result of this is returned.

\endlist

See also: QVariant::toString()

Reimplemented from QSqlDriver.

Definition at line 547 of file qsql_firebird.cpp.

◆ handle()

QVariant QFirebirdDriver::handle ( ) const

overridevirtual

Returns the low-level database handle wrapped in a QVariant or an invalid variant if there is no handle.

Warning: Use this with uttermost care and only if you know what you're doing.; The handle returned here can become a stale pointer if the connection is modified (for example, if you close the connection).; The handle can be NULL if the connection is not open yet.

The handle returned here is database-dependent, you should query the type name of the variant before accessing it.

This example retrieves the handle for a connection to sqlite:

QSqlDatabase db = QSqlDatabase::database();
QVariant v = db.driver()->handle();
if (v.isValid() && (qstrcmp(v.typeName(), "sqlite3*") == 0)) {
    // v.data() returns a pointer to the handle
    sqlite3 *handle = *static_cast<sqlite3 **>(v.data());
    if (handle) {
        // ...
    }
}

This snippet returns the handle for PostgreSQL or MySQL:

if (qstrcmp(v.typeName(), "PGconn*") == 0) {
    PGconn *handle = *static_cast<PGconn **>(v.data());
    if (handle) {
        // ...
    }
}
 
if (qstrcmp(v.typeName(), "MYSQL*") == 0) {
    MYSQL *handle = *static_cast<MYSQL **>(v.data());
    if (handle) {
        // ...
    }
}

See also: QSqlResult::handle()

Reimplemented from QSqlDriver.

Definition at line 529 of file qsql_firebird.cpp.

◆ hasFeature()

bool QFirebirdDriver::hasFeature ( DriverFeature feature ) const

overridevirtual

Returns true if the driver supports feature feature; otherwise returns false.

Note that some databases need to be open() before this can be determined.

See also: DriverFeature

Implements QSqlDriver.

Definition at line 211 of file qsql_firebird.cpp.

◆ maximumIdentifierLength()

int QFirebirdDriver::maximumIdentifierLength ( IdentifierType type ) const

overridevirtual

Since: 6.0

Returns the maximum length for the identifier type according to the database settings. Returns INT_MAX by default if the is no maximum for the database.

Reimplemented from QSqlDriver.

Definition at line 576 of file qsql_firebird.cpp.

◆ open()

bool QFirebirdDriver::open	(	const QString &	db,
		const QString &	user,
		const QString &	password,
		const QString &	host,
		int	port,
		const QString &	options )

overridevirtual

Derived classes must reimplement this pure virtual function to open a database connection on database db, using user name user, password password, host host, port port and connection options options.

The function must return true on success and false on failure.

See also: setOpen()

Implements QSqlDriver.

Definition at line 276 of file qsql_firebird.cpp.

References close().

Here is the call graph for this function:

◆ primaryIndex()

QSqlIndex QFirebirdDriver::primaryIndex ( const QString & tableName ) const

overridevirtual

Returns the primary index for table tableName.

Returns an empty QSqlIndex if the table doesn't have a primary index. The default implementation returns an empty index.

Reimplemented from QSqlDriver.

Definition at line 688 of file qsql_firebird.cpp.

◆ record()

QSqlRecord QFirebirdDriver::record ( const QString & tableName ) const

overridevirtual

Returns a QSqlRecord populated with the names of the fields in table tableName.

If no such table exists, an empty record is returned. The default implementation returns an empty record.

Reimplemented from QSqlDriver.

Definition at line 634 of file qsql_firebird.cpp.

◆ rollbackTransaction()

bool QFirebirdDriver::rollbackTransaction ( )

overridevirtual

This function is called to rollback a transaction.

If successful, return true, otherwise return false. The default implementation does nothing and returns false.

See also: beginTransaction(), commitTransaction()

Reimplemented from QSqlDriver.

Definition at line 523 of file qsql_firebird.cpp.

◆ subscribedToNotifications()

QStringList QFirebirdDriver::subscribedToNotifications ( ) const

overridevirtual

Returns a list of the names of the event notifications that are currently subscribed to.

Reimplement this function if you want to provide event notification support in your own QSqlDriver subclass,

See also: subscribeToNotification(), unsubscribeFromNotification()

Reimplemented from QSqlDriver.

Definition at line 771 of file qsql_firebird.cpp.

◆ subscribeToNotification()

bool QFirebirdDriver::subscribeToNotification ( const QString & name )

overridevirtual

This function is called to subscribe to event notifications from the database.

name identifies the event notification.

If successful, return true, otherwise return false.

The database must be open when this function is called. When the database is closed by calling close() all subscribed event notifications are automatically unsubscribed. Note that calling open() on an already open database may implicitly cause close() to be called, which will cause the driver to unsubscribe from all event notifications.

When an event notification identified by name is posted by the database the notification() signal is emitted.

Reimplement this function if you want to provide event notification support in your own QSqlDriver subclass,

See also: unsubscribeFromNotification(), subscribedToNotifications(), QSqlDriver::hasFeature()

Reimplemented from QSqlDriver.

Definition at line 717 of file qsql_firebird.cpp.

◆ tables()

QStringList QFirebirdDriver::tables ( QSql::TableType tableType ) const

overridevirtual

Returns a list of the names of the tables in the database.

The default implementation returns an empty list.

The tableType argument describes what types of tables should be returned. Due to binary compatibility, the string contains the value of the enum QSql::TableTypes as text. An empty string should be treated as QSql::Tables for backward compatibility.

Reimplemented from QSqlDriver.

Definition at line 603 of file qsql_firebird.cpp.

◆ unsubscribeFromNotification()

bool QFirebirdDriver::unsubscribeFromNotification ( const QString & name )

overridevirtual

This function is called to unsubscribe from event notifications from the database.

name identifies the event notification.

If successful, return true, otherwise return false.

The database must be open when this function is called. All subscribed event notifications are automatically unsubscribed from when the close() function is called.

After calling this function the notification() signal will no longer be emitted when an event notification identified by name is posted by the database.

Reimplement this function if you want to provide event notification support in your own QSqlDriver subclass,

See also: subscribeToNotification(), subscribedToNotifications()

Reimplemented from QSqlDriver.

Definition at line 751 of file qsql_firebird.cpp.

References QFirebirdEventSubscription::release(), and QFirebirdEventSubscription::stop().

Here is the call graph for this function:

◆ QFirebirdResult

friend class QFirebirdResult

friend

Definition at line 33 of file qsql_firebird_p.h.

◆ QFirebirdResultPrivate

friend class QFirebirdResultPrivate

friend

Definition at line 34 of file qsql_firebird_p.h.

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

qtbase/src/plugins/sqldrivers/firebird/qsql_firebird_p.h (508f587717ef550368a8ce7120c1ba8caeabce96)
qtbase/src/plugins/sqldrivers/firebird/qsql_firebird.cpp (508f587717ef550368a8ce7120c1ba8caeabce96)

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QFirebirdDriver()

◆ ~QFirebirdDriver()

Member Function Documentation

◆ beginTransaction()

◆ cancelQuery()

◆ close()

◆ commitTransaction()

◆ createResult()

◆ escapeIdentifier()

◆ formatValue()

◆ handle()

◆ hasFeature()

◆ maximumIdentifierLength()

◆ open()

◆ primaryIndex()

◆ record()

◆ rollbackTransaction()

◆ subscribedToNotifications()

◆ subscribeToNotification()

◆ tables()

◆ unsubscribeFromNotification()

Friends And Related Symbol Documentation

◆ QFirebirdResult

◆ QFirebirdResultPrivate