Functions/GenXdev.Data.SqlServer/Get-SQLServerViews.ps1
|
############################################################################### <# .SYNOPSIS Retrieves a list of views from a SQL Server database. .DESCRIPTION Gets all view names from the specified SQL Server database. Returns an array of view names that can be used for further database operations. The function supports two parameter sets for flexibility: providing either a connection string or a database name with server. .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 connection string to connect to the SQL Server database. Use this when you need to specify custom connection parameters. .PARAMETER DatabaseName The name of the SQL Server database. .PARAMETER Server The SQL Server instance name. Defaults to 'localhost'. .EXAMPLE Get-SQLServerViews -DatabaseName "MyDatabase" -Server "localhost" .EXAMPLE Get-SQLServerViews -ConnectionString "Server=localhost;Database=MyDatabase;Integrated Security=true;" #> function Get-SQLServerViews { [CmdletBinding(DefaultParameterSetName = 'DatabaseName')] [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseSingularNouns', '')] 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.' )] [string]$DatabaseName, ############################################################################### [Parameter( Position = 1, ParameterSetName = 'DatabaseName', HelpMessage = 'The SQL Server instance name.' )] [string]$Server = '.' ) begin { # log the start of the view retrieval process Microsoft.PowerShell.Utility\Write-Verbose 'Preparing to retrieve SQL views...' } process { # define the SQL query to retrieve all view names from SQL Server system tables $query = "SELECT name FROM sys.views ORDER BY name" # log the query being executed for troubleshooting Microsoft.PowerShell.Utility\Write-Verbose "Executing query: $query" # execute the query using existing parameter set and store in $PSBoundParameters $PSBoundParameters['Queries'] = $query # invoke the query and return results using parameter splatting GenXdev\Invoke-SQLServerQuery @PSBoundParameters } end { } } |