Repository files navigation

This tool is no longer actively maintained. Microsoft SQL Server Management Studio providesa Generate Scripts Wizard that provides similar functionality to mssql-scripter.

We’re excited to introduce mssql-scripter, a multi-platform command lineexperience for scripting SQL Server databases.

mssql-scripter is the multiplatform command line equivalent of the widely used Generate Scripts Wizard experience in SSMS. You can use mssql-scripter on Linux, macOS, and Windows to generate data definition language (DDL) and data manipulation language (DML) T-SQL scripts for database objects in SQL Server running anywhere, Azure SQL Database, and Azure SQL Data Warehouse. You can save the generated T-SQL script to a .sql file or pipe it to standard nix utilities (for example, sed, awk, grep) for further transformations. You can edit the generated script or check it into source control and subsequently execute the script in your existing SQL database deployment processes and DevOps pipelines with standard multiplatform SQL command line tools such as sqlcmd.

mssql-scripter is built using Python and incorporates the usability principles of the new Azure CLI 2.0 tools.

$ pip install mssql-scripter

Please refer to theinstallation guide for detailed install instructions.

Please refer to theusage guide for details on options and example usage.

For general help content, pass in the-h parameter:

$ mssql-scripter -h

If you would like to contribute to the project, please refer to thedevelopment guide.

If you encounter any bugs with the tool please file an issue in theIssues section of our GitHub repo.

This project has adopted theMicrosoft Open Source Code of Conduct.

For more information see theCode of Conduct FAQ or contactopencode@microsoft.com with any additional questions or comments.

mssql-scripter is licensed under theMIT license.