Microsoft SQL Scripter Command-Line Tool
Project description
We’re excited to introduce mssql-scripter, a multi-platform command line experience for scripting SQL Server databases.
Installation
$ pip install mssql-scripterDependencies
Upon installation, mssql-scripter will detect the operating system or distribution of the host to install the mssqltoolsservice, a platform specific native dependency. Due to this native dependency being detected during the setup.py install, it is recommended that wheel caches not be shared amongst different operating system platforms and distributions. If you upgrade your operating system or distribution, please reinstall mssql-scripter with –no-cache-dir option.
$ pip install mssql-scripter --no-cache-dirUsage
For usage and help content, pass in the -h parameter, for example:
$ mssql-scripter -hHere are a example commands that run against the AdventureWorks database:
# script the database schema to stdout
$ mssql-scripter -S localhost -d AdventureWorks -U sa
# script the database schema and data to a file
$ mssql-scripter -S localhost -d AdventureWorks -U sa --schema-and-data > ./adventureworks.sql
# script the database schema and data to a stdout
$ mssql-scripter -S localhost -d AdventureWorks -U sa --include-objects Employee
# script the dbo schema to a file
$ mssql-scripter -S localhost -d AdventureWorks -U sa --include-objects dbo. > ./dboschema.sqlOptions
$ mssql-scripter -h
usage: mssql-scripter [-h] [--connection-string | -S ] [-d] [-U] [-P] [-f]
[--include-objects [[...]]] [--exclude-objects [[...]]]
[--ansi-padding] [--append] [--check-for-existence] [-r]
[--convert-uddts] [--include-dependencies] [--headers]
[--constraint-names] [--unsupported-statements]
[--object-schema] [--bindings] [--collation]
[--defaults] [--extended-properties] [--logins]
[--object-permissions] [--owner] [--use-database]
[--schema-only | --data-only | --schema-and-data]
[--script-create | --script-drop | --script-drop-create]
[--statistics]
[--target-server-version {2005,2008,2008R2,2012,2014,2016,vNext,AzureDB,AzureDW}]
[--target-server-edition {Standard,PersonalExpress,Enterprise,Stretch}]
[--change-tracking] [--check-constraints]
[--data-compressions] [--foreign-keys]
[--full-text-indexes] [--indexes] [--primary-keys]
[--triggers] [--unique-keys] [--display-progress]
mssql-scripter tool used for scripting out databases
optional arguments:
-h, --help show this help message and exit
--connection-string Connection string of database to script
-S , --server Server name.
-d , --database Database name.
-U , --user Login ID for server.
-P , --password Password.
-f , --file Output file name.
--include-objects [ [ ...]]
Database objects to include in script.
--exclude-objects [ [ ...]]
Database objects to exclude from script.
--ansi-padding Generates ANSI Padding statements.
--append Append script to file.
--check-for-existence
Check for database object existence.
-r, --continue-on-error
Continue scripting on error.
--convert-uddts Convert user-defined data types to base types.
--include-dependencies
Generate script for the dependent objects for each
object scripted.
--headers Include descriptive headers for each object scripted.
--constraint-names Include system constraint names to enforce declarative
referential integrity.
--unsupported-statements
Include statements in the script that are not
supported on the target SQL Server Version.
--object-schema Prefix object names with the object schema.
--bindings Script options to set binding options.
--collation Script the objects that use collation.
--defaults Script the default values.
--extended-properties
Script the extended properties for each object
scripted.
--logins Script all logins available on the server, passwords
will not be scripted.
--object-permissions Generate object-level permissions.
--owner Script owner for the objects.
--use-database Generate USE DATABASE statement.
--schema-only Generate scripts that contains schema only.
--data-only Generate scripts that contains data only.
--schema-and-data Generate scripts that contain schema and data.
--script-create Script object CREATE statements.
--script-drop Script object DROP statements
--script-drop-create Script object CREATE and DROP statements.
--statistics Script all statistics.
--target-server-version {2005,2008,2008R2,2012,2014,2016,vNext,AzureDB,AzureDW}
Script only features compatible with the specified SQL
Version.
--target-server-edition {Standard,PersonalExpress,Enterprise,Stretch}
Script only features compatible with the specified SQL
Server database edition.
--change-tracking Script the change tracking information.
--check-constraints Script the check constraints for each table or view
scripted.
--data-compressions Script the data compression information.
--foreign-keys Script the foreign keys for each table scripted.
--full-text-indexes Script the full-text indexes for each table or indexed
view scripted.
--indexes Script the indexes (XML and clustered) for each table
or indexed view scripted.
--primary-keys Script the primary keys for each table or view
scripted.
--triggers Script the triggers for each table or view scripted.
--unique-keys Script the unique keys for each table or view
scripted.
--display-progress Display scripting progress.Reporting issues and feedback
If you encounter any bugs with the tool please file an issue in the Issues section of our GitHub repo.
Code of Conduct
This project has adopted the Microsoft Open Source Code of Conduct.
For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
License
mssql-scritper is licensed under the MIT license.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
