SQL Data Catalog

Export-Classification

Export classification to a file.

Syntax

Export-Classification [-InstanceName] <string> [[-DatabaseName] <string>] [-ExportFile] <string> [-Format] <string> [<CommonParameters>]

Description

Export classification to a file in a CSV format.

Parameters

-InstanceName <String>

The fully-qualified name of the SQL Server instance. For a named instance, this should take the form 'fully-qualified-host-name\instance-name' (e.g. "myserver.mydomain.com\myinstance"). For the default instance on a machine, just the fully-qualified name of the machine will suffice (e.g. "myserver.mydomain.com").

Aliases None
Required? true
Position? 1
Default Value None
Accept Pipeline Input False
Accept Wildcard Characters false

-DatabaseName <String>

Optional parameter. Database name to fetch columns from. If not specified, all columns on the instance are exported.

Aliases None
Required? false
Position? 2
Default Value None
Accept Pipeline Input False
Accept Wildcard Characters false

-ExportFile <String>

Specifies the output file. Enter a path and file name. If the path is omitted, the default is the current location. If the file exists, it will be overwritten.

Aliases None
Required? true
Position? 3
Default Value None
Accept Pipeline Input False
Accept Wildcard Characters false

-Format <String>

Specifies the output format. Currently supported: csv, zip.

Aliases None
Required? true
Position? 4
Default Value None
Accept Pipeline Input False
Accept Wildcard Characters false

-ProgressAction <ActionPreference>

{{ Fill ProgressAction Description }}

Aliases None
Required? false
Position? named
Default Value None
Accept Pipeline Input False
Accept Wildcard Characters false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see http://technet.microsoft.com/en-us/library/hh847884.aspx.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None.
    You cannot pipe input to this cmdlet.

Examples

-------------------------- EXAMPLE 1 --------------------------

Export-Classification -instanceName "sqlserver\sql2016" -exportFile "sql2016.csv" -format 'csv'

Exports file with classification for all columns from the given instance in the CSV format.

-------------------------- EXAMPLE 2 --------------------------

Export-Classification -instanceName "sqlserver\sql2016" -databaseName "WideWorldImporters" -exportFile "WideWorldImporters.zip" -format 'zip'

Exports file with classification for all columns from the given database in the compressed CSV format.


Didn't find what you were looking for?