Class: QgsDatabaseTableComboBox

class qgis.gui.QgsDatabaseTableComboBox

Bases: PyQt5.QtWidgets.QWidget

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.

QgsDatabaseTableComboBox(provider: str, connection: str, schema: str = ‘’, parent: QWidget = None) 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.

Methods

actionEvent

allowEmptyTable

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

changeEvent

childEvent

closeEvent

comboBox

Returns the combobox portion of the widget.

connectNotify

contextMenuEvent

create

currentSchema

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

currentTable

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

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

Refreshes the list of available tables.

resizeEvent

sender

senderSignalIndex

setAllowEmptyTable

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

setConnectionName

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

setSchema

Sets the schema from which to retrieve the available tables.

setTable

Sets the current table selected in the combo box.

sharedPainter

showEvent

tabletEvent

timerEvent

updateMicroFocus

wheelEvent

Signals

tableChanged

Emitted whenever the currently selected table changes.

actionEvent(self, QActionEvent)
allowEmptyTable(self)bool

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

Return type

bool

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

Returns the combobox portion of the widget.

Return type

QComboBox

connectNotify(self, QMetaMethod)
contextMenuEvent(self, QContextMenuEvent)
create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
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(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
refreshTables(self)

Refreshes the list of available tables.

resizeEvent(self, QResizeEvent)
sender(self)QObject
senderSignalIndex(self)int
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(self)QPainter
showEvent(self, QShowEvent)
tableChanged

Emitted whenever the currently selected table changes. [signal]

Parameters
  • table (str) –

  • schema (str = '') –

tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
updateMicroFocus(self)
wheelEvent(self, QWheelEvent)