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 callingQgsProcessingAlgorithm.parameterAsDatabaseTableName()
.Added 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 parentQgsProcessingParameterProviderConnection
parameter. TheschemaParameterName
specifies the name of the parentQgsProcessingParameterDatabaseSchema
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
Returns
True
if the parameter allows users to enter names for a new (non-existing) tables.- param outputType:
- rtype:
str
- param input:
- rtype:
QgsProcessingParameterDefinition
Default gui value for an algorithm parameter from settings
- rtype:
List[str]
Creates a new parameter using the definition from a script code.
- param map:
Returns the name of the parent connection parameter, or an empty string if this is not set.
Returns the name of the parent schema parameter, or an empty string if this is not set.
Sets whether the parameter allows users to enter names for a new (non-existing) tables.
Sets the
name
of the parent connection parameter.Sets the
name
of the parent schema parameter.- rtype:
Dict[str, Any]
- rtype:
str
Returns the type name for the parameter class.
- param value:
- allowNewTableNames(self) bool ¶
Returns
True
if the parameter allows users to enter names for a new (non-existing) tables.See also
- Return type:
bool
- asPythonString(self, outputType: QgsProcessing.PythonOutputType = QgsProcessing.PythonOutputType.PythonQgsProcessingAlgorithmSubclass) str ¶
- Parameters:
outputType (QgsProcessing.PythonOutputType = QgsProcessing.PythonOutputType.PythonQgsProcessingAlgorithmSubclass)
- Return type:
str
- asScriptCode(self) str ¶
- Return type:
str
- checkValueIsAcceptable(self, input: Any, context: QgsProcessingContext = None) bool ¶
- Parameters:
input (Any)
context (
QgsProcessingContext
= None)
- Return type:
bool
- clone(self) QgsProcessingParameterDefinition ¶
- Return type:
- defaultGuiValueFromSetting(self) Any ¶
Default gui value for an algorithm parameter from settings
- Returns:
default value from settings or invalid QVariant if there is no default value defined in the settings
Added in version 3.34.
- 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:
- 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.
See also
- Return type:
str
- parentSchemaParameterName(self) str ¶
Returns the name of the parent schema parameter, or an empty string if this is not set.
See also
- Return type:
str
- setAllowNewTableNames(self, allowed: bool)¶
Sets whether the parameter allows users to enter names for a new (non-existing) tables.
See also
- Parameters:
allowed (bool)
- setParentConnectionParameterName(self, name: str)¶
Sets the
name
of the parent connection parameter. Use an empty string if this is not required.See also
- Parameters:
name (str)
- setParentSchemaParameterName(self, name: str)¶
Sets the
name
of the parent schema parameter. Use an empty string if this is not required.See also
- 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:
value (Any)
context (QgsProcessingContext)
- Return type:
str