Class: QgsDatabaseSchemaComboBox¶

A combo box which displays the list of schemas for a specific database connection.

Warning

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

Added in version 3.14.

Class Hierarchy¶

Base classes¶

QWidget
QObject
QPaintDevice

class qgis.gui.QgsDatabaseSchemaComboBox[source]¶

Bases: QWidget

__init__(provider: str | None, connection: str | None, parent: QWidget | None = None)

Constructor for QgsDatabaseSchemaComboBox, for the specified provider and connection.

Warning

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

Parameters:

provider (Optional[str])
connection (Optional[str])
parent (Optional[QWidget] = None)

__init__(connection: QgsAbstractDatabaseProviderConnection | None, parent: QWidget | None = None)

Constructor for QgsDatabaseSchemaComboBox, for the specified connection.

Ownership of connection is transferred to the combobox.

Parameters:

connection (Optional[QgsAbstractDatabaseProviderConnection])
parent (Optional[QWidget] = None)

allowEmptySchema(self) → bool[source]¶

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

See also

setAllowEmptySchema()

Return type:: bool

comboBox(self) → QComboBox | None[source]¶

Returns the combobox portion of the widget.

Return type:: Optional[QComboBox]

currentSchema(self) → str[source]¶

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

Return type:: str

refreshSchemas(self)[source]¶: Refreshes the list of available schemas.

signal schemaChanged[source]¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

setAllowEmptySchema(self, allowEmpty: bool)[source]¶

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