Functions/GenXdev.Data.SqlServer/Get-SQLServerViews.ps1
|
<##############################################################################
Part of PowerShell module : GenXdev.Data.SqlServer Original cmdlet filename : Get-SQLServerViews.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 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. .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.Data\Invoke-SQLServerQuery @PSBoundParameters } end { } } |