Class: QgsDatabaseSchemaModel

class qgis.core.QgsDatabaseSchemaModel(provider: str, connection: str, parent: QObject = None)

Bases: PyQt5.QtCore.QAbstractItemModel

Constructor for QgsDatabaseSchemaModel, for the specified provider and connection name.

Warning

The provider must support the connection API methods in its QgsProviderMetadata implementation in order for the model to work correctly.

QgsDatabaseSchemaModel(connection: QgsAbstractDatabaseProviderConnection, parent: QObject = None) Constructor for QgsDatabaseSchemaModel, for the specified connection.

Ownership of connection is transferred to the model.

A model containing schemas from a database connection.

This class does not automatically subscribe to database updates. Schemas are queried from the database initially upon model construction. In order to update the listed schemas, QgsDatabaseSchemaModel.refresh() must be manually called.

New in version 3.14.

Parameters
  • provider (str) –

  • connection (str) –

  • parent

class Role

Bases: int

RoleEmpty = 256
allowEmptySchema(self) → bool

Returns True if the model allows the empty schema (“not set”) choice.

Return type

bool

beginInsertColumns()
beginInsertRows()
beginMoveColumns()
beginMoveRows()
beginRemoveColumns()
beginRemoveRows()
beginResetModel()
changePersistentIndex()
changePersistentIndexList()
childEvent()
columnCount(self, parent: QModelIndex = QModelIndex()) → int
Parameters

parent (QModelIndex = QModelIndex()) –

Return type

int

connectNotify()
createIndex()
customEvent()
data(self, index: QModelIndex, role: int = Qt.DisplayRole) → Any
Parameters
  • index (QModelIndex) –

  • role (int = Qt.DisplayRole) –

Return type

Any

decodeData()
disconnectNotify()
encodeData()
endInsertColumns()
endInsertRows()
endMoveColumns()
endMoveRows()
endRemoveColumns()
endRemoveRows()
endResetModel()
index(self, row: int, column: int, parent: QModelIndex) → QModelIndex
Parameters
  • row (int) –

  • column (int) –

  • parent (QModelIndex) –

Return type

QModelIndex

isSignalConnected()
parent(self, child: QModelIndex) → QModelIndex
Parameters

child (QModelIndex) –

Return type

QModelIndex

persistentIndexList()
receivers()
refresh(self)

Refreshes the schema list by querying the underlying connection.

resetInternalData()
rowCount(self, parent: QModelIndex = QModelIndex()) → int
Parameters

parent (QModelIndex = QModelIndex()) –

Return type

int

sender()
senderSignalIndex()
setAllowEmptySchema(self, allowEmpty: bool)

Sets whether an optional empty schema (“not set”) option is present in the model.

Parameters

allowEmpty (bool) –

timerEvent()