PowerShell/Docs/convert-sql2csv.md
2023-05-26 12:20:18 +02:00

118 lines
3.5 KiB
Markdown

## The *convert-sql2csv.ps1* Script
This PowerShell script converts a SQL database table to a .CSV file.
## Parameters
```powershell
/home/mf/Repos/PowerShell/Scripts/convert-sql2csv.ps1 [[-server] <String>] [[-database] <String>] [[-username] <String>] [[-password] <String>] [[-query] <String>] [<CommonParameters>]
-server <String>
Specifies the server's hostname or IP address
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-database <String>
Specifies the database name
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-username <String>
Specifies the user name
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-password <String>
Specifies the password
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-query <String>
Specifies the SQL query
Required? false
Position? 5
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.
```
## Example
```powershell
PS> ./convert-sql2csv
```
## Notes
Author: Markus Fleschutz | License: CC0
## Related Links
https://github.com/fleschutz/PowerShell
## Source Code
```powershell
<#
.SYNOPSIS
Converts a SQL database table to a .CSV file
.DESCRIPTION
This PowerShell script converts a SQL database table to a .CSV file.
.PARAMETER server
Specifies the server's hostname or IP address
.PARAMETER database
Specifies the database name
.PARAMETER username
Specifies the user name
.PARAMETER password
Specifies the password
.PARAMETER query
Specifies the SQL query
.EXAMPLE
PS> ./convert-sql2csv
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$server = "", [string]$database = "", [string]$username = "", [string]$password = "", [string]$query = "")
try {
if ($server -eq "") { $server = read-host "Enter the hostname/IP address of the SQL server" }
if ($database -eq "") { $database = read-host "Enter the database name" }
if ($username -eq "") { $username = read-host "Enter the database username" }
if ($password -eq "") { $password = read-host "Enter the database user password" }
if ($query -eq "") { $query = read-host "Enter the database query" }
$secpasswd = ConvertTo-SecureString $password -AsPlainText -Force
$creds = New-Object System.Management.Automation.PSCredential ($username, $secpasswd)
$csvfilepath = "$PSScriptRoot\sqlserver_table.csv"
$result = Invoke-SqlServerQuery -Credential $creds -ConnectionTimeout 10000 -Database $database -Server $server -Sql $query -CommandTimeout 10000
$result | Export-Csv $csvfilepath -NoTypeInformation
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
```
*Generated by convert-ps2md.ps1 using the comment-based help of convert-sql2csv.ps1*