functions/Get-DbaTable.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
function Get-DbaTable
{
<#
.SYNOPSIS
Returns a summary of information on the tables
.DESCRIPTION
Shows table information around table row and data sizes and if it has any table type information.
.PARAMETER SqlInstance
SQLServer name or SMO object representing the SQL Server to connect to. This can be a
collection and recieve pipeline input
.PARAMETER SqlCredential
PSCredential object to connect as. If not specified, currend Windows login will be used.
.PARAMETER Database
Define the databases you wish to search
.PARAMETER IncludeSystemDBs
Switch parameter that when used will display system database information
.PARAMETER Table
Define a specific table you would like to query
.PARAMETER Silent
Use this switch to disable any kind of verbose messages
  
.NOTES
Original Author: Stephen Bennett, https://sqlnotesfromtheunderground.wordpress.com/
dbatools PowerShell module (https://dbatools.io, clemaire@gmail.com)
Copyright (C) 2016 Chrissy LeMaire
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 <http://www.gnu.org/licenses/>.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.    
  
.LINK
https://dbatools.io/Get-DbaTable
.EXAMPLE
Get-DbaTable -SqlInstance DEV01 -Database Test1
Return all tables in the Test1 database
.EXAMPLE
Get-DbaTable -SqlInstance DEV01 -Database MyDB -Table MyTable
Return only information on the table MyTable from the database MyDB
.EXAMPLE
Get-DbaTable -SqlInstance DEV01 -Table MyTable
Returns information on table called MyTable if it exists in any database on the server, under any schema
.EXAMPLE
@('localhost','localhost\namedinstance') | Get-DbaTable -Database DBA -Table Commandlog
Returns information on the CommandLog table in the DBA database on both instances localhost and the named instance localhost\namedinstance
 
#>

    [CmdletBinding()]
    param ([parameter(ValueFromPipeline, Mandatory = $true)]
        [Alias("ServerInstance", "SqlServer")]
        [object[]]$SqlInstance,
        [System.Management.Automation.PSCredential]$SqlCredential,
        [switch]$IncludeSystemDBs,
        [string[]]$Table,
        [switch]$Silent
    )
    
    DynamicParam { if ($SqlInstance) { return Get-ParamSqlDatabases -SqlServer $SqlInstance[0] -SqlCredential $SourceSqlCredential } }
    
    BEGIN
    {
        $databases = $psboundparameters.Databases
        $exclude = $psboundparameters.Exclude
        
        $defaultprops = @("Parent", "Schema", "Name", "IndexSpaceUsed", "DataSpaceUsed", "RowCount", "HasClusteredIndex", "IsFileTable", "IsMemoryOptimized", "IsPartitioned", "FullTextIndex", "ChangeTrackingEnabled")

        $fqtns = @()
        
        if ($Table)
        {
            foreach ($t in $Table)
            {
                $dotcount = ([regex]::Matches($t, "\.")).count
                
                $database = $NULL
                $Schema = $NULL

                if ($dotcount -eq 1)
                {
                    $schema = $t.Split(".")[0]
                    $tbl = $t.Split(".")[1]
                }
                
                if ($dotcount -eq 2)
                {
                    $database = $t.Split(".")[0]
                    $schema = $t.Split(".")[1]
                    $tbl = $t.Split(".")[2]
                }
                
                $fqtn = [PSCustomObject] @{
                    Database = $database
                    Schema = $Schema
                    Table = $tbl
                }
                $fqtns += $fqtn
            }
        }
        #$fqtns
    }
    
    PROCESS
    {
        foreach ($instance in $sqlinstance)
        {    
            try
            {
                Write-Message -Level Verbose -Message "Connecting to $instance"
                $server = Connect-SqlServer -SqlServer $instance -SqlCredential $sqlcredential
            }
            catch
            {
                Stop-Function -Message "Failed to connect to: $instance" -Continue -Target $instance -InnerErrorRecord $_
            }
            
            #If IncludeSystemDBs is true, include systemdbs
            #only look at online databases (Status equal normal)
            try
            {
                if ($databases.length -gt 0)
                {
                    $dbs = $server.Databases | Where-Object { $databases -contains $_.Name -and $_.status -eq 'Normal' }
                }
                elseif ($IncludeSystemDBs)
                {
                    $dbs = $server.Databases | Where-Object { $_.status -eq 'Normal' }
                }
                else
                {
                    $dbs = $server.Databases | Where-Object { $_.status -eq 'Normal' -and $_.IsSystemObject -eq 0 }
                }
                
                if ($exclude.length -gt 0)
                {
                    $dbs = $dbs | Where-Object { $exclude -notcontains $_.Name }
                }
            }
            catch
            {
                Stop-Function -Message "Unable to gather dbs for $instance" -Target $instance -Continue -InnerErrorRecord $_
            }
            
            foreach ($db in $dbs)
            {
                Write-Message -Level Verbose -Message "Processing $db"
                
                $d = $server.Databases[$db]
                if ($fqtns.Count -gt 0)
                {
                    foreach ($fqtn in $fqtns)
                    {
                        if ($fqtn.schema -ne $NULL)
                        {
                            try
                            {
                                $db.Tables | Where-Object { $_.name -eq $tbl -and $_.Schema -eq $schema } | Select-DefaultView -Property $defaultprops
                            }
                            catch
                            {
                                Write-Message -Level Warning -Message "Could not find table name: $($fqtn.tbl) schema: $($fqtn.schema)" -ErrorRecord $_
                            }
                        }
                        else
                        {
                            try
                            {
                                $db.Tables | Where-Object { $_.name -eq $tbl } | Select-DefaultView -Property $defaultprops
                            }
                            catch
                            {
                                Write-Message -Level Warning -Message "Could not find table name: $($fqtn.tbl)" -ErrorRecord $_
                            }
                        }
                    }
                }
                else
                {
                    $db.Tables | Select-DefaultView -Property $defaultprops
                }
            }
        }
    }
}