| title | description | author | ms.author | ms.reviewer | ms.date | ms.service | ms.subservice | ms.topic | f1_keywords | helpviewer_keywords | monikerRange | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Generate Scripts Wizard |
Learn how to use the Generate Scripts Wizard to create scripts to transfer a database between database instances. The instances can be instances of the SQL Server Database Engine or Azure SQL Database. |
markingmyname |
maghan |
randolphwest, mathoma |
09/27/2024 |
sql |
ssms |
conceptual |
|
|
>=aps-pdw-2016 || =azuresqldb-current || =azure-sqldw-latest || >=sql-server-2016 || >=sql-server-linux-2017 || =azuresqldb-mi-current |
[!INCLUDE SQL Server Azure SQL Database Synapse Analytics PDW]
This article teaches you to use the Generate Scripts Wizard to create scripts to transfer a database between instances of SQL Server, [!INCLUDE ssazure-sqldb], or [!INCLUDE ssazuremi-md].
You can generate scripts for a SQL Server database in your local network, or from Azure SQL. The generated scripts can be run on another instance of SQL Server or on Azure SQL. You can create scripts for an entire database, or limit it to specific objects.
For a more detailed tutorial on using the Generate Scripts wizard, see Tutorial: Generate Scripts Wizard.
The source and target database can be on [!INCLUDE ssazure-sqldb] or [!INCLUDE ssazuremi-md], or an instance of the [!INCLUDE ssDE] running [!INCLUDE ssVersion2005] or later versions.
The minimum permission to generate scripts is membership in the db_ddladmin fixed database role on the origin database.
-
In Object Explorer, expand the node for the instance containing the database to be scripted.
-
Right-click on the database you want to script, and select Tasks > Generate Scripts.
:::image type="content" source="media/generate-and-publish-scripts-wizard/generate-scripts.png" alt-text="Screenshot of Generate Scripts Wizard." lightbox="media/generate-and-publish-scripts-wizard/generate-scripts.png":::
-
Complete the wizard dialogs:
This page describes the steps for generating a script.
Do not show this page again - Skip this page the next time you start the Generate Scripts Wizard.
:::image type="content" source="media/generate-and-publish-scripts-wizard/intro.png" alt-text="Screenshot of Introduction Page." lightbox="media/generate-and-publish-scripts-wizard/intro.png":::
Use this page to choose which objects you want to include in the scripts generated by this wizard.
Script Entire Database Option - Select to generate scripts for all objects in the database and to include a script for the database itself.
:::image type="content" source="media/generate-and-publish-scripts-wizard/script-all.png" alt-text="Screenshot of script entire database." lightbox="media/generate-and-publish-scripts-wizard/script-all.png":::
Select specific database objects - Select to limit the wizard to generate scripts for only the specific objects in the database that you choose:
-
Database objects - Select at least one object to include in the script.
-
Select All - Selects all available check boxes.
-
Deselect All - Clears all the check boxes. You must select at least one database object to continue.
:::image type="content" source="media/generate-and-publish-scripts-wizard/script-specific-objects.png" alt-text="Screenshot of specific script." lightbox="media/generate-and-publish-scripts-wizard/script-specific-objects.png":::
Use this page to specify if you want the wizard to save scripts to the location of your choice.
Options - If you want the wizard to save scripts to a location of your choice, select Save scripts to a specific location. You can later run the scripts against either an instance of the Database Engine, or against [!INCLUDE ssSDS].
Save Scripts to a Specific Location - save one or more Transact-SQL script files to a location you specify.
:::image type="content" source="media/generate-and-publish-scripts-wizard/save.png" alt-text="Screenshot of Save as notebook." lightbox="media/generate-and-publish-scripts-wizard/save.png":::
-
Save as notebook - Save the script to one or more .sql files. Select the browse button (...) to specify a name and location for the file.
-
Save as script file Save the script to one or more .sql files. Select the browse button (...) to specify a name and location for the file. Select the Overwrite existing file check box to replace the file if one already exists with the same name. Select Single script file or One script file per object to specify how the scripts should be generated. Select Unicode text or ANSI text to specify the kind of text that should be used in the script.
-
Save to Clipboard - Save the Transact-SQL script to the Clipboard.
-
Open in new query window - Generate the script to a Database Engine Query Editor window. If no editor window is open, a new editor window is opened as the target for the script.
-
Advanced - Display the Advanced Options dialog box where you can select advanced scripting options.
Use this page to specify how you want this wizard to generate scripts. Many different options are available. Options are greyed out if they aren't supported by the version of SQL Server or [!INCLUDE ssSDS] specified in Database engine type.
:::image type="content" source="media/generate-and-publish-scripts-wizard/advanced.png" alt-text="Screenshot of Advanced Options." lightbox="media/generate-and-publish-scripts-wizard/advanced.png":::
Options - Specify advanced options by selecting a value from the list of available settings to the right of each option.
General - The following options apply to the entire script.
-
ANSI Padding - Includes
ANSI PADDING ONin the script. The default is False. -
Append to file - When True, this script is added to the bottom of an existing script, specified on the Set Scripting Options page. When False, the new script overwrites a previous script. The default is False.
-
Check for object existence - When True, adds the existence check before generating the create statement for your SQL Objects. For example: tables, views, functions, or stored procedures. The
CREATEstatement is wrapped in an IF statement. If you know your target is clean, the script is a lot cleaner. If you do NOT expect the objects to exist on the target, you get an error. The default is False. -
Continue scripting on error - When False, scripting stops when an error occurs. When True, scripting continues. The default is False.
-
Convert UDDTs to base types - When True, user-defined data types (UDDT) are converted into the underlying base data types that were used to create them. Use True when the UDDT doesn't exist in the database where the script runs. When False, UDDTs are used. The default is False.
-
Generate script for dependent objects - Generates a script for any object that is required to be present when the script for the selected object is executed. The default is True for the Script entire database option, and False for Select specific database objects.
-
Include descriptive headers - When True, descriptive comments are added to the script separating the script into sections for each object. The default is False.
-
Include if NOT EXISTS - When True, the script includes a statement to check whether the object already exists in the database, and doesn't try to create a new object if the object already exists. The default is False.
-
Include system constraint names - When False, the default value of constraints that were automatically named on the origin database are automatically renamed on the target database. When True, constraints have the same name on the origin and target databases.
-
Include unsupported statements - When False, the script doesn't contain statements for objects that aren't supported on the selected server version or engine type. When True, the script contains the unsupported objects. Each statement for an unsupported object has a comment that the statement must be edited before the script can be run against the selected SQL Server version or engine type. The default is False.
-
Schema qualify object names - Includes the schema name in the name of objects that are created. The default is True.
-
Script binding - Generates a script for binding default and rule objects. The default is False. For more information, see CREATE DEFAULT (Transact-SQL) and CREATE RULE (Transact-SQL).
-
Script collation - Includes collation information in the script. The default is False. For more information, see Collation and Unicode support.
-
Script defaults - Includes default objects used to set default values in table columns. The default is True. For more information, see Specify default values for columns.
-
Script drop and create - When Script CREATE, [!INCLUDE tsql] statements are included to create objects. When Script DROP, [!INCLUDE tsql] statements are included to drop objects. When Script DROP and CREATE, the [!INCLUDE tsql] drop statement is included in the script, followed by the create statement, for each scripted object. The default is Script CREATE.
-
Script extended properties - Includes extended properties in the script if the object has extended properties. The default is True.
-
Script for engine type - Creates a script that can be run on the selected type of either [!INCLUDE ssSDS] or an instance of the SQL Server Database Engine. Objects not supported on the specified type aren't included in the script. The default is the type of the origin server.
-
Script for server version - Creates a script that can be run on the selected version of [!INCLUDE ssNoVersion]. Features new to a version can't be scripted for earlier versions. The default is the version of the origin server.
-
Script logins - When the object to be scripted is a database user, this option creates the logins on which the user depends. The default is False.
-
Script object-Level permissions - Includes scripts to set permission on the objects in the database. The default is False.
-
Script statistics - When set to Script Statistics, this option includes the
CREATE STATISTICSstatement to re-create statistics on the object. The Script statistics and histograms option also creates histogram information. The default is Do not script statistics. For more information, see CREATE STATISTICS (Transact-SQL). -
Script USE DATABASE - Adds the
USE DATABASEstatement to the script. To make sure that database objects are created in the correct database, include theUSE DATABASEstatement. If you expect to use the script in a different database, select False to omit theUSE DATABASEstatement. The default is True. For more information, see USE (Transact-SQL). -
Types of data to script - Selects what should be scripted: Data only, Schema only, or both. The default is Schema only.
Table/View Options - The following options apply only to scripts for tables or views.
-
Script change tracking - Scripts change tracking, if enabled on the origin database, or tables in the origin database. The default is False. For more information, see About Change Tracking (SQL Server).
-
Script check constraints - Adds
CHECKconstraints to the script. The default is True.CHECKconstraints require data that is entered into a table to meet some specified condition. For more information, see Unique constraints and check constraints. -
Script data compression options - Scripts data compression options if they're configured on the origin database, or tables in the origin database. For more information, see Data compression. The default is False.
-
Script foreign keys - Adds foreign keys to the script. The default is True. Foreign keys indicate and enforce relationships between tables.
-
Script full-text indexes - Scripts the creation of full-text indexes. The default is False.
-
Script indexes - Scripts the creation of indexes. The default is True for the Script entire database option, and False for Select specific database objects. Indexes help you find data quickly.
-
Script primary keys - Scripts the creation of primary keys on tables. The default is True. Primary keys uniquely identify each row of a table.
-
Script triggers - Scripts the creation of DML triggers on tables. The default is False. A DML trigger is an action programmed to execute when a data manipulation language (DML) event occurs in the database server. For more information, see DML Triggers.
-
Script unique keys - Scripts the creation of unique keys on tables. Unique keys prevent duplicate data from being entered. The default is True. For more information, see Unique constraints and check constraints.
:::image type="content" source="media/generate-and-publish-scripts-wizard/summary.png" alt-text="Screenshot of GS Summary.":::
This page summarizes the options that you selected in this wizard. To change an option, select Previous. To begin generating scripts, select Next.
Review your selections - Displays the selections you made for each page of the wizard. Expand a node to see the selected options for the corresponding page.
Use this page to monitor the progress of the wizard as it occurs.
Details - View the Action column to see the progress of the wizard. After the wizard generates the scripts, it saves the scripts to a file. When each of these steps is complete, select the value in the Result column to see the outcome of the corresponding step.
Save Report - Select to save the results of the wizard's progress to a file.
Cancel - Select to close the wizard before processing is complete, or if an error occurs.
Finish - Select to close the wizard after processing is complete, or if an error occurs.
:::image type="content" source="media/generate-and-publish-scripts-wizard/save-scripts-finish.png" alt-text="Screenshot of Finish.":::
If all the settings are correct, your configuration finishes successfully.
If the syntax generated when using "Script As..." doesn't look like [!INCLUDE ssazuresynapse-md] syntax or if you receive an error message, you might need to set your scripting options in SQL Server Management Studio to [!INCLUDE ssazuresynapse-md].
In order to script objects with [!INCLUDE ssazuresynapse-md] syntax, set the default scripting option to [!INCLUDE ssazuresynapse-md] as follows:
- Select Tools then Options.
- Select SQL Server Object Explorer, and Scripting.
- Under Version options, set Match script settings to source to False.
- Set Script for database engine type to Microsoft Azure SQL Database Edition.
- For dedicated SQL pools in Azure Synapse Analytics, set Script for the database engine edition to Microsoft Azure SQL Data Warehouse Edition.
- Select OK.
If you set [!INCLUDE ssazuresynapse-md] as your default scripting option as shown previously, these instructions can be ignored. However, if you choose to use different default scripting options, you might encounter an error. To avoid errors, follow these steps in order to Generate Scripts for [!INCLUDE ssazuresynapse-md]:
- In Object Explorer, right-click your dedicated SQL pool under Databases.
- Select Generate Scripts.
- Choose Objects you wish to script.
- In Scripting Options, select Advanced. Under General set:
- Script for the database engine type: Microsoft Azure SQL Database.
- Script for the database engine edition: Microsoft Azure SQL Data Warehouse Edition.
- Select Save Scripts then Finish.
The options set in Step 4 aren't remembered. If you prefer for these options to be remembered, follow the instructions in How to set default scripting options to SQL Data Warehouse.