Functions/GenXdev.Data.SQLite/Get-SQLiteTableData.ps1
|
<##############################################################################
Part of PowerShell module : GenXdev.Data.SQLite Original cmdlet filename : Get-SQLiteTableData.ps1 Original author : René Vaessen / GenXdev Version : 1.270.2025 ################################################################################ MIT License Copyright 2021-2025 GenXdev Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ################################################################################> ############################################################################### <# .SYNOPSIS Retrieves data from a SQLite database table with optional record limiting. .DESCRIPTION This function queries data from a SQLite database table using either a connection string or database file path. It provides flexibility in connecting to the database and controlling the amount of data retrieved through the Count parameter. .PARAMETER ConnectionString Specifies the SQLite connection string in the format: "Data Source=path_to_database_file" .PARAMETER DatabaseFilePath Specifies the full file system path to the SQLite database file. .PARAMETER TableName Specifies the name of the table to query data from. The table must exist in the database. .PARAMETER Count Specifies the maximum number of records to return. Default is 100. Use -1 to return all records. Must be -1 or a positive integer. .EXAMPLE Get-SQLiteTableData -DatabaseFilePath "C:\data\users.db" -TableName "Employees" -Count 50 .EXAMPLE Get-SQLiteTableData "C:\data\users.db" "Employees" #> function Get-SQLiteTableData { [CmdletBinding(DefaultParameterSetName = 'Default')] param ( ########################################################################### [Parameter( Position = 0, Mandatory = $true, ParameterSetName = 'ConnectionString', HelpMessage = 'The connection string to the SQLite database.' )] [ValidateNotNullOrEmpty()] [string]$ConnectionString, ########################################################################### [Parameter( Position = 0, Mandatory = $true, ParameterSetName = 'DatabaseFilePath', HelpMessage = 'The path to the SQLite database file.' )] [ValidateNotNullOrEmpty()] [Alias('dbpath', 'indexpath')] [string]$DatabaseFilePath, ########################################################################### [Parameter( Position = 1, Mandatory = $true, HelpMessage = 'The name of the table to query data from.' )] [ValidateNotNullOrEmpty()] [string]$TableName, ########################################################################### [Parameter( Position = 2, Mandatory = $false, HelpMessage = 'The maximum number of records to return. -1 for all.' )] [ValidateRange(-1, [int]::MaxValue)] [int]$Count = 100 ) begin { Microsoft.PowerShell.Utility\Write-Verbose "Starting Get-SQLiteTableData for table: $TableName" Microsoft.PowerShell.Utility\Write-Verbose "Record limit set to: $(if($Count -eq -1){'unlimited'}else{$Count})" } process { # construct query based on whether we want all records or a limited set $query = if ($Count -eq -1) { "SELECT * FROM $TableName" } else { "SELECT * FROM $TableName LIMIT $Count" } Microsoft.PowerShell.Utility\Write-Verbose "Executing query: $query" # add the constructed query to the parameter set for Invoke-SQLiteQuery $PSBoundParameters['Queries'] = $query # execute the query and return results through the SQLite provider GenXdev.Data\Invoke-SQLiteQuery @PSBoundParameters } end { Microsoft.PowerShell.Utility\Write-Verbose "Completed querying table: $TableName" } } |