functions/Get-DbaDatabaseSnapshot.ps1

Function Get-DbaDatabaseSnapshot
{
<#
.SYNOPSIS
Get database snapshots with details

.DESCRIPTION
Retrieves the list of database snapshot available, along with their base (the db they are the snapshot of) and creation time

.PARAMETER SqlInstance
The SQL Server that you're connecting to.

.PARAMETER Credential
Credential object used to connect to the SQL Server as a different user

.PARAMETER Databases
Return information for only specific base dbs

.PARAMETER Snapshots
Return information for only specific snapshots

.NOTES
Author: niphlod

dbatools PowerShell module (https://dbatools.io)
Copyright (C) 2016 Chrissy LeMaire
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

.LINK
 https://dbatools.io/Get-DbaDatabaseSnapshot

.EXAMPLE
Get-DbaDatabaseSnapshot -SqlServer sqlserver2014a

Returns a custom object displaying Server, Database, DatabaseCreated, SnapshotOf

.EXAMPLE
Get-DbaDatabaseSnapshot -SqlServer sqlserver2014a -Databases HR, Accounting

Returns informations for database snapshots having HR and Accounting as base dbs

.EXAMPLE
Get-DbaDatabaseSnapshot -SqlServer sqlserver2014a -Snapshots HR_snapshot, Accounting_snapshot

Returns informations for database snapshots HR_snapshot and Accounting_snapshot

#>

    [CmdletBinding()]
    Param (
        [parameter(Mandatory = $true, ValueFromPipeline = $true)]
        [Alias("ServerInstance", "SqlServer")]
        [string[]]$SqlInstance,
        [PsCredential]$Credential
    )
    
    DynamicParam
    {
        if ($SqlInstance)
        {
            Get-ParamSqlSnapshotsAndDatabases -SqlServer $SqlInstance[0] -SqlCredential $Credential
        }
    }
    
    BEGIN
    {
        # Convert from RuntimeDefinedParameter object to regular array
        $databases = $psboundparameters.Databases
        $snapshots = $psboundparameters.Snapshots
    }

    PROCESS
    {
        foreach ($instance in $SqlInstance)
        {
            Write-Verbose "Connecting to $instance"
            try
            {
                $server = Connect-SqlServer -SqlServer $instance -SqlCredential $Credential
                
            }
            catch
            {
                Write-Warning "Can't connect to $instance"
                Continue
            }
            
            $dbs = $server.Databases 

            if ($databases.count -gt 0)
            {
                $dbs = $dbs | Where-Object { $databases -contains $_.DatabaseSnapshotBaseName }
            }

            if ($snapshots.count -gt 0)
            {
                $dbs = $dbs | Where-Object { $snapshots -contains $_.Name }
            }
            
            if ($snapshots.count -eq 0 -and $databases.count -eq 0)
            {
                $dbs = $dbs | Where-Object IsDatabaseSnapshot -eq $true | Sort-Object DatabaseSnapshotBaseName, Name
            }
            
            
            foreach ($db in $dbs)
            {
                $object = [PSCustomObject]@{
                    Server = $server.name
                    Database = $db.name
                    SnapshotOf = $db.DatabaseSnapshotBaseName
                    SizeMB = [Math]::Round($db.Size,2)
                    DatabaseCreated = $db.createDate
                    IsReadCommittedSnapshotOn = $db.IsReadCommittedSnapshotOn
                    SnapshotIsolationState = $db.SnapshotIsolationState
                    SnapshotDb = $db
                }
                
                Select-DefaultField -InputObject $object -Property Server, Database, SnapshotOf, SizeMB, DatabaseCreated, IsReadCommittedSnapshotOn, SnapshotIsolationState
            }
        }
    }
}