Class: QgsDatabaseSchemaComboBox

class qgis.gui.QgsDatabaseSchemaComboBox(provider: str, connection: str, parent: QWidget = None)

Bases: PyQt5.QtWidgets.QWidget

Constructor for QgsDatabaseSchemaComboBox, for the specified provider and connection.


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

QgsDatabaseSchemaComboBox(connection: QgsAbstractDatabaseProviderConnection, parent: QWidget = None) Constructor for QgsDatabaseSchemaComboBox, for the specified connection.

Ownership of connection is transferred to the combobox.

The QgsDatabaseSchemaComboBox class is a combo box which displays the list of schemas for a specific database connection.


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

New in version 3.14.

  • provider (str) –

  • connection (str) –

  • parent

actionEvent(self, QActionEvent)
allowEmptySchema(self) → bool

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

Return type


changeEvent(self, QEvent)
childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
comboBox(self) → QComboBox

Returns the combobox portion of the widget.

Return type


connectNotify(self, QMetaMethod)
contextMenuEvent(self, QContextMenuEvent)
create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
currentSchema(self) → str

Returns the name of the current schema selected in the combo box.

Return type


customEvent(self, QEvent)
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
disconnectNotify(self, QMetaMethod)
dragEnterEvent(self, QDragEnterEvent)
dragLeaveEvent(self, QDragLeaveEvent)
dragMoveEvent(self, QDragMoveEvent)
dropEvent(self, QDropEvent)
enterEvent(self, QEvent)
event(self, QEvent) → bool
focusInEvent(self, QFocusEvent)
focusNextChild(self) → bool
focusNextPrevChild(self, bool) → bool
focusOutEvent(self, QFocusEvent)
focusPreviousChild(self) → bool
hideEvent(self, QHideEvent)
initPainter(self, QPainter)
inputMethodEvent(self, QInputMethodEvent)
isSignalConnected(self, QMetaMethod) → bool
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
leaveEvent(self, QEvent)
metric(self, QPaintDevice.PaintDeviceMetric) → int
mouseDoubleClickEvent(self, QMouseEvent)
mouseMoveEvent(self, QMouseEvent)
mousePressEvent(self, QMouseEvent)
mouseReleaseEvent(self, QMouseEvent)
moveEvent(self, QMoveEvent)
nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr) → Tuple[bool, int]
paintEvent(self, QPaintEvent)
receivers(self, PYQT_SIGNAL) → int

Refreshes the list of available schemas.

resizeEvent(self, QResizeEvent)

Emitted whenever the currently selected schema changes. [signal]


schema (str) –

sender(self) → QObject
senderSignalIndex(self) → int
setAllowEmptySchema(self, allowEmpty: bool)

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


allowEmpty (bool) –

setConnectionName(self, connection: str, provider: str = '')

Sets the database connection name from which to retrieve the available schemas.

Optionally the provider can be reset too.

  • connection (str) –

  • provider (str = '') –

setSchema(self, schema: str)

Sets the current schema selected in the combo box.


schema (str) –

sharedPainter(self) → QPainter
showEvent(self, QShowEvent)
tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
wheelEvent(self, QWheelEvent)