Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
XyzDriver Class Reference

[47] More...

+ Inheritance diagram for XyzDriver:
+ Collaboration diagram for XyzDriver:

Public Member Functions

 XyzDriver ()
 
 ~XyzDriver ()
 
bool hasFeature (DriverFeature) const override
 Returns true if the driver supports feature feature; otherwise returns false.
 
bool open (const QString &, const QString &, const QString &, const QString &, int, const QString &) 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.
 
QSqlResultcreateResult () const override
 Creates an empty SQL result on the database.
 
- 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 bool beginTransaction ()
 This function is called to begin a transaction.
 
virtual bool commitTransaction ()
 This function is called to commit a transaction.
 
virtual bool rollbackTransaction ()
 This function is called to rollback a transaction.
 
virtual QStringList tables (QSql::TableType tableType) const
 Returns a list of the names of the tables in the database.
 
virtual QSqlIndex primaryIndex (const QString &tableName) const
 Returns the primary index for table tableName.
 
virtual QSqlRecord record (const QString &tableName) const
 Returns a QSqlRecord populated with the names of the fields in table tableName.
 
virtual QString formatValue (const QSqlField &field, bool trimStrings=false) const
 Returns a string representation of the field value for the database.
 
virtual QString escapeIdentifier (const QString &identifier, IdentifierType type) const
 Returns the identifier escaped according to the database rules.
 
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 QVariant handle () const
 Returns the low-level database handle wrapped in a QVariant or an invalid variant if there is no handle.
 
virtual bool subscribeToNotification (const QString &name)
 This function is called to subscribe to event notifications from the database.
 
virtual bool unsubscribeFromNotification (const QString &name)
 This function is called to unsubscribe from event notifications from the database.
 
virtual QStringList subscribedToNotifications () const
 Returns a list of the names of the event notifications that are currently subscribed to.
 
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
 
virtual int maximumIdentifierLength (IdentifierType type) 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< QStringbindableObjectName ()
 
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 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).
 
QThreadthread () 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 >
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 >
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () 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.
 

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
}
 
- Public Slots inherited from QSqlDriver
virtual bool cancelQuery ()
 
- 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 &)
 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
QObjectsender () 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< QObjectDatad_ptr
 
- Properties inherited from QSqlDriver
QSql::NumericalPrecisionPolicy numericalPrecisionPolicy
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

[47]

[48]

Definition at line 449 of file sqldatabase.cpp.

Constructor & Destructor Documentation

◆ XyzDriver()

XyzDriver::XyzDriver ( )
inline

Definition at line 452 of file sqldatabase.cpp.

◆ ~XyzDriver()

XyzDriver::~XyzDriver ( )
inline

Definition at line 453 of file sqldatabase.cpp.

Member Function Documentation

◆ close()

void XyzDriver::close ( )
inlineoverridevirtual

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 460 of file sqldatabase.cpp.

◆ createResult()

QSqlResult * XyzDriver::createResult ( ) const
inlineoverridevirtual

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 461 of file sqldatabase.cpp.

◆ hasFeature()

bool XyzDriver::hasFeature ( DriverFeature feature) const
inlineoverridevirtual

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 455 of file sqldatabase.cpp.

◆ open()

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

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 456 of file sqldatabase.cpp.


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