Private/Export-AtwsDiskCache.ps1
|
<#
.COPYRIGHT Copyright (c) ECIT Solutions AS. All rights reserved. Licensed under the MIT license. See https://github.com/ecitsolutions/Autotask/blob/master/LICENSE.md for license information. #> Function Export-AtwsDiskCache { <# .SYNOPSIS This function flushes the current in-memory cache to disk. .DESCRIPTION This function flushes the current in-memory cache to disk .OUTPUTS A CliXml file .EXAMPLE Export-AtwsDiskCache Exports the current in memory entity cache to a file on disk. .NOTES NAME: Export-AtwsDiskCache #> [CmdLetBinding( SupportsShouldProcess = $true )] Param() begin { if (-not ($Script:Atws.Cache.Count -gt 0)) { Write-Error -Message 'The diskcache has not been imported yet. Noting to save.' Return } $CacheFile = 'AutotaskFieldInfoCache.xml' } process { # If the module variable UseDiskCache is $false or does not exist, this function does nothing... if ($Script:Atws.Configuration.UseDiskCache) { $PersonalCacheDir = $Script:Atws.DynamicCache $PersonalCache = '{0}\{1}' -F $PersonalCacheDir, $CacheFile Write-Verbose -Message ('{0}: Personal cache location is {1}.' -F $MyInvocation.MyCommand.Name, $PersonalCache) # This REALLY should be there, but better safe than sorry # Create Personalcache directory if it doesn't exist if (-not (Test-Path $PersonalCacheDir)) { $caption = $MyInvocation.MyCommand.Name $verboseDescription = '{0}: Creating a new personal cache dir {1}' -F $caption, $PersonalCacheDir $verboseWarning = '{0}: About to create a new personal cache dir {1}. Do you want to continue?' -F $caption, $PersonalCacheDir if ($PSCmdlet.ShouldProcess($verboseDescription, $verboseWarning, $caption)) { New-Item -Path $PersonalCacheDir -ItemType Directory } } $caption = $MyInvocation.MyCommand.Name $verboseDescription = '{0}: Saving updated cache info to {1}' -F $caption, $PersonalCache $verboseWarning = '{0}: About to save updated cache info to {1}. Do you want to continue?' -F $caption, $PersonalCache if ($PSCmdlet.ShouldProcess($verboseDescription, $verboseWarning, $caption)) { $Script:Atws.Cache | Export-Clixml -Path $PersonalCache -Force } } } end { Write-Verbose ('{0}: End of function' -F $MyInvocation.MyCommand.Name) } } |