PowerShell/docs/list-sql-tables.md

97 lines
2.7 KiB
Markdown
Raw Normal View History

2023-07-29 10:34:04 +02:00
*list-sql-tables.ps1*
================
2021-11-08 21:36:42 +01:00
2022-02-10 09:01:07 +01:00
This PowerShell script lists all tables in a SQL server database and exports the list as CSV.
2021-11-08 21:36:42 +01:00
Install-Module InvokeQuery
Run the above command if you do not have this module.
2023-07-29 10:04:38 +02:00
Parameters
----------
2021-11-08 21:36:42 +01:00
```powershell
2023-07-29 10:15:44 +02:00
PS> ./list-sql-tables.ps1 [-server] <Object> [-database] <Object> [-username] <Object> [-password] <Object> [<CommonParameters>]
2021-11-08 21:36:42 +01:00
-server <Object>
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-database <Object>
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-username <Object>
Required? true
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-password <Object>
Required? true
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
2023-07-29 10:04:38 +02:00
Example
-------
2021-11-08 21:36:42 +01:00
```powershell
2023-08-06 21:36:33 +02:00
PS> ./list-sql-tables.ps1
2021-11-08 21:36:42 +01:00
```
2023-07-29 10:04:38 +02:00
Notes
-----
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-11-08 21:36:42 +01:00
2023-07-29 10:04:38 +02:00
Related Links
-------------
2021-11-08 21:36:42 +01:00
https://github.com/fleschutz/PowerShell
2023-07-29 10:04:38 +02:00
Script Content
--------------
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
Lists all tables of a SQL server database
.DESCRIPTION
This PowerShell script lists all tables in a SQL server database and exports the list as CSV.
Install-Module InvokeQuery
Run the above command if you do not have this module.
.EXAMPLE
2023-08-06 21:36:33 +02:00
PS> ./list-sql-tables.ps1
2022-11-17 20:02:26 +01:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param(
[Parameter(Mandatory=$true)]$server,
[Parameter(Mandatory=$true)]$database,
[Parameter(Mandatory=$true)]$username,
[Parameter(Mandatory=$true)]$password
)
$secpasswd = ConvertTo-SecureString $password -AsPlainText -Force
$creds = New-Object System.Management.Automation.PSCredential ($username, $secpasswd)
$csvfilepath = "$PSScriptRoot\sqlserver_tables.csv"
$result = Invoke-SqlServerQuery -Credential $creds -ConnectionTimeout 10000 -Database $database -Server $server -Sql "SELECT TABLE_NAME FROM $database.INFORMATION_SCHEMA.TABLES WHERE TABLE_TYPE = 'BASE TABLE'" -CommandTimeout 10000
$result | Export-Csv $csvfilepath -NoTypeInformation
2022-11-17 20:05:34 +01:00
```
2022-11-17 20:02:26 +01:00
2023-10-19 08:12:00 +02:00
*(generated by convert-ps2md.ps1 using the comment-based help of list-sql-tables.ps1 as of 10/19/2023 08:11:40)*