Class: QgsProcessingParameterDatabaseSchema¶
- class qgis.core.QgsProcessingParameterDatabaseSchema(name: str, description: str, connectionParameterName: str = '', defaultValue: Any = None, optional: bool = False)¶
Bases:
QgsProcessingParameterDefinition
Constructor for QgsProcessingParameterDatabaseSchema.
The
connectionParameterName
specifies the name of the parentQgsProcessingParameterProviderConnection
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.QgsProcessingParameterDatabaseSchema(
QgsProcessingParameterDatabaseSchema
)A database schema parameter for processing algorithms, allowing users to select from existing schemas on a registered database connection.
QgsProcessingParameterDatabaseSchema
should be evaluated by callingQgsProcessingAlgorithm.parameterAsSchema()
.Methods
- param outputType
- rtype
str
- param input
- rtype
QgsProcessingParameterDefinition
- 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.
Sets the
name
of the parent connection parameter.- rtype
Dict[str, Any]
- rtype
str
Returns the type name for the parameter class.
- param value
- 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
input (Any) –
context (
QgsProcessingContext
= None) –
- Return type
bool
- clone(self) → QgsProcessingParameterDefinition¶
- Return type
- dependsOnOtherParameters(self) → List[str]¶
- Return type
List[str]
- fromScriptCode(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterDatabaseSchema¶
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
- 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) –
- 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