Class: QgsNewDatabaseTableNameWidget

class qgis.gui.QgsNewDatabaseTableNameWidget

Bases: QgsPanelWidget

The QgsNewDatabaseTableNameWidget class embeds the browser view to select a DB schema and a new table name.

The table name is validated for uniqueness and the selected data item provider, schema and table names can be retrieved with getters.


The data provider that originated the data item provider must support the connections API

New in version 3.14.

QgsNewDatabaseTableNameWidget(browserModel: QgsBrowserGuiModel = None, providersFilter: Iterable[str] = [], parent: QWidget = None) Constructs a new QgsNewDatabaseTableNameWidget


Emitted when the OK/accept button is clicked. [signal]

actionEvent(self, QActionEvent)
changeEvent(self, QEvent)
childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
connectNotify(self, QMetaMethod)
contextMenuEvent(self, QContextMenuEvent)
create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
customEvent(self, QEvent)
dataProviderKey(self) str

Returns the currently selected data item provider key

Return type


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
isValid(self) bool

Returns True if the widget contains a valid new table name

Return type


keyPressEvent(self, event: QKeyEvent)

Overridden key press event to handle the esc event on the widget.


event – The key event

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)

This signal is emitted when the selects a data provider or a schema name that has a different data provider than the previously selected one.


providerKey (str) – the data provider key of the selected schema [signal]

receivers(self, PYQT_SIGNAL) int
resizeEvent(self, QResizeEvent)
schema(self) str

Returns the currently selected schema or file path (in case of filesystem-based DBs like spatialite or GPKG) for the new table

Return type



This signal is emitted when the user selects a schema (or file path for filesystem-based DBs like spatialite or GPKG).


schemaName (str) – the name of the selected schema [signal]

sender(self) QObject
senderSignalIndex(self) int
setAcceptButtonVisible(self, visible: bool)

Sets whether the optional “Ok”/accept button should be visible.

By default this is hidden, to better allow the widget to be embedded inside other widgets and dialogs.


visible (bool) –

sharedPainter(self) QPainter
showEvent(self, e: QShowEvent)

Scroll to last selected index and expand it’s children


e (QShowEvent) –

table(self) str

Returns the current name of the new table

Return type



This signal is emitted when the user enters a table name


tableName (str) – the name of the new table [signal]

tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
uri(self) str

Returns the (possibly blank) string representation of the new table data source URI. The URI might be invalid in case the widget is not in a valid state.

Return type



This signal is emitted when the URI of the new table changes, whether or not it is a valid one.


uri (str) – URI string representation [signal]


This signal is emitted whenever the validation status of the widget changes.


isValid (bool) – True if the current status of the widget is valid [signal]

validationError(self) str

Returns the validation error or an empty string is the widget status is valid

Return type


wheelEvent(self, QWheelEvent)