Functions/GenXdev.Data.SqlServer/Get-SQLServerTables.ps1
|
<##############################################################################
Part of PowerShell module : GenXdev.Data.SqlServer Original cmdlet filename : Get-SQLServerTables.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 a list of table names from a SQL Server database. .DESCRIPTION Queries the SQL Server system tables to retrieve all user-defined table names from a SQL Server database. Supports connecting via either a direct connection string or a database name with server parameters. Returns the table names as a collection of strings. .PARAMETER ConnectionString The full connection string to connect to the SQL Server database. Should include the Server and Database parameters at minimum. .PARAMETER DatabaseName The name of the SQL Server database. .PARAMETER Server The SQL Server instance name. Defaults to 'localhost'. .EXAMPLE Get-SQLServerTables -DatabaseName "Inventory" -Server "localhost" Returns all table names from the specified database .EXAMPLE Get-SQLServerTables -ConnectionString "Server=localhost;Database=Users;Integrated Security=true;" Returns all table names using a custom connection string ############################################################################## #> function Get-SQLServerTables { [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseSingularNouns', '')] [CmdletBinding(DefaultParameterSetName = 'DatabaseName')] param ( ########################################################################### [Parameter( Position = 0, Mandatory = $true, ParameterSetName = 'ConnectionString', HelpMessage = 'The connection string to the SQL Server database.' )] [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 = '.' ) begin { # log the start of table retrieval operation Microsoft.PowerShell.Utility\Write-Verbose 'Starting SQL table name retrieval operation' } process { # define the query to get all table names from SQL Server system tables $PSBoundParameters['Queries'] = 'SELECT name FROM sys.tables ORDER BY name' # execute query using the inherited connection parameters Microsoft.PowerShell.Utility\Write-Verbose 'Executing query to retrieve table names' GenXdev.Data\Invoke-SQLServerQuery @PSBoundParameters } end { } } |