|
| 1 | +# Get Started with mssql-scripter |
| 2 | + |
| 3 | +mssql-scripter is the command line equivalent of the widely used Generate Scripts Wizard experience in SSMS. |
| 4 | + |
| 5 | +You can use mssql-scripter on Linux, macOS, Windows, and the Azure Cloud Shell 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. |
| 6 | + |
| 7 | +## Install |
| 8 | + |
| 9 | +For information about installation, please see the LINK/install guide/LINK. |
| 10 | + |
| 11 | +The examples in this guide use the Adventureworks sample database. You can download the sample [here](https://www.microsoft.com/en-us/download/details.aspx?id=49502). |
| 12 | + |
| 13 | +## Generate scripts |
| 14 | +Use mssql-scripter to generate scripts for database schema and/or data by including specific objects, targeting server versions/editions, and piping the script to files. |
| 15 | + |
| 16 | +### Dump database object schema |
| 17 | + |
| 18 | + # generate DDL scripts for all objects in the Adventureworks database and save the script to a file |
| 19 | + mssql-scripter -S localhost -d AdventureWorks -U sa |
| 20 | + |
| 21 | + # alternatively, specify the schema only flag to generate DDL scripts for all objects in the Adventureworks database and save the script to a file |
| 22 | + mssql-scripter -S localhost -d AdventureWorks -U sa -f ./adventureworks.sql |
| 23 | + |
| 24 | +### Dump database object data |
| 25 | + |
| 26 | + # generate DDL scripts for all objects in the Adventureworks database and save the script to stdout. |
| 27 | + mssql-scripter -S localhost -d AdventureWorks -U sa --data-only |
| 28 | + |
| 29 | +### Dump the database object schema and data |
| 30 | + |
| 31 | + # script the database schema and data piped to a file. |
| 32 | + mssql-scripter -S localhost -d AdventureWorks -U sa --schema-and-data > ./adventureworks.sql |
| 33 | + |
| 34 | + # execute the generated above script with sqlcmd |
| 35 | + sqlcmd -S mytestserver -U sa -i ./adventureworks.sql |
| 36 | + |
| 37 | +### Include database objects |
| 38 | + |
| 39 | + # generate DDL scripts for objects that contain 'Employee' in their name to stdout |
| 40 | + mssql-scripter -S localhost -d AdventureWorks -U sa --include-objects Employee |
| 41 | + |
| 42 | + # generate DDL scripts for the dbo schema and pipe the output to a file |
| 43 | + mssql-scripter -S localhost -d AdventureWorks -U sa --include-objects dbo. > ./dboschema.sql |
| 44 | + |
| 45 | +### Exclude database objects |
| 46 | + |
| 47 | + # generate DDL scripts for objects that do not contain 'Sale' in their name to stdout |
| 48 | + mssql-scripter -S localhost -d AdventureWorks -U sa --exclude-objects Sale |
| 49 | + |
| 50 | +### Target server version |
| 51 | + |
| 52 | + # specify the version of SQL Server the script will be run against |
| 53 | + mssql-scripter -S myServer -d AdventureWorks -U myUser –-target-server-version "AzureDB" > myData.sql |
| 54 | + |
| 55 | +### Target server edition |
| 56 | + |
| 57 | + # specify the edition of SQL Server the script will be run against |
| 58 | + mssql-scripter -S localhost -d AdventureWorks -U myUser –-target-server-edition "Enterprise" > myData.sql |
| 59 | + |
| 60 | +### Pipe a generated script to sed |
| 61 | +Note this example is for Linux and macOS usage. |
| 62 | + |
| 63 | + # change a schema name in the generated DDL script |
| 64 | + # 1) generate DDL scripts for all objects in the Adventureworks database |
| 65 | + # 2) pipe generated script to sed and change all occurrences of SalesLT to SalesLT_test and save the script to a file |
| 66 | + mssql-scripter -S localhost -d Adventureworks -U sa | sed -e "s/SalesLT./SalesLT_test./g" > adventureworks_SalesLT_test.sql |
| 67 | + |
| 68 | +### Script data to a file |
| 69 | + |
| 70 | + # script all the data to a file. |
| 71 | + mssql-scripter -S localhost -d AdventureWorks -U sa --data-only > ./adventureworks-data.sql |
| 72 | + |
| 73 | +### Set environment variables |
| 74 | +You can set environment variables for your connection string through the following steps: |
| 75 | + |
| 76 | + |
| 77 | + # set environment variable MSSQL_SCRIPTER_CONNECTION_STRING with a connection string. |
| 78 | + export MSSQL_SCRIPTER_CONNECTION_STRING='Server=myserver;Database=mydb;User Id=myuser;Password=mypassword;' |
| 79 | + mssql-scripter |
| 80 | + |
| 81 | + # set environment variable MSSQL_SCRIPTER_PASSWORD so no password input is required. |
| 82 | + export MSSQL_SCRIPTER_PASSWORD='ABC123' |
| 83 | + mssql-scripter -S localhost -d AdventureWorks -U sa |
| 84 | + |
| 85 | + ## Generate and run scripts |
| 86 | + In this example you will generate a script, send it to a file, and execute the script. |
| 87 | + |
| 88 | + Generate a script and send it to a file using mssql-scripter. |
| 89 | + # script all the data to a file. |
| 90 | + mssql-scripter -S localhost -d AdventureWorks -U sa --data-only > ./adventureworks-data.sql |
| 91 | + |
| 92 | + Now that you have generated a script for your database objects, you can execute the script using sqlcmd such as in the example below. |
| 93 | + |
| 94 | + # execute the script from the file. |
| 95 | + sqlcmd -S localhost -d AdventureWorks -U sa -i`./adventureworks-data.sql |
| 96 | + |
| 97 | + You can find more details on using sqlcmd [here](https://docs.microsoft.com/en-us/sql/relational-databases/scripting/sqlcmd-use-the-utility). |
| 98 | + |
| 99 | +## Use mssql-scripter in the Cloud Shell |
| 100 | +You can use mssql-scripter in the Azure Cloud Shell to generate scripter for Azure SQL DB, Azure SQL DW, and SQL Server instances in Azure VMs. [Connect to the Azure Cloud Shell](https://docs.microsoft.com/en-us/azure/cloud-shell/overview?view=azure-cli-latest). Once connected, you can use mssql-scripter in the terminal as you would in a local terminal. |
0 commit comments