Class: QgsDatabaseTableComboBox

class qgis.gui.QgsDatabaseTableComboBox(provider: str, connection: str, schema: str = '', parent: QWidget = None)

Bases: PyQt5.QtWidgets.QWidget

Constructor for QgsDatabaseTableComboBox, for the specified provider and connection.

The optional schema argument can be used to restrict the listed tables to a specific schema.

Warning

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

QgsDatabaseTableComboBox(connection: QgsAbstractDatabaseProviderConnection, schema: str = ‘’, parent: QWidget = None) Constructor for QgsDatabaseTableComboBox, for the specified connection.

The optional schema argument can be used to restrict the listed tables to a specific schema.

Ownership of connection is transferred to the combobox.

The QgsDatabaseTableComboBox class is a combo box which displays the list of tables 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.

New in version 3.14.

Parameters
  • provider (str) –

  • connection (str) –

  • schema (str = '') –

  • parent

actionEvent()
allowEmptyTable(self) → bool

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

Return type

bool

changeEvent()
childEvent()
closeEvent()
comboBox(self) → QComboBox

Returns the combobox portion of the widget.

Return type

QComboBox

connectNotify()
contextMenuEvent()
create()
currentSchema(self) → str

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

Return type

str

currentTable(self) → str

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

Return type

str

customEvent()
destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
enterEvent()
event()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
initPainter()
inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
paintEvent()
receivers()
refreshTables(self)

Refreshes the list of available tables.

resizeEvent()
sender()
senderSignalIndex()
setAllowEmptyTable(self, allowEmpty: bool)

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

Parameters

allowEmpty (bool) –

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

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

Optionally the provider can be reset too.

Parameters
  • connection (str) –

  • provider (str = '') –

setSchema(self, schema: str)

Sets the schema from which to retrieve the available tables.

Parameters

schema (str) –

setTable(self, table: str, schema: str = '')

Sets the current table selected in the combo box.

If necessary, the schema can be specified too.

Parameters
  • table (str) –

  • schema (str = '') –

sharedPainter()
showEvent()
tableChanged

Emitted whenever the currently selected table changes. [signal]

Parameters
  • table (str) –

  • schema (str = '') –

tabletEvent()
timerEvent()
updateMicroFocus()
wheelEvent()