Class: QgsCodeEditorSQL

A SQL editor based on QScintilla2. Adds syntax highlighting and code autocompletion.

Note

may not be available in Python bindings, depending on platform support

QgsCodeEditorSQL containing sample SQL

Class Hierarchy

Base classes

QgsCodeEditor	A text editor based on QScintilla2.
QsciScintilla
QsciScintillaBase
QAbstractScrollArea
QFrame
QWidget
QObject
QPaintDevice

Methods

extraKeywords	Returns the extra keywords.
fieldNames	Returns field names from the lexer API.
setExtraKeywords	Set extra keywords to extraKeywords.
setFieldNames	Set field names to fieldNames to be added to the lexer API.
setFields	Set field names to be added to the lexer API.

class qgis.gui.QgsCodeEditorSQL

Bases: QgsCodeEditor

__init__(parent: QWidget | None = None)

Constructor for QgsCodeEditorSQL

Parameters:

parent (Optional[QWidget] = None)

extraKeywords(self) → List[str]

Returns the extra keywords.

Extra keywords are usually added from provider connections and represent function and other provider specific keywords.

Added in version 3.22.

Return type:

List[str]

fieldNames(self) → List[str]

Returns field names from the lexer API.

Added in version 3.22.

Return type:

List[str]

setExtraKeywords(self, extraKeywords: Iterable[str | None])

Set extra keywords to extraKeywords.

Extra keywords are usually added from provider connections and represent function and other provider specific keywords.

Added in version 3.22.

Parameters:

extraKeywords (Iterable[Optional[str]])

setFieldNames(self, fieldNames: Iterable[str | None])

Set field names to fieldNames to be added to the lexer API.

Added in version 3.18.

Parameters:

fieldNames (Iterable[Optional[str]])

setFields(self, fields: QgsFields)

Set field names to be added to the lexer API.

Added in version 3.14.

Parameters:

fields (QgsFields)