SQL Programming

Database integration for Qt applications.

This overview assumes that you have at least a basic knowledge of SQL. You should be able to understand simple SELECT, INSERT, UPDATE, and DELETE statements. Although the QSqlTableModel class provides an interface to database browsing and editing that does not require a knowledge of SQL, a basic understanding of SQL is highly recommended. A standard text covering SQL databases is An Introduction to Database Systems (7th Ed.) by C. J. Date, ISBN 0201385902.

Database Classes

These classes provide access to SQL databases.

qsql.html

The QSql namespace contains miscellaneous identifiers used throughout the Qt SQL module.

PySide6.QtSql.QSqlDriverCreatorBase

The QSqlDriverCreatorBase class is the base class for SQL driver factories.

QSqlDriverCreator

The QSqlDriverCreator class is a template class that provides a SQL driver factory for a specific driver type.

PySide6.QtSql.QSqlDatabase

The QSqlDatabase class handles a connection to a database.

PySide6.QtSql.QSqlDriver

The QSqlDriver class is an abstract base class for accessing specific SQL databases.

PySide6.QtSql.QSqlError

The QSqlError class provides SQL database error information.

PySide6.QtSql.QSqlField

The QSqlField class manipulates the fields in SQL database tables and views.

PySide6.QtSql.QSqlIndex

The QSqlIndex class provides functions to manipulate and describe database indexes.

PySide6.QtSql.QSqlQuery

The QSqlQuery class provides a means of executing and manipulating SQL statements.

PySide6.QtSql.QSqlRecord

The QSqlRecord class encapsulates a database record.

PySide6.QtSql.QSqlResult

The QSqlResult class provides an abstract interface for accessing data from specific SQL databases.

PySide6.QtSql.QSqlQueryModel

The QSqlQueryModel class provides a read-only data model for SQL result sets.

PySide6.QtSql.QSqlRelationalTableModel

The QSqlRelationalTableModel class provides an editable data model for a single database table, with foreign key support.

PySide6.QtSql.QSqlTableModel

The QSqlTableModel class provides an editable data model for a single database table.

The SQL classes are divided into three layers:

Driver Layer

This comprises the classes QSqlDriver , QSqlDriverCreator , QSqlDriverCreatorBase , QSqlDriverPlugin , and QSqlResult .

This layer provides the low-level bridge between the specific databases and the SQL API layer. See SQL Database Drivers for more information.

SQL API Layer

These classes provide access to databases. Connections are made using the QSqlDatabase class. Database interaction is achieved by using the QSqlQuery class. In addition to QSqlDatabase and QSqlQuery , the SQL API layer is supported by QSqlError , QSqlField , QSqlIndex , and QSqlRecord .

User Interface Layer

These classes link the data from a database to data-aware widgets. They include QSqlQueryModel , QSqlTableModel , and QSqlRelationalTableModel . These classes are designed to work with Qt’s model/view framework .

Note that a QCoreApplication object must be instantiated before using any of these classes.