Merge branch 'development' into 'master'

Development

See merge request sanderstad/PSDatabaseClone!4

Author: sanderstad

LICENSE

@@ -1,4 +1,4 @@
-MIT License
+MIT License
 
 Copyright (c) 2018 Sander Stad
 

PSDatabaseClone.psd1

@@ -1,21 +1,21 @@
-@{
+@{
     # Script module or binary module file associated with this manifest
     ModuleToProcess   = 'PSDatabaseClone.psm1'
 
     # Version number of this module.
-    ModuleVersion     = '1.0.0.0'
+    ModuleVersion     = '0.1.0.0'
 
     # ID used to uniquely identify this module
     GUID              = '747980ca-0d3d-4529-b4fd-e6cdd059c62a'
 
     # Author of this module
-    Author            = 'sander'
+    Author            = 'Sander Stad'
 
     # Company or vendor of this module
-    CompanyName       = 'MyCompany'
+    CompanyName       = ''
 
     # Copyright statement for this module
-    Copyright         = 'Copyright (c) 2018 sander'
+    Copyright         = 'Copyright (c) 2018 Sander Stad'
 
     # Description of the functionality provided by this module
     Description       = 'Cloning module for SQL Server databases'
@@ -46,32 +46,33 @@
     )
 
     # Assemblies that must be loaded prior to importing this module
-    # RequiredAssemblies = @()
+    RequiredAssemblies = @("bin\PSDatabaseClone.dll")
 
     # Script files (.ps1) that are run in the caller's environment prior to
     # importing this module
     # ScriptsToProcess = @()
 
     # Type files (.ps1xml) to be loaded when importing this module
-    # TypesToProcess = @('xml\PSDatabasClone.Types.ps1xml')
+    # TypesToProcess = @('xml\PSDatabaseClone.Types.ps1xml')
 
     # Format files (.ps1xml) to be loaded when importing this module
-    # FormatsToProcess = @('xml\PSDatabasClone.Format.ps1xml')
+    # FormatsToProcess = @('xml\PSDatabaseClone.Format.ps1xml')
 
     # Modules to import as nested modules of the module specified in
     # ModuleToProcess
     # NestedModules = @()
 
     # Functions to export from this module
-    FunctionsToExport = 'Initialize-PDCVhdDisk',
-    'Invoke-PDCRepairClone',
-    'New-PDCClone',
-    'New-PDCImage',
-    'New-PDCVhdDisk',
-    'Remove-PDCClone',
-	'Remove-PDCImage',
-    'Set-PDCConfiguration',
-    'Get-PDCClone'
+    FunctionsToExport = 'Initialize-PSDCVhdDisk',
+    'Invoke-PSDCRepairClone',
+    'New-PSDCClone',
+    'New-PSDCImage',
+    'New-PSDCVhdDisk',
+    'Remove-PSDCClone',
+	'Remove-PSDCImage',
+    'Set-PSDCConfiguration',
+    'Get-PSDCClone',
+    'Get-PSDCImage'
 
     # Cmdlets to export from this module
     CmdletsToExport   = ''
@@ -104,12 +105,12 @@
             # ProjectUri = ''
 
             # A URL to an icon representing this module.
-            # IconUri = ''
+            IconUri = 'https://www.sqlstad.nl/wp-content/uploads/2018/07/PSDatabaseClone_Logo_128.png'
 
             # ReleaseNotes of this module
             # ReleaseNotes = ''
 
         } # End of PSData hashtable
 
     } # End of PrivateData hashtable
-}
+}

PSDatabaseClone.psm1

@@ -1,5 +1,5 @@
-$script:ModuleRoot = $PSScriptRoot
-$script:ModuleVersion = "1.0.0.0"
+$script:ModuleRoot = $PSScriptRoot
+$script:ModuleVersion = "0.1.0.0"
 
 function Import-ModuleFile
 {
@@ -32,8 +32,8 @@ function Import-ModuleFile
 }
 
 # Detect whether at some level dotsourcing was enforced
-$script:doDotSource = Get-PSFConfigValue -FullName PSDatabasClone.Import.DoDotSource -Fallback $false
-if ($PSDatabasClone_dotsourcemodule) { $script:doDotSource = $true }
+$script:doDotSource = Get-PSFConfigValue -FullName PSDatabaseClone.Import.DoDotSource -Fallback $false
+if ($PSDatabaseClone_dotsourcemodule) { $script:doDotSource = $true }
 
 # Execute Preimport actions
 . Import-ModuleFile -Path "$ModuleRoot\internal\scripts\preimport.ps1"

bin/PSDatabaseClone.dll

@@ -0,0 +1,12 @@
+TOPIC
+	about_PSDatabaseClone
+
+SHORT DESCRIPTION
+	Module to create SQL Server database images and clones
+
+LONG DESCRIPTION
+	PSDatabaseClone is a PowerShell module for creating SQL Server database images and clones.
+	It enables administrator to supply environments with database copies that are a fraction of the original size.
+
+KEYWORDS
+	PSDatabaseClone

en-us/about_PSDatabasClone.help.txt

@@ -1,10 +1,10 @@
-function Get-PDCClone {
+function Get-PSDCClone {
 <#
 .SYNOPSIS
-    Get-PDCClone get on or more clones
+    Get-PSDCClone get on or more clones
 
 .DESCRIPTION
-    Get-PDCClone will retrieve the clones and apply filters if needed.
+    Get-PSDCClone will retrieve the clones and apply filters if needed.
     By default all the clones are returned
 
 .PARAMETER HostName
@@ -33,17 +33,17 @@ function Get-PDCClone {
     https://psdatabaseclone.io/
 
 .EXAMPLE
-    Get-PDCClone -HostName host1, host2
+    Get-PSDCClone -HostName host1, host2
 
     Retrieve the clones for host1 and host2
 
 .EXAMPLE
-    Get-PDCClone -Database DB1
+    Get-PSDCClone -Database DB1
 
     Get all the clones that have the name DB1
 
 .EXAMPLE
-    Get-PDCClone -ImageName DB1_20180703085917
+    Get-PSDCClone -ImageName DB1_20180703085917
 
     Get all the clones that were made with image "DB1_20180703085917"
 #>
@@ -62,7 +62,7 @@ function Get-PDCClone {
 
         # Test the module database setup
         try {
-            Test-PDCConfiguration -EnableException
+            Test-PSDCConfiguration -EnableException
         }
         catch {
             Stop-PSFFunction -Message "Something is wrong in the module configuration" -ErrorRecord $_ -Continue
@@ -97,6 +97,7 @@ function Get-PDCClone {
             "
 
         try {
+            $results = @()
             $results = Invoke-DbaSqlQuery -SqlInstance $pdcSqlInstance -Database $pdcDatabase -Query $query -As PSObject
         }
         catch {
@@ -128,7 +129,24 @@ function Get-PDCClone {
             $results = $results | Where-Object {$_.ImageLocation -in $ImageLocation}
         }
 
-        return $results
+        # Convert the results to the PSDCClone data type
+        foreach($result in $results){
+
+            [PSDCClone]$clone = New-Object PSDCClone
+            $clone.CloneID = $result.CloneID
+            $clone.CloneLocation = $result.CloneLocation
+            $clone.AccessPath = $result.AccessPath
+            $clone.SqlInstance = $result.SqlInstance
+            $clone.DatabaseName = $result.DatabaseName
+            $clone.IsEnabled = $result.IsEnabled
+            $clone.ImageID = $result.ImageID
+            $clone.ImageName = $result.ImageName
+            $clone.ImageLocation = $result.ImageLocation
+            $clone.HostName = $result.HostName
+
+            return $clone
+        }
+
     }
 
     end {
@@ -140,4 +158,4 @@ function Get-PDCClone {
 
     }
 
-}
+}

en-us/about_PSDatabaseClone.help.txt

@@ -0,0 +1,136 @@
+function Get-PSDCImage {
+    <#
+.SYNOPSIS
+    Get-PSDCImage get on or more clones
+
+.DESCRIPTION
+    Get-PSDCImage will retrieve the clones and apply filters if needed.
+    By default all the clones are returned
+
+.PARAMETER ImageID
+    Filter based on the image id
+
+.PARAMETER ImageName
+    Filter based on the image name
+
+.PARAMETER ImageLocation
+    Filter based on the image location
+
+.PARAMETER Database
+    Filter based on the database
+
+.NOTES
+    Author: Sander Stad (@sqlstad, sqlstad.nl)
+
+    Website: https://psdatabaseclone.io
+    Copyright: (C) Sander Stad, [email protected]
+    License: MIT https://opensource.org/licenses/MIT
+
+.LINK
+    https://psdatabaseclone.io/
+
+.EXAMPLE
+    Get-PSDCImage -ImageName DB1_20180704220944, DB2_20180704221144
+
+    Retrieve the images for DB1_20180704220944, DB2_20180704221144
+
+.EXAMPLE
+    Get-PSDCImage -ImageLocation "\\fileserver1\psdatabaseclone\images\DB1_20180704220944.vhdx"
+
+    Get all the images that are the same as the image location
+
+.EXAMPLE
+    Get-PSDCImage -Database DB1, DB2
+
+    Get all the images that were made for databases DB1 and DB2
+#>
+
+    [CmdLetBinding()]
+
+    param(
+        [int[]]$ImageID,
+        [string[]]$ImageName,
+        [string[]]$ImageLocation,
+        [string[]]$Database
+    )
+
+    begin {
+        # Test the module database setup
+        try {
+            Test-PSDCConfiguration -EnableException
+        }
+        catch {
+            Stop-PSFFunction -Message "Something is wrong in the module configuration" -ErrorRecord $_ -Continue
+        }
+
+        $pdcSqlInstance = Get-PSFConfigValue -FullName psdatabaseclone.database.server
+        $pdcDatabase = Get-PSFConfigValue -FullName psdatabaseclone.database.name
+    }
+
+    process {
+        # Test if there are any errors
+        if (Test-PSFFunctionInterrupt) { return }
+
+        $query = "
+            SELECT ImageID,
+                ImageName,
+                ImageLocation,
+                SizeMB,
+                DatabaseName,
+                DatabaseTimestamp,
+                CreatedOn
+            FROM dbo.Image;
+        "
+
+        try {
+            $result = @()
+            $results = Invoke-DbaSqlQuery -SqlInstance $pdcSqlInstance -Database $pdcDatabase -Query $query -As PSObject
+        }
+        catch {
+            Stop-PSFFunction -Message "Could not execute query" -ErrorRecord $_ -Target $query
+        }
+
+        # Filter image id
+        if ($ImageID) {
+            $results = $results | Where-Object {$_.ImageID -in $ImageID}
+        }
+
+        # Filter image name
+        if ($ImageName) {
+            $results = $results | Where-Object {$_.ImageName -in $ImageName}
+        }
+
+        # Filter image location
+        if ($ImageLocation) {
+            $results = $results | Where-Object {$_.ImageLocation -in $ImageLocation}
+        }
+
+        # Filter database
+        if ($Database) {
+            $results = $results | Where-Object {$_.DatabaseName -in $Database}
+        }
+
+
+        # Convert the results to the PSDCClone data type
+        foreach($result in $results){
+
+            [PSDCImage]$image = New-Object PSDCImage
+            $image.ImageID = $result.ImageID
+            $image.ImageName = $result.ImageName
+            $image.ImageLocation = $result.ImageLocation
+            $image.SizeMB = $result.SizeMB
+            $image.DatabaseName = $result.DatabaseName
+            $image.DatabaseTimestamp = $result.DatabaseTimestamp
+            $image.CreatedOn = $result.CreatedOn
+
+            return $image
+        }
+    }
+
+    end {
+        # Test if there are any errors
+        if (Test-PSFFunctionInterrupt) { return }
+
+        Write-PSFMessage -Message "Finished retrieving image(s)" -Level Verbose
+    }
+}