PsSqlLocalDb

0.4.0-alpha0004

Public/Stop-Instance.ps1

function Stop-Instance {

    <#
 
    .SYNOPSIS
    stops a sqllocaldb instance.
 
    .EXAMPLE
    PS> $instance = New-LocalDbInstance
    PS> $instance | Stop-LocalDbInstance
 
    #>

    [CmdletBinding()]
    param (
        # Specifies the name of the instance to stop.
        [Parameter( Mandatory, ValueFromPipelineByPropertyName )]
        [ValidateNotNullOrEmpty()]
        [string] $Name,

        [Parameter()]
        [switch] $Force
    )

    process {
        Write-Verbose "Stop sqllocaldb instance $Name."

        if ( $Force ) {
            $response = sqllocaldb stop $Name -k
        }
        else {
            $response = sqllocaldb stop $Name
        }

        $response | Where-Object { $_ } | Write-Verbose
        if ( -not $? ) {
            Write-Error "Failed to stop sqllocaldb instance $Name."
        }
    }
}