Functions/GenXdev.Data.SqlServer/Get-SQLServerTableSchema.ps1
|
<##############################################################################
Part of PowerShell module : GenXdev.Data.SqlServer Original cmdlet filename : Get-SQLServerTableSchema.ps1 Original author : René Vaessen / GenXdev Version : 1.288.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 the schema information for a specified SQL Server table. .DESCRIPTION This function queries the SQL Server database to get detailed schema information for a specified table. It uses the SQL Server INFORMATION_SCHEMA.COLUMNS view to return column definitions including names, types, nullable status, and default values. .PARAMETER ConnectionString Specifies the SQL Server connection string in the format: "Server=servername;Database=databasename;Integrated Security=true" .PARAMETER DatabaseName Specifies the name of the SQL Server database. .PARAMETER Server Specifies the SQL Server instance name. Defaults to 'localhost'. .PARAMETER TableName Specifies the name of the table for which to retrieve schema information. .EXAMPLE Get-SQLServerTableSchema -DatabaseName "mydb" -Server "localhost" ` -TableName "Users" .EXAMPLE Get-SQLServerTableSchema -ConnectionString "Server=localhost;Database=mydb;Integrated Security=true" ` -TableName "Products" #> function Get-SQLServerTableSchema { [CmdletBinding(DefaultParameterSetName = 'DatabaseName')] param ( ########################################################################### [Parameter( Position = 0, Mandatory = $true, ParameterSetName = 'ConnectionString', HelpMessage = 'The connection string to the SQL Server database' )] [ValidateNotNullOrEmpty()] [string]$ConnectionString, ########################################################################### [Parameter( Position = 0, Mandatory = $true, ParameterSetName = 'DatabaseName', HelpMessage = 'The name of the SQL Server database' )] [ValidateNotNullOrEmpty()] [string]$DatabaseName, ########################################################################### [Parameter( Position = 1, ParameterSetName = 'DatabaseName', HelpMessage = 'The SQL Server instance name' )] [string]$Server = '.', ########################################################################### [Parameter( Position = 2, Mandatory = $true, HelpMessage = 'The name of the table' )] [ValidateNotNullOrEmpty()] [string]$TableName ) begin { # log the start of schema retrieval operation Microsoft.PowerShell.Utility\Write-Verbose "Preparing to retrieve schema for table '$TableName'" } process { # construct the INFORMATION_SCHEMA query to get detailed table column information $PSBoundParameters['Queries'] = @" SELECT COLUMN_NAME, DATA_TYPE, IS_NULLABLE, COLUMN_DEFAULT, CHARACTER_MAXIMUM_LENGTH, NUMERIC_PRECISION, NUMERIC_SCALE, ORDINAL_POSITION FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_NAME = '$TableName' ORDER BY ORDINAL_POSITION "@ # log the execution of the schema query Microsoft.PowerShell.Utility\Write-Verbose 'Executing schema query against SQL Server database' # execute the query and return results using existing Invoke-SQLServerQuery GenXdev.Data\Invoke-SQLServerQuery @PSBoundParameters } end { } } |