Class: QgsProcessingParameterDatabaseTable

class qgis.core.QgsProcessingParameterDatabaseTable

Bases: QgsProcessingParameterDefinition

A database table name parameter for processing algorithms, allowing users to select from existing database tables on a registered database connection (or optionally to enter a new table name).

QgsProcessingParameterDatabaseTable should be evaluated by calling QgsProcessingAlgorithm.parameterAsDatabaseTableName().

New in version 3.14.

QgsProcessingParameterDatabaseTable(name: str, description: str, connectionParameterName: str = ‘’, schemaParameterName: str = ‘’, defaultValue: Any = None, optional: bool = False, allowNewTableNames: bool = False) Constructor for QgsProcessingParameterDatabaseTable.

The connectionParameterName specifies the name of the parent QgsProcessingParameterProviderConnection parameter. The schemaParameterName specifies the name of the parent QgsProcessingParameterDatabaseSchema parameter.

Warning

The provider must support the connection API methods in its QgsProviderMetadata implementation in order for the model to work correctly. This is only implemented for a subset of current data providers.

QgsProcessingParameterDatabaseTable(QgsProcessingParameterDatabaseTable)

Methods

allowNewTableNames

Returns True if the parameter allows users to enter names for a new (non-existing) tables.

asPythonString

param outputType

asScriptCode

rtype

str

checkValueIsAcceptable

param input

clone

rtype

QgsProcessingParameterDefinition

dependsOnOtherParameters

rtype

List[str]

fromScriptCode

Creates a new parameter using the definition from a script code.

fromVariantMap

param map

parentConnectionParameterName

Returns the name of the parent connection parameter, or an empty string if this is not set.

parentSchemaParameterName

Returns the name of the parent schema parameter, or an empty string if this is not set.

setAllowNewTableNames

Sets whether the parameter allows users to enter names for a new (non-existing) tables.

setParentConnectionParameterName

Sets the name of the parent connection parameter.

setParentSchemaParameterName

Sets the name of the parent schema parameter.

toVariantMap

rtype

Dict[str, Any]

type

rtype

str

typeName

Returns the type name for the parameter class.

valueAsPythonString

param value

allowNewTableNames(self)bool

Returns True if the parameter allows users to enter names for a new (non-existing) tables.

Return type

bool

asPythonString(self, outputType: QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass)str
Parameters

outputType (QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass) –

Return type

str

asScriptCode(self)str
Return type

str

checkValueIsAcceptable(self, input: Any, context: QgsProcessingContext = None)bool
Parameters
Return type

bool

clone(self)QgsProcessingParameterDefinition
Return type

QgsProcessingParameterDefinition

dependsOnOtherParameters(self)List[str]
Return type

List[str]

fromScriptCode(name: str, description: str, isOptional: bool, definition: str)QgsProcessingParameterDatabaseTable

Creates a new parameter using the definition from a script code.

Parameters
  • name (str) –

  • description (str) –

  • isOptional (bool) –

  • definition (str) –

Return type

QgsProcessingParameterDatabaseTable

fromVariantMap(self, map: Dict[str, Any])bool
Parameters

map (Dict[str) –

Return type

bool

parentConnectionParameterName(self)str

Returns the name of the parent connection parameter, or an empty string if this is not set.

Return type

str

parentSchemaParameterName(self)str

Returns the name of the parent schema parameter, or an empty string if this is not set.

Return type

str

setAllowNewTableNames(self, allowed: bool)

Sets whether the parameter allows users to enter names for a new (non-existing) tables.

Parameters

allowed (bool) –

setParentConnectionParameterName(self, name: str)

Sets the name of the parent connection parameter. Use an empty string if this is not required.

Parameters

name (str) –

setParentSchemaParameterName(self, name: str)

Sets the name of the parent schema parameter. Use an empty string if this is not required.

Parameters

name (str) –

toVariantMap(self)Dict[str, Any]
Return type

Dict[str, Any]

type(self)str
Return type

str

typeName()str

Returns the type name for the parameter class.

Return type

str

valueAsPythonString(self, value: Any, context: QgsProcessingContext)str
Parameters
Return type

str