Functions/GenXdev.Data.SQLite/Get-SQLiteSchema.ps1
|
############################################################################### <# .SYNOPSIS Retrieves the complete schema information from a SQLite database. .DESCRIPTION This function queries the sqlite_master table to obtain the complete schema definition of a SQLite database, including tables, views, indexes and triggers. It accepts either a connection string or a direct path to the database file. .LICENSE Copyright (C) 2026 René Vaessen / GenXdev 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 <https://www.gnu.org/licenses/>. .PARAMETER ConnectionString The SQLite connection string that specifies the database location and any additional connection parameters. .PARAMETER DatabaseFilePath The direct filesystem path to the SQLite database file. .EXAMPLE Get-SQLiteSchema -DatabaseFilePath "C:\Databases\inventory.db" .EXAMPLE Get-SQLiteSchema -ConnectionString "Data Source=C:\Databases\inventory.db;Version=3;" #> function Get-SQLiteSchema { [CmdletBinding(DefaultParameterSetName = 'Default')] param ( ######################################################################## [Parameter( Position = 0, Mandatory = $true, ParameterSetName = 'ConnectionString', HelpMessage = 'The connection string to the SQLite database.' )] [string]$ConnectionString, ######################################################################## [Parameter( Position = 0, Mandatory = $true, ParameterSetName = 'DatabaseFilePath', HelpMessage = 'The path to the SQLite database file.' )] [string]$DatabaseFilePath ) begin { # output verbose information about the selected parameter set Microsoft.PowerShell.Utility\Write-Verbose "Using parameter set: $($PSCmdlet.ParameterSetName)" } process { # prepare the query to retrieve the complete database schema $PSBoundParameters['Queries'] = 'SELECT * FROM sqlite_master' # execute the schema query using the existing Invoke-SQLiteQuery function GenXdev\Invoke-SQLiteQuery @PSBoundParameters } end { } } |