Functions/GenXdev.Data.SQLite/Get-SQLiteTransaction.ps1
|
<##############################################################################
Part of PowerShell module : GenXdev.Data.SQLite Original cmdlet filename : Get-SQLiteTransaction.ps1 Original author : René Vaessen / GenXdev Version : 1.300.2025 ################################################################################ Copyright (c) René Vaessen / GenXdev Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ################################################################################> ############################################################################### <# .SYNOPSIS Creates and returns a SQLite transaction object for batch operations. .DESCRIPTION Creates a SQLite database connection and transaction object that can be used for batch operations. The caller is responsible for committing or rolling back the transaction. The connection will be automatically created if the database file doesn't exist. .PARAMETER ConnectionString The SQLite connection string for database access. .PARAMETER DatabaseFilePath The file path to the SQLite database. Will be converted to a connection string. .PARAMETER IsolationLevel Transaction isolation level. Defaults to ReadCommitted. .PARAMETER CreateDatabaseIfNotExists Whether to create the database file if it doesn't exist. Defaults to true. .PARAMETER ForceConsent Force a consent prompt even if a preference is already set for SQLite package installation, overriding any saved consent preferences. .PARAMETER ConsentToThirdPartySoftwareInstallation Automatically consent to third-party software installation and set a persistent preference flag for SQLite package, bypassing interactive consent prompts. .EXAMPLE $transaction = Get-SQLiteTransaction -DatabaseFilePath "C:\data.db" try { Invoke-SQLiteQuery -Transaction $transaction -Queries "INSERT INTO Users..." Invoke-SQLiteQuery -Transaction $transaction -Queries "UPDATE Users..." $transaction.Commit() } catch { $transaction.Rollback() throw } finally { $transaction.Connection.Close() } .EXAMPLE $transaction = Get-SQLiteTransaction -ConnectionString "Data Source=C:\data.db" .EXAMPLE $transaction = Get-SQLiteTransaction -DatabaseFilePath "C:\data.db" -ConsentToThirdPartySoftwareInstallation #> function Get-SQLiteTransaction { [CmdletBinding(DefaultParameterSetName = 'DatabaseFilePath')] [Alias('getsqltx', 'newsqltx')] param ( ########################################################################### [Parameter( Position = 0, Mandatory, ParameterSetName = 'ConnectionString', HelpMessage = 'The connection string to the SQLite database.' )] [string]$ConnectionString, ########################################################################### [Parameter( Position = 0, Mandatory, ParameterSetName = 'DatabaseFilePath', HelpMessage = 'The path to the SQLite database file.' )] [ValidateNotNullOrEmpty()] [Alias('dbpath', 'indexpath')] [string]$DatabaseFilePath, ########################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Transaction isolation level.' )] [ValidateSet('ReadCommitted', 'ReadUncommitted', 'RepeatableRead', 'Serializable', 'Snapshot', 'Chaos')] [string]$IsolationLevel = "ReadCommitted", ########################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Whether to create the database file if it does not exist.' )] [bool]$CreateDatabaseIfNotExists = $true, ########################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Force a consent prompt even if preference is set for SQLite package installation.' )] [switch] $ForceConsent, ########################################################################### [Parameter( Mandatory = $false, HelpMessage = 'Automatically consent to third-party software installation and set persistent flag for SQLite package.' )] [switch] $ConsentToThirdPartySoftwareInstallation ########################################################################### ) begin { # load SQLite client assembly with embedded consent using Copy-IdenticalParamValues $ensureParams = GenXdev.FileSystem\Copy-IdenticalParamValues ` -BoundParameters $PSBoundParameters ` -FunctionName 'GenXdev.Helpers\EnsureNuGetAssembly' ` -DefaultValues ( Microsoft.PowerShell.Utility\Get-Variable -Scope Local ` -ErrorAction SilentlyContinue ) # Set specific parameters for SQLite package $ensureParams['PackageKey'] = 'System.Data.Sqlite' $ensureParams['Description'] = 'SQLite database client library required for database operations' $ensureParams['Publisher'] = 'SQLite Development Team' GenXdev.Helpers\EnsureNuGetAssembly @ensureParams # initialize connection string from file path if provided if ($PSCmdlet.ParameterSetName -eq 'DatabaseFilePath') { $expandedPath = GenXdev.FileSystem\Expand-Path $DatabaseFilePath # create database if it doesn't exist and CreateDatabaseIfNotExists is true if ($CreateDatabaseIfNotExists -and -not (Microsoft.PowerShell.Management\Test-Path -LiteralPath $expandedPath)) { Microsoft.PowerShell.Utility\Write-Verbose "Creating database file: $expandedPath" # use Copy-IdenticalParamValues to pass compatible parameters to New-SQLiteDatabase $params = GenXdev.FileSystem\Copy-IdenticalParamValues ` -BoundParameters $PSBoundParameters ` -FunctionName 'GenXdev.Data\New-SQLiteDatabase' ` -DefaultValues (Microsoft.PowerShell.Utility\Get-Variable -Scope Local -ErrorAction SilentlyContinue) GenXdev.Data\New-SQLiteDatabase @params } $connString = "Data Source=$expandedPath" } else { $connString = $ConnectionString } Microsoft.PowerShell.Utility\Write-Verbose "Creating SQLite transaction with connection string: $connString" } process { try { # establish database connection $connection = Microsoft.PowerShell.Utility\New-Object System.Data.SQLite.SQLiteConnection($connString) $connection.Open() Microsoft.PowerShell.Utility\Write-Verbose 'SQLite connection opened successfully' # begin transaction with specified isolation $transaction = $connection.BeginTransaction($IsolationLevel) Microsoft.PowerShell.Utility\Write-Verbose "Transaction started with $IsolationLevel isolation level" # return the transaction object return $transaction } catch { if ($null -ne $connection -and $connection.State -eq 'Open') { $connection.Close() } throw $_ } } end { } } |