ConnectionAttribute

Author: nvarscar

dbops.psm1

@@ -138,6 +138,7 @@ Set-PSFConfig -FullName dbops.Silent -Value $false -Initialize -Validation bool
 Set-PSFConfig -FullName dbops.Credential -Value $null -Initialize -Description "Database credentials to authenticate with."
 Set-PSFConfig -FullName dbops.Variables -Value $null -Initialize -Validation hashtable -Description "A hashtable with key/value pairs representing #{variables} that will be swapped during execution."
 Set-PSFConfig -FullName dbops.ConnectionString -Value $null -Initialize -Description "Connection string to the target database. If specified, overrides SqlInstance and Database parameters."
+Set-PSFConfig -FullName dbops.ConnectionAttribute -Value $null -Validation hashtable -Initialize -Description "Additional connection string parameters. Existing connection string will be augmented."
 Set-PSFConfig -FullName dbops.CreateDatabase -Value $false -Validation bool -Initialize -Description "Determines whether to create an empty database upon deployment if it haven't been created yet."
 Set-PSFConfig -FullName dbops.mail.Template -Value "bin\mail_template.htm" -Initialize -Description "Relative or absolute path to the email template file."
 Set-PSFConfig -FullName dbops.mail.SmtpServer -Value "" -Initialize -Description "Smtp server address."

functions/Install-DBOPackage.ps1

@@ -98,6 +98,10 @@
         Defines the driver to use when connecting to the database server.
         Available options: SqlServer (default), Oracle
 
+    .PARAMETER ConnectionAttribute
+        Additional connection string attributes that should be added to the existing connection string, provided as a hashtable.
+        For example to enable SYSDBA permissions in Oracle, use the following: -ConnectionAttribute @{ 'DBA Privilege' = 'SYSDBA' }
+
     .PARAMETER Confirm
         Prompts to confirm certain actions
 
@@ -167,7 +171,8 @@
         [AllowNull()]
         [string]$ConnectionString,
         [Alias('ConnectionType', 'ServerType')]
-        [DBOps.ConnectionType]$Type = (Get-DBODefaultSetting -Name rdbms.type -Value)
+        [DBOps.ConnectionType]$Type = (Get-DBODefaultSetting -Name rdbms.type -Value),
+        [hashtable]$ConnectionAttribute
     )
 
     begin {

functions/Install-DBOSqlScript.ps1

@@ -95,6 +95,10 @@
         Defines the driver to use when connecting to the database server.
         Available options: SqlServer (default), Oracle
 
+    .PARAMETER ConnectionAttribute
+        Additional connection string attributes that should be added to the existing connection string, provided as a hashtable.
+        For example to enable SYSDBA permissions in Oracle, use the following: -ConnectionAttribute @{ 'DBA Privilege' = 'SYSDBA' }
+
     .PARAMETER Confirm
         Prompts to confirm certain actions
 
@@ -163,7 +167,8 @@
         [AllowNull()]
         [string]$ConnectionString,
         [Alias('ConnectionType', 'ServerType')]
-        [DBOps.ConnectionType]$Type = (Get-DBODefaultSetting -Name rdbms.type -Value)
+        [DBOps.ConnectionType]$Type = (Get-DBODefaultSetting -Name rdbms.type -Value),
+        [hashtable]$ConnectionAttribute
     )
 
     begin {

functions/Invoke-DBOQuery.ps1

@@ -78,6 +78,10 @@ function Invoke-DBOQuery {
         Uses values in specified hashtable as parameters inside the SQL query.
         For example, <Invoke-DBOQuery -Query 'SELECT @p1' -Parameter @{ p1 = 1 }> would return "1" on SQL Server.
 
+    .PARAMETER ConnectionAttribute
+        Additional connection string attributes that should be added to the existing connection string, provided as a hashtable.
+        For example to enable SYSDBA permissions in Oracle, use the following: -ConnectionAttribute @{ 'DBA Privilege' = 'SYSDBA' }
+
     .PARAMETER Interactive
         Opens connection to the server and launches interactive session to query the server directly from the command line
 
@@ -152,6 +156,7 @@ function Invoke-DBOQuery {
         $As = "DataRow",
         [Alias('SqlParameters', 'SqlParameter', 'Parameters')]
         [System.Collections.IDictionary]$Parameter,
+        [hashtable]$ConnectionAttribute,
         [Parameter(Mandatory = $true,
             Position = 1,
             ParameterSetName = 'Interactive')]

functions/Register-DBOPackage.ps1

@@ -88,6 +88,10 @@ function Register-DBOPackage {
     .PARAMETER Build
         Only register certain builds from the package.
 
+    .PARAMETER ConnectionAttribute
+        Additional connection string attributes that should be added to the existing connection string, provided as a hashtable.
+        For example to enable SYSDBA permissions in Oracle, use the following: -ConnectionAttribute @{ 'DBA Privilege' = 'SYSDBA' }
+
     .PARAMETER Confirm
         Prompts to confirm certain actions
 
@@ -154,7 +158,8 @@ function Register-DBOPackage {
         [AllowNull()]
         [string]$ConnectionString,
         [Alias('ConnectionType', 'ServerType')]
-        [DBOps.ConnectionType]$Type = (Get-DBODefaultSetting -Name rdbms.type -Value)
+        [DBOps.ConnectionType]$Type = (Get-DBODefaultSetting -Name rdbms.type -Value),
+        [hashtable]$ConnectionAttribute
     )
 
     begin {

internal/classes/DBOps.class.ps1

@@ -1087,6 +1087,7 @@ class DBOpsConfig : DBOps {
     [string]$Schema
     [System.Nullable[bool]]$CreateDatabase
     [string]$ConnectionString
+    [psobject]$ConnectionAttribute
 
     hidden [DBOpsPackageBase]$Parent
 

internal/classes/DBOps.enums.ps1

@@ -23,6 +23,7 @@ namespace DBOps {
         Schema,
         ConnectionString,
         CreateDatabase,
+        ConnectionAttribute
     }
 }
 '@

internal/functions/Get-ConnectionString.ps1

@@ -5,6 +5,7 @@ function Get-ConnectionString {
         [DBOpsConfig]$Configuration,
         [Parameter(ParameterSetName = 'ConnString')]
         [string]$ConnectionString,
+        [hashtable]$ConnectionAttribute,
         [DBOps.ConnectionType]$Type,
         [switch]$Raw
     )
@@ -86,13 +87,29 @@ function Get-ConnectionString {
                 $csBuilder["Integrated Security"] = $true
             }
         }
+        # make attribute adjustments if any
+        if ($Configuration.ConnectionAttribute) {
+            foreach ($key in $Configuration.ConnectionAttribute.Keys) {
+                if ($csBuilder.ContainsKey($key)) {
+                    $csBuilder[$key] = $Configuration.ConnectionAttribute.$key
+                }
+            }
+        }
     }
     elseif ($Configuration) {
         $csBuilder = $builderType::new($Configuration.ConnectionString)
     }
     else {
         $csBuilder = $builderType::new($ConnectionString)
     }
+    # make attribute adjustments if any
+    if ($ConnectionAttribute) {
+        foreach ($key in $ConnectionAttribute.Keys) {
+            if ($csBuilder.ContainsKey($key)) {
+                $csBuilder[$key] = $ConnectionAttribute.$key
+            }
+        }
+    }
     # generate the connection string
     if ($Raw) {
         return $csBuilder

tests/DBOpsConfig.class.Tests.ps1

@@ -144,6 +144,9 @@ Describe "DBOpsConfig class tests" -Tag $commandName, UnitTests, DBOpsConfig {
             $config.Credential.GetNetworkCredential().Password  | Should Be $testPassword
             $config.SetValue('Credential', $null)
             $config.Credential | Should Be $null
+            #hashtable
+            $config.SetValue('ConnectionAttribute', @{ 'Connection Timeout' = 10 })
+            $config.ConnectionAttribute.'Connection Timeout' | Should -Be 10
             #Negatives
             { $config.SetValue('AppplicationName', 'MyApp3') } | Should Throw
         }