DataProviderParseJdbcConnectionString Method |
Parses a JDBC connection string and extracts provider-specific parameter values.
Namespace:
Dundas.BI.Data.DataProviders
Assembly:
Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (25.3.0.1000)
Syntaxpublic virtual ParameterValueCollection ParseJdbcConnectionString(
string jdbcConnectionString,
IReadOnlyList<ProviderProperty>? providerProperties = null
)
Public Overridable Function ParseJdbcConnectionString (
jdbcConnectionString As String,
Optional providerProperties As IReadOnlyList(Of ProviderProperty) = Nothing
) As ParameterValueCollection
public:
virtual ParameterValueCollection^ ParseJdbcConnectionString(
String^ jdbcConnectionString,
IReadOnlyList<ProviderProperty^>^ providerProperties = nullptr
)
abstract ParseJdbcConnectionString :
jdbcConnectionString : string *
?providerProperties : IReadOnlyList<ProviderProperty>
(* Defaults:
let _providerProperties = defaultArg providerProperties null
*)
-> ParameterValueCollection
override ParseJdbcConnectionString :
jdbcConnectionString : string *
?providerProperties : IReadOnlyList<ProviderProperty>
(* Defaults:
let _providerProperties = defaultArg providerProperties null
*)
-> ParameterValueCollection
Parameters
- jdbcConnectionString
- Type: SystemString
The JDBC connection string to parse. The string must follow the format specific to the JDBC provider, such
as "jdbc:sqlserver://localhost:1433;databaseName=TestDB;user=sa;password=your_password;encrypt=true;" or
"jdbc:postgresql://localhost:5432/TestDB?user=sa&password=your_password&ssl=true". - providerProperties (Optional)
- Type: System.Collections.GenericIReadOnlyListProviderProperty
A list of ProviderProperty to use instead of the the provider defaults.
Return Value
Type:
ParameterValueCollectionA
ParameterValueCollection containing the extracted parameter values, such as host, port,
database name, and any additional provider-specific parameters.
ExceptionsException | Condition |
---|
ArgumentException | Thrown if jdbcConnectionString is null, empty, or does not match the expected JDBC
connection string format. |
InvalidOperationException | Thrown if the JDBC parameter separator is not defined for the provider and the connection string contains
parameters. |
RemarksThis method validates the format of the provided JDBC connection string and extracts
key-value pairs based on the provider's expected format. If the connection string contains parameters, they
are resolved against the provider's property descriptors. The last occurrence of a parameter takes
precedence if duplicates are found.
See Also