DbaClientX.psm1
|
# DbaClientX bootstrapper # Auto-generated by PowerForge. Do not edit. # Get library name, from the PSM1 file name $LibraryName = 'DBAClientX.PowerShell' $Library = "$LibraryName.dll" $Class = "$LibraryName.Initialize" $LibRoot = [IO.Path]::Combine($PSScriptRoot, 'Lib') $AssemblyFolders = Get-ChildItem -LiteralPath $LibRoot -Directory -ErrorAction SilentlyContinue $Default = $false $Core = $false $Standard = $false foreach ($A in $AssemblyFolders.Name) { if ($A -eq 'Default') { $Default = $true } elseif ($A -eq 'Core') { $Core = $true } elseif ($A -eq 'Standard') { $Standard = $true } } if ($Standard -and $Core -and $Default) { $FrameworkNet = 'Default' $Framework = 'Standard' } elseif ($Standard -and $Core) { $Framework = 'Standard' $FrameworkNet = 'Standard' } elseif ($Core -and $Default) { $Framework = 'Core' $FrameworkNet = 'Default' } elseif ($Standard -and $Default) { $Framework = 'Standard' $FrameworkNet = 'Default' } elseif ($Standard) { $Framework = 'Standard' $FrameworkNet = 'Standard' } elseif ($Core) { $Framework = 'Core' $FrameworkNet = '' } elseif ($Default) { $Framework = 'Default' $FrameworkNet = 'Default' } else { Write-Error -Message 'No assemblies found' return } if ($PSEdition -eq 'Core') { $LibFolder = $Framework } else { $LibFolder = $FrameworkNet } # Ensure native runtime libraries are discoverable on Windows $IsWindowsPlatform = [System.Runtime.InteropServices.RuntimeInformation]::IsOSPlatform([System.Runtime.InteropServices.OSPlatform]::Windows) # Skip probing when the current host cannot resolve a Windows-facing Lib folder (for example Desktop + Core-only payloads). if ($IsWindowsPlatform -and $LibFolder) { $Arch = [System.Runtime.InteropServices.RuntimeInformation]::ProcessArchitecture # PowerShell switch matches the Architecture enum by its string representation here. $ArchFolder = switch ($Arch) { 'X64' { 'win-x64' } 'X86' { 'win-x86' } 'Arm64' { 'win-arm64' } 'Arm' { 'win-arm' } default { Write-Warning -Message ("Unknown Windows architecture '{0}'. Falling back to win-x64 native runtime probing." -f $Arch) 'win-x64' } } $NativePath = Join-Path -Path $PSScriptRoot -ChildPath ("Lib\{0}\runtimes\{1}\native" -f $LibFolder, $ArchFolder) $PathEntries = if ([string]::IsNullOrWhiteSpace($env:PATH)) { @() } else { @($env:PATH -split [IO.Path]::PathSeparator) } if ((Test-Path -LiteralPath $NativePath) -and ($PathEntries -notcontains $NativePath)) { # Prepend the module-native runtime path so the packaged payload wins over unrelated machine-wide copies. if ([string]::IsNullOrWhiteSpace($env:PATH)) { $env:PATH = $NativePath } else { $env:PATH = "$NativePath$([IO.Path]::PathSeparator)$env:PATH" } } } try { $ImportModule = Get-Command -Name Import-Module -Module Microsoft.PowerShell.Core $ModuleAssemblyPath = [IO.Path]::Combine($PSScriptRoot, 'Lib', $LibFolder, $Library) if ($PSEdition -eq 'Core') { $LoaderAssemblyPath = [IO.Path]::Combine($PSScriptRoot, 'Lib', $LibFolder, 'DbaClientX.ModuleLoadContext.dll') if (-not ('DbaClientX.ModuleLoadContext.ModuleAssemblyLoadContext' -as [type])) { Add-Type -Path $LoaderAssemblyPath -ErrorAction Stop } $ModuleAssembly = [DbaClientX.ModuleLoadContext.ModuleAssemblyLoadContext]::LoadModule($ModuleAssemblyPath, 'DbaClientX') $InnerModule = & $ImportModule -Assembly $ModuleAssembly -Force -PassThru -ErrorAction Stop # Type accelerator registration relies on $ModuleAssembly and $LibFolder from this ALC loader scope. $RegisterPowerForgeAssemblyTypeAccelerators = { param( [Parameter(Mandatory = $true)][System.Reflection.Assembly] $ModuleAssembly, [Parameter(Mandatory = $true)][string] $LibFolder ) $Mode = 'Assembly' $RequestedTypes = @() $RequestedAssemblies = @('DbaClientX.Core', 'DbaClientX.SqlServer', 'DbaClientX.MySql', 'DbaClientX.Oracle', 'DbaClientX.PostgreSql', 'DbaClientX.SQLite', 'DBAClientX.PowerShell') if ($null -eq $ModuleAssembly) { Write-Warning -Message 'Module assembly was not available. ALC dependency type exposure is disabled.' return } if ([string]::IsNullOrWhiteSpace($LibFolder)) { Write-Warning -Message 'Module library folder was not available. ALC dependency type exposure is disabled.' return } $PowerForgeAlcLibraryDirectory = $null if ([IO.Path]::IsPathRooted($LibFolder)) { $PowerForgeAlcLibraryDirectory = [IO.Path]::GetFullPath($LibFolder) } elseif ($LibFolder.Contains('..') -or $LibFolder.IndexOfAny([IO.Path]::GetInvalidFileNameChars()) -ge 0) { Write-Warning -Message "Module library folder '$LibFolder' must be a simple folder name or a rooted development binary directory. ALC dependency type exposure is disabled." return } else { $PowerForgeAlcLibraryDirectory = [IO.Path]::Combine($PSScriptRoot, 'Lib', $LibFolder) } if ($Mode -eq 'AllowList' -and $RequestedTypes.Count -eq 0) { Write-Warning -Message 'AllowList type accelerator mode was configured without type names. No ALC dependency type accelerators will be registered.' return } if (($Mode -eq 'Assembly' -or $Mode -eq 'Enums') -and $RequestedAssemblies.Count -eq 0) { if ($RequestedTypes.Count -eq 0) { Write-Warning -Message "$Mode type accelerator mode was configured without assembly names or type names. No ALC dependency type accelerators will be registered." return } Write-Warning -Message "$Mode type accelerator mode was configured without assembly names. Only explicitly configured type names will be registered." } $TypeAccelerators = [psobject].Assembly.GetType('System.Management.Automation.TypeAccelerators') if ($null -eq $TypeAccelerators) { Write-Warning -Message 'PowerShell type accelerator APIs are not available. ALC dependency type exposure is disabled.' return } $AddTypeAccelerator = $TypeAccelerators.GetMethod('Add', [type[]]@([string], [type])) $GetTypeAccelerators = $TypeAccelerators.GetProperty('Get', [System.Reflection.BindingFlags] 'Static,Public,NonPublic') if ($null -eq $AddTypeAccelerator -or $null -eq $GetTypeAccelerators) { Write-Warning -Message 'PowerShell type accelerator APIs are incomplete. ALC dependency type exposure is disabled.' return } $ModuleAlc = [System.Runtime.Loader.AssemblyLoadContext]::GetLoadContext($ModuleAssembly) if ($null -eq $ModuleAlc) { Write-Warning -Message 'Unable to resolve the module AssemblyLoadContext. ALC dependency type exposure is disabled.' return } if ($null -eq $script:PowerForgeRegisteredAssemblyTypeAccelerators) { $script:PowerForgeRegisteredAssemblyTypeAccelerators = @{} } $ImportPowerForgeAlcAssembly = { param([Parameter(Mandatory = $true)][string] $AssemblyName) foreach ($Assembly in $ModuleAlc.Assemblies) { if ($Assembly.GetName().Name -eq $AssemblyName) { return $Assembly } } try { return $ModuleAlc.LoadFromAssemblyName([System.Reflection.AssemblyName]::new($AssemblyName)) } catch { $AssemblyPath = [IO.Path]::Combine($PowerForgeAlcLibraryDirectory, $AssemblyName + '.dll') if (Test-Path -LiteralPath $AssemblyPath) { try { $AssemblyNameObject = [System.Reflection.AssemblyName]::GetAssemblyName($AssemblyPath) return $ModuleAlc.LoadFromAssemblyName($AssemblyNameObject) } catch { Write-Warning -Message "Could not load ALC assembly '$AssemblyName' for type accelerator exposure: $($_.Exception.Message)" } } } return $null } $FindPowerForgeAlcType = { param([Parameter(Mandatory = $true)][string] $TypeName) foreach ($Assembly in $ModuleAlc.Assemblies) { $Type = $Assembly.GetType($TypeName, $false, $false) if ($null -ne $Type) { return $Type } } $LibDirectory = $PowerForgeAlcLibraryDirectory if (-not (Test-Path -LiteralPath $LibDirectory)) { return $null } foreach ($File in Get-ChildItem -LiteralPath $LibDirectory -Filter '*.dll' -File -ErrorAction SilentlyContinue) { try { $AssemblyName = [System.Reflection.AssemblyName]::GetAssemblyName($File.FullName) $Assembly = & $ImportPowerForgeAlcAssembly -AssemblyName $AssemblyName.Name if ($null -eq $Assembly) { continue } $Type = $Assembly.GetType($TypeName, $false, $false) if ($null -ne $Type) { return $Type } } catch { continue } } return $null } $AddPowerForgeTypeAccelerator = { param([Parameter(Mandatory = $true)][type] $Type) if ([string]::IsNullOrWhiteSpace($Type.FullName)) { return } $Name = $Type.FullName $Existing = $GetTypeAccelerators.GetValue($null) if ($Existing.ContainsKey($Name)) { $ExistingType = $Existing[$Name] if ([object]::ReferenceEquals($ExistingType, $Type)) { return } else { $ExistingAssemblyName = $ExistingType.Assembly.GetName() $TypeAssemblyName = $Type.Assembly.GetName() $ExistingLoadContext = [System.Runtime.Loader.AssemblyLoadContext]::GetLoadContext($ExistingType.Assembly) $TypeLoadContext = [System.Runtime.Loader.AssemblyLoadContext]::GetLoadContext($Type.Assembly) if ([object]::ReferenceEquals($ExistingLoadContext, $TypeLoadContext) -and [object]::Equals($ExistingAssemblyName.FullName, $TypeAssemblyName.FullName)) { Write-Verbose -Message "Type accelerator '$Name' already exists in the same AssemblyLoadContext from the same assembly identity. Keeping the existing accelerator and skipping the duplicate type from $($TypeAssemblyName.Name)." } else { Write-Warning -Message "Type accelerator '$Name' already exists from $($ExistingAssemblyName.FullName). Keeping the existing accelerator and skipping the ALC type from $($TypeAssemblyName.FullName)." } } return } try { $AddTypeAccelerator.Invoke($null, @($Name, $Type)) | Out-Null } catch { Write-Warning -Message "Type accelerator '$Name' could not be registered from $($Type.Assembly.GetName().Name): $($_.Exception.Message)" return } $script:PowerForgeRegisteredAssemblyTypeAccelerators[$Name] = $Type } if ($Mode -eq 'Assembly' -or $Mode -eq 'Enums') { foreach ($AssemblyName in $RequestedAssemblies) { $Assembly = & $ImportPowerForgeAlcAssembly -AssemblyName $AssemblyName if ($null -eq $Assembly) { Write-Warning -Message "Assembly '$AssemblyName' was not found in the module AssemblyLoadContext. No type accelerators were registered for it." continue } try { $ExportedTypes = @($Assembly.GetExportedTypes()) } catch { Write-Warning -Message "Could not enumerate exported types from assembly '$AssemblyName' for type accelerator exposure: $($_.Exception.Message)" continue } foreach ($Type in $ExportedTypes) { if ($Mode -eq 'Enums' -and -not $Type.IsEnum) { continue } & $AddPowerForgeTypeAccelerator -Type $Type } } } foreach ($TypeName in $RequestedTypes) { $Type = & $FindPowerForgeAlcType -TypeName $TypeName if ($null -eq $Type) { Write-Warning -Message "Type '$TypeName' was not found in the module AssemblyLoadContext. No type accelerator was registered." continue } & $AddPowerForgeTypeAccelerator -Type $Type } if ($script:PowerForgeAssemblyTypeAcceleratorCleanupRegistered -ne $true) { $script:PowerForgeAssemblyTypeAcceleratorCleanupRegistered = $true $PreviousPowerForgeOnRemove = $ExecutionContext.SessionState.Module.OnRemove $ExecutionContext.SessionState.Module.OnRemove = { try { $TypeAccelerators = [psobject].Assembly.GetType('System.Management.Automation.TypeAccelerators') if ($null -eq $TypeAccelerators -or $null -eq $script:PowerForgeRegisteredAssemblyTypeAccelerators) { return } $GetTypeAccelerators = $TypeAccelerators.GetProperty('Get', [System.Reflection.BindingFlags] 'Static,Public,NonPublic') $RemoveTypeAccelerator = $TypeAccelerators.GetMethod('Remove', [type[]]@([string])) if ($null -eq $GetTypeAccelerators -or $null -eq $RemoveTypeAccelerator) { return } $Existing = $GetTypeAccelerators.GetValue($null) foreach ($Entry in @($script:PowerForgeRegisteredAssemblyTypeAccelerators.GetEnumerator())) { if ($Existing.ContainsKey($Entry.Key) -and [object]::ReferenceEquals($Existing[$Entry.Key], $Entry.Value)) { $RemoveTypeAccelerator.Invoke($null, @($Entry.Key)) | Out-Null } } } finally { if ($null -ne $PreviousPowerForgeOnRemove) { & $PreviousPowerForgeOnRemove @args } } }.GetNewClosure() } } # Type accelerator exposure is PowerShell Core-only because it depends on AssemblyLoadContext. try { & $RegisterPowerForgeAssemblyTypeAccelerators -ModuleAssembly $ModuleAssembly -LibFolder $LibFolder } catch { Write-Warning -Message "ALC type accelerator registration failed: $($_.Exception.Message)" } if ($InnerModule) { # Import-Module -Assembly loads the inner binary module into its own module object. PowerShell has no # public API to copy those exported cmdlets back to the script-module wrapper, so this uses the same # private PSModuleInfo hook used by community ALC loaders. This runs on first load and reloads so the # outer script module always re-exports cmdlets from the ALC-loaded binary module. $AddExportedCmdlet = [System.Management.Automation.PSModuleInfo].GetMethod( 'AddExportedCmdlet', [System.Reflection.BindingFlags]'Instance, NonPublic' ) if ($null -ne $AddExportedCmdlet) { foreach ($Cmd in $InnerModule.ExportedCmdlets.Values) { $AddExportedCmdlet.Invoke($ExecutionContext.SessionState.Module, @(, $Cmd)) | Out-Null } $AddExportedAlias = [System.Management.Automation.PSModuleInfo].GetMethod( 'AddExportedAlias', [System.Reflection.BindingFlags]'Instance, NonPublic' ) if ($null -ne $AddExportedAlias) { foreach ($Alias in $InnerModule.ExportedAliases.Values) { $AliasTarget = if ([string]::IsNullOrWhiteSpace($Alias.Definition)) { $Alias.ResolvedCommandName } else { $Alias.Definition } try { # The alias must exist in this module scope before the private export table can reference it. Set-Alias -Name $Alias.Name -Value $AliasTarget -Scope Local -Force -ErrorAction Stop $ExportedAlias = $ExecutionContext.SessionState.InvokeCommand.GetCommand($Alias.Name, [System.Management.Automation.CommandTypes]::Alias) if ($null -ne $ExportedAlias) { $AddExportedAlias.Invoke($ExecutionContext.SessionState.Module, @(, $ExportedAlias)) | Out-Null } else { Write-Warning -Message "Alias '$($Alias.Name)' from $LibraryName was created but could not be resolved for export." } } catch { Write-Warning -Message "Alias '$($Alias.Name)' from $LibraryName could not be re-exported: $($_.Exception.Message)" } } } else { Write-Warning -Message "AddExportedAlias is not available on this PowerShell version. Aliases from $LibraryName will not be re-exported to the module scope." } } else { Write-Warning -Message "AddExportedCmdlet is not available on this PowerShell version. Falling back to direct Import-Module; cmdlets from $LibraryName will load from the default context." & $ImportModule $ModuleAssemblyPath -ErrorAction Stop } } } elseif (-not ($Class -as [type])) { & $ImportModule $ModuleAssemblyPath -ErrorAction Stop } else { $Type = "$Class" -as [Type] & $ImportModule -Force -Assembly ($Type.Assembly) } } catch { if ($ErrorActionPreference -eq 'Stop') { throw } else { Write-Warning -Message "Importing module $Library failed. Fix errors before continuing. Error: $($_.Exception.Message)" } } if ($PSEdition -ne 'Core') { # Core loads dependencies through the module-scoped AssemblyLoadContext above. Dot-sourcing the libraries script # there would load dependency DLLs into the default context and undo the isolation this template exists to provide. $LibrariesScript = [IO.Path]::Combine($PSScriptRoot, 'DbaClientX.Libraries.ps1') if (Test-Path -LiteralPath $LibrariesScript) { . $LibrariesScript } } $FunctionsToExport = @() $CmdletsToExport = @('ConvertTo-DbaXParameterMap', 'Copy-DbaXTableData', 'Get-DbaXMetadata', 'Get-DbaXProviderCapability', 'Get-DbaXSQLiteDiagnostics', 'Get-DbaXSqlServerManagement', 'Get-DbaXSqlServerMonitoring', 'Get-DbaXTableCopyPlan', 'Invoke-DbaXBulkInsert', 'Invoke-DbaXMySql', 'Invoke-DbaXMySqlNonQuery', 'Invoke-DbaXMySqlScalar', 'Invoke-DbaXMySqlTransaction', 'Invoke-DbaXNonQuery', 'Invoke-DbaXOracle', 'Invoke-DbaXOracleNonQuery', 'Invoke-DbaXOracleScalar', 'Invoke-DbaXOracleTransaction', 'Invoke-DbaXPostgreSql', 'Invoke-DbaXPostgreSqlNonQuery', 'Invoke-DbaXPostgreSqlTransaction', 'Invoke-DbaXQuery', 'Invoke-DbaXQueryStream', 'Invoke-DbaXSQLite', 'Invoke-DbaXSQLiteMaintenance', 'Invoke-DbaXSQLiteTransaction', 'Invoke-DbaXStoredProcedure', 'Invoke-DbaXTransaction', 'New-DbaXConnectionString', 'New-DbaXQuery', 'New-DbaXTableCopyDefinition', 'New-DbaXTableCopyPlan', 'Test-DbaXConnection', 'Write-DbaXTableData') $AliasesToExport = @() Export-ModuleMember -Function $FunctionsToExport -Alias $AliasesToExport -Cmdlet $CmdletsToExport |