Class: QgsProcessingParameterProviderConnection

class qgis.core.QgsProcessingParameterProviderConnection

Bases: QgsProcessingParameterDefinition

A data provider connection parameter for processing algorithms, allowing users to select from available registered connections for a particular data provider.

QgsProcessingParameterProviderConnection should be evaluated by calling QgsProcessingAlgorithm.parameterAsConnectionName().

New in version 3.14.

QgsProcessingParameterProviderConnection(name: str, description: str, provider: str, defaultValue: Any = None, optional: bool = False) Constructor for QgsProcessingParameterProviderConnection, for the specified provider type.

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.

QgsProcessingParameterProviderConnection(QgsProcessingParameterProviderConnection)

Methods

asPythonString

param outputType:

asScriptCode

rtype:

str

checkValueIsAcceptable

param input:

clone

rtype:

QgsProcessingParameterDefinition

defaultGuiValueFromSetting

Default gui value for an algorithm parameter from settings

fromScriptCode

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

fromVariantMap

param map:

providerId

Returns the ID of the provider associated with the connections.

setProviderId

Sets the ID of the provider associated with the connections.

toVariantMap

rtype:

Dict[str, Any]

type

rtype:

str

typeName

Returns the type name for the parameter class.

valueAsPythonString

param value:

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:
Return type:

bool

clone(self) QgsProcessingParameterDefinition
Return type:

QgsProcessingParameterDefinition

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

New in version 3.34.

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

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

Parameters:
  • name (str) –

  • description (str) –

  • isOptional (bool) –

  • definition (str) –

Return type:

QgsProcessingParameterProviderConnection

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

map (Dict[str) –

Return type:

bool

providerId(self) str

Returns the ID of the provider associated with the connections.

See also

setProviderId()

Return type:

str

setProviderId(self, provider: str)

Sets the ID of the provider associated with the connections.

See also

providerId()

Parameters:

provider (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