Solution Explorer Copy Items in a Solution Files That Manage Solutions and Projects Solutions (SQL Server Management Studio) Associate a Query with a

Transcription

1 Table of Contents Copy Items in a Solution Files That Manage Solutions and Projects Solutions (SQL Server Management Studio) Associate a Query with a Connection in a Project Projects (SQL Server Management Studio) Move Items in a Solution Manage Files with Encoding Change the Connection Associated with a Query Add an Existing Project to a Solution Create a Project Add New Items to a Project Delete a Solution Open an Existing Solution View Project Properties Remove or Delete an Item or Project Miscellaneous Files Change the Default Location for Projects Rename Solutions and Project Items Close a Solution View or Change the Properties of a Connection in a Project Add Existing Items to a Project Create a New Solution

2 The pane in Microsoft SQL Server Management Studio provides containers called projects for managing items such as database scripts, queries, data connections, and files. One or more projects that are related to each other can be combined in a container called a solution. A solution includes one or more projects, plus files and metadata that help define the solution as a whole. A project is a set of files, plus related metadata such as connection information. Solutions and projects contain items that represent the scripts, queries, connection information and files that you need to create your database solution. IMPORTANT This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature. Benefits of Using Solutions Use these containers to: Implement source control on queries and scripts. Manage settings for your solution as a whole or for individual projects. Handle the details of file management while you focus on items that make up your database solution. Add items that are useful to multiple projects in the solution or to the solution without referencing the item in each project. Work on miscellaneous files that are independent from solutions or projects. The items contained in projects depend on the project type and whether you are using SQL Server Management Studio. Related Tasks Use the following topics to get started with SQL Server Solutions: Description Describes how to collect one or more projects in a solution. Describes how to create a project and add items like scripts and connections. Provides information about the files used by SQL Server Management Studio to manage solutions and files. Topic Solutions (SQL Server Management Studio) Projects (SQL Server Management Studio) Files That Manage Solutions and Projects

3 Copy Items in a Solution You can copy items using or Windows Explorer. To copy items within 1. In, select the item you want to copy. 2. On the Edit menu, click Copy. 3. In, select the destination project. 4. On the Edit menu, click Paste. NOTE Connections cannot be copied between projects. When copying a query with an associated connection to another project, its associated connection is not copied to the target project. You must manually create the connection in the target project. Move Items in a Solution

4 Files That Manage Solutions and Projects This topic describes the file types that are specific to Microsoft SQL Server Management Studio. By default, all solutions and their projects are created in \My Documents\SQL Server Management Studio Projects. Management Studio Solution Files SQL Server Management Studio uses different file types than Microsoft SQL Server Data Tools (SSDT) or Microsoft Visual Studio. This means you cannot open a SQL Server Management Studio solution in SQL Server Data Tools (SSDT) or in Visual Studio. SQL Server Management Studio solution files allow to display a graphical interface for managing your files. EXTENSION FILE TYPE DESCRIPTION CREATED BY.ssmssln SQL Server Management Studio Solution Object Provides the environment with references to the location on disk of Microsoft SQL Server projects, project items, and solution SQL Server Management Studio Management Studio Project Files In the same way that solutions contain solution files that manage objects in a solution, projects contain project files. The type of project file that SQL Server Management Studio creates for a project depends on the template used to create the project. The following table describes the type of file created for each project. EXTENSION.ssmssqlproj.ssmsasproj PROJECT TEMPLATE SQL Server Scripts Project Analysis Services Scripts Project Location of Solution-Level Files By default, solution-level files are created in the physical directory of the first project that is created with the solution. You can specify a directory for the solution by creating a solution, or you can specify the directory when you create a new project. If you have a directory structure similar to the logical structure shown in, project and solution files are easier to locate and share with other developers on a team. Manage Files with Encoding Miscellaneous Files Solutions (SQL Server Management Studio)

5 Projects (SQL Server Management Studio) Source Control

6 Solutions (SQL Server Management Studio) A SQL Server Management Studio solution is a collection of one or more related projects. Projects are containers that developers use to organize related files, such as sets of commonly used administration scripts. Solution Overview You can use Management Studio as a script development platform for Database Engine and Analysis Services. Use the Management Studio code editors to develop scripts and queries for relational and multidimensional databases, and collect related scripts and queries together in projects. Projects can contain: Queries and scripts that implement production processes. Connection information and files used by the queries and scripts. One or more related projects can be combined in a solution. Solutions and projects can be managed by using the pane in Management Studio. Solutions and projects can be integrated into a Microsoft Visual SourceSafe (VSS) database or other third-party source control providers, for development change tracking and life-cycle management. Solution Tasks TASK DESCRIPTION Describes how to create a new solution that can then be used to contain one or more projects. Describes how to open an existing solution in Solution Explorer. Describes how to close a solution. Describes how to delete a solution. Describes how to copy items between projects. Describes how to delete items in a project, or an entire project. Describes how to move items between projects in a solution. Describes how to rename a solution or the items in the solution. TOPIC Create a New Solution Open an Existing Solution Close a Solution Delete a Solution Copy Items in a Solution Remove or Delete an Item or Project Move Items in a Solution Rename Solutions and Project Items

7 Projects (SQL Server Management Studio) Source Control

8 Associate a Query with a Connection in a Project If a query was created without a connection, or if a query is moved from one project to another it will not be associated with a connection in the current project. To associate a query with a connection in a project 1. If the query is open in query editor, right-click a blank area of query editor, point to Connection, and then click Connect. If the query is not open, double-click the query in to connect the query. 2. In the Connect to Database Engine dialog box, provide the connection information. If the connection information matches an existing connection, the query will be associated with that connection. Change the Connection Associated with a Query View or Change the Properties of a Connection in a Project

9 Projects (SQL Server Management Studio) 12/4/ min to read Edit Online A Management Studio project is a collection of logically related scripts and files that can be saved together for database administration and development. Script Project Overview SQL Server script projects are displayed in the component of Management Studio. A script project can contain zero or more project files. You can add a project to a solution or combine more than one project within a solution. Projects can include the following: Connections. A connection, as persisted within a project, will contain login information, server name, default database, preferred protocol, authentication type, and connection properties. Connection information may optionally be stored with a script (see below). SQLScripts. Frequently used SQL scripts for the user. Double-clicking a.sql file within the project will cause the SQL Editor to open the selected script. MDX, DMX, and XMLAScripts. Frequently used MDX scripts for the user. Double-clicking an.mdx file within the project will cause the Editor to open the selected script. Misc. This folder can be used for files that do not neatly fit into any of the other default node types, such as a text file that contains the project objectives. Projects can also be integrated into a source code control system. Connecting to an Instance of SQL Server from a Script Project A script project may contain connections to an instance of SQL Server. You can connect to an instance of SQL Server in a project by clicking the connection. This will open an SQL Script window that is connected to the instance of SQL Server defined in the connection you selected. If you open a SQL Server or MDX script with a connection that uses SQL Server authentication, you will be prompted for the password using the Connect to SQL Server dialog box after the Editor has been opened and the script loaded. The connection will be closed after the corresponding window is closed. To modify information about a connection, use the properties window in Management Studio. Project Tasks TASK DESCRIPTION Describes how to create a new project in a solution. Describes how to add an existing project to a solution. TOPIC Create a Project Add an Existing Project to a Solution

10 TASK DESCRIPTION Describes how to change the default location at which project files are saved. Describes how to view the current properties for a project. Describes how to add new items, such as connections or script files, to a project. Describes how to establish the connection information for a query. Describes how to change the connection information for a query. Describes how to change connection properties. TOPIC Change the Default Location for Projects View Project Properties Add New Items to a Project Associate a Query with a Connection in a Project Change the Connection Associated with a Query View or Change the Properties of a Connection in a Project Solutions (SQL Server Management Studio) Source Control

11 Move Items in a Solution Project items in SQL Server Management Studio projects are Queries, Connections, and Miscellaneous files. You can move Queries and Miscellaneous Files between projects in, but Connections cannot be moved. To move items in 1. In, select the item you want to move. 2. On the Edit menu, click Cut. 3. In, select the destination. 4. On the Edit menu, click Paste. You can move items by dragging Query and Miscellaneous files within. Dragging allows you to see the outcome of the drag operation. Moving queries from one project type to another may cause queries to be considered as miscellaneous files in the target project. NOTE Moving a connected query does not move the connection to the target project. The query will lose its connection after it is moved to the target project. Copy Items in a Solution

12 Manage Files with Encoding 12/4/ min to read Edit Online To facilitate the display of your code in a particular language and on a particular platform, you can associate a particular character encoding with a file. Opening Files You can choose the editor you want to use to edit the file. To open a file with a specific editor 1. On the File menu, point to Open, and then click File. 2. In the Open File dialog box, select the file name. 3. Click the arrow next to the Open button, and then clickopen With from the menu that appears. 4. In the Select a program to open list, select an editor, and then click Open. To open the file with a particular encoding, select an editor with encoding support, such as SQL Query Editor with Encoding or XML Editor with Encoding. Saving Files You can also save your code with a Unicode encoding or a different code page to support various languages, such as Western European or Eastern European. You can associate a particular character encoding with a file to facilitate the display of your code in that language, as well as a line-ending type to support a particular operating system. Also, some characters, when used in file names, cannot be saved unless they are saved with Unicode encoding. To save a file with a different encoding or line ending type 1. On the File menu, click Save As. 2. In the Save File As dialog, expand the Save button, and then click Save with Encoding. 3. In the Advanced Save Options dialog box, select the encoding you want from the Encoding list. 4. From the Line Endingslist, select the type of line ending you want. NOTE If you save your file your file with Unicode encoding, the file should be checked into Microsoft Visual SourceSafe as a binary file because Visual SourceSafe does not support merging, comparing, and showing differences between files that are saved as Unicode. If you are using Visual SourceSafe to store files with ANSI, UTF8, or Unicode, be aware of the following limitations for each: ANSI files allow only characters that are supported in the current code page, which limits international use. Unicode files cannot use shared checkout, difference checking, or merging functionality because they are handled as binary files. You can use this format in international files. UTF8 files do not work safely with Visual SourceSafe because changes that cause problems for UTF8 file

13 editors are made during check in, check out, difference checking, and merging. Files That Manage Solutions and Projects Associating File Extensions to a Code Editor

14 Change the Connection Associated with a Query A query can be executed against several different servers or databases by changing the connection used by the query. To change the connection associated with a query 1. In Query Editor, right-click a blank area of Query Editor, point to Connection, and then click Change Connection. 2. In the Connect to Database Engine dialog box, provide the new connection information, and then click Connect. Associate a Query with a Connection in a Project View or Change the Properties of a Connection in a Project

15 Add an Existing Project to a Solution You can add one or more projects to an existing solution. A project can be associated with more than one solution. To add an existing project to a solution 1. In, select the solution. 2. On the File menu, point to Add, and click Existing Project. 3. In the Add Existing Project dialog box, locate the project you want to add, select the project file, and then click Open. The project is added to the selected solution. NOTE Before adding an existing project from shared directories in a multideveloper environment, you should attempt to ensure that your changes do not adversely affect or overwrite another developer's changes. Projects (SQL Server Management Studio) Solutions (SQL Server Management Studio)

16 Create a Project 12/4/ min to read Edit Online You can create one or more projects within an existing solution. To create a new project and add it to a solution 1. In, select the solution. 2. On the File menu, point to Add, and click New Project. 3. In the New Project dialog box, click a type of project. Templates In the Templates box, select a template. A brief description of the selected project template appears beneath the Templates box. Name Enter the name of the script project you want to create. A folder with the same name as the project is also created in the location displayed in the Location field. For some projects, SQL Server Management Studio creates source and other supporting files and adds them to the new project folder. NOTE For some project types, the Name text box is unavailable because specifying the location sets the name. For example, Web applications and Web services are located on a Web server and derive their name from the virtual directory specified on that server. Names cannot contain the following characters: Pound (#) Percent (%) Ampersand (&) Asterisk (*) Vertical bar ( ) Backslash (\) Colon (:) Quotation mark (") Less than (<) Greater than (>) Question mark (?) Forward slash (/) Leading or trailing spaces (' ')

17 Names reserved for Microsoft Windows or MS-DOS, such as ("nul", "aux", "con", "com1", "lpt1", and so on) Location Enter the location where you want to create your project, or choose one from the list. Browse Displays the Project Location dialog box, allowing you to navigate to a new directory in which to save the project. Solution Select Create new Solution to create a solution in. Select Add to Solution to add the new project to the solution currently open in. Create directory for Solution Select to enable the (Solution) Name text box. This option creates a new directory of the name you choose for your project and solution. Solution Name Enter the name of the new solution in which you want your project to be created. By default, this field uses the same name as entered in the Name field. Note To access this option, you must select both the Create New Solution in the Solution and the Create directory for Solution check boxes. Some project templates do not support this option, such as Web applications. Add to Source Control When this check box is selected, your source control application opens when you click OK. Complete any information required by your source control application to continue. You must have a source control client application installed to use this option. 4. Click OK. You can set a name for the script project, but the folder names are established by Management Studio and cannot be changed. You can configure the drive and path specification for the common set of folders by using the Add New Project dialog box. Right-click the solution icon in, and then click Add. The default location for script project folders is: C:\Documents and Settings\username\My Documents\SQL Server Management Studio\Projects\. Add an Existing Project to a Solution Add New Items to a Project Add Existing Items to a Project Change the Default Location for Projects Remove or Delete an Item or Project Delete a Solution

18 Add New Items to a Project Add new items to a project to extend application functionality. A new item can be a query or a connection. SQL Server Management Studio has two project types: SQL Server Script Project, and Analysis Services Script Project. The project type determines the items that you can add to the project. For example, you can add a Transact-SQL query (a file with a.sql extension) to a SQL Server Script project, but you cannot add it to an Analysis Services Script Project. SQL Server Management Studio does not allow you to create folders within projects. To organize your work, create multiple projects within the solution. To add a new query to an existing project 1. In, select a target project. 2. On the Project menu, click Add New Item. 3. In the Add New Item dialog box, select a category in the left pane. 4. Select a query template in the right pane, and then click Add. The new query is added in the Queries folder of the project. 5. In the Connect to Database Engine dialog box, specify a connection for the new query, and then click Connect. You can click Cancel on the connection dialog if you do not want to associate a connection to the new query. 6. Rename the query in if you wish. To add a new connection to an existing project 1. In, select a target project. 2. On the Project menu, click Add New Item. 3. Select Connection in the left pane. 4. Select New Connection in the right pane, and then click Add. 5. In the Connect to Database Engine dialog box, specify a connection for the new query, and then click Connect. The new connection gets added in the Connections folder of the project. Associating File Extensions to a Code Editor Add Existing Items to a Project Remove or Delete an Item or Project

19 Delete a Solution Deleting a solution permanently erases files from physical storage as well as the file items in the solution. NOTE In contrast to projects and items, a solution can only be deleted permanently, not removed temporarily. To delete a solution 1. In, select the solution you want to delete. 2. On the File menu, click Close Solution. 3. In Microsoft Windows Explorer, locate and select the files associated with the solution you want to delete. 4. On the File menu, click Delete. Create a New Solution Create a Project Remove or Delete an Item or Project

20 Open an Existing Solution You can have only one solution at a time open in. To open an existing solution 1. On the File menu, point to Open, and then click Project/Solution. 2. In the Open Project dialog box, navigate to the solution you want, click the solution, and then click Open. Create a New Solution

21 View Project Properties You can view properties associated with your projects in the Properties window. To view project properties 1. In, select a project. 2. If the Properties window is not open, on the View menu, click Properties Window. 3. View the properties of the project in the Properties window. Project properties, such as the date created, are read-only and cannot be changed from the Properties window.

22 Remove or Delete an Item or Project Project items in SQL Server Management Studio projects are Queries, Connections, and Miscellaneous files. You can remove project queries and miscellaneous files from your solution without erasing the files from storage. Remove a project or item when it is not useful in the current solution but you want to include it in another solution. To remove a project item 1. In, select the project item you want to remove. 2. On the Edit menu, click Remove. 3. On the confirmation dialog, click Remove to remove the item from the project. A removed item still exists on the file system. Therefore, you can add a removed item to its original solution or to another solution. To remove a project 1. In, select the project you want to remove. 2. On the Edit menu, click Remove. 3. On the confirmation dialog, click OK, to remove the project from the solution. You can delete a project permanently, but you first need to remove any references to the project from SQL Server Management Studio solutions, and then use Microsoft Windows Explorer to permanently delete the associated files from storage. To delete a project 1. In, remove the project you want to delete from the solution. 2. In Windows Explorer, locate and select the files associated with the project or item you want to delete. 3. On the File menu, click Delete. Add New Items to a Project Add Existing Items to a Project

23 Miscellaneous Files Files that that are external to any project are called miscellaneous files. When you have a solution open, you can open and modify miscellaneous files related to the project. A file is classified as a miscellaneous file if the file extension is not associated with the project code editor. For example, in a Microsoft SQL Server Scripts Project, files with the extension.txt or.mdx will be treated as miscellaneous files. In an MDX project, files with the extension of.txt or.sql will be treated as miscellaneous files. To associate a file extension with a code editor, see How to: Associate File Extensions to a Code Editor. There are a number of reasons why it is useful to be able to add miscellaneous files to your project. You might have a file that is not necessarily a recognized script but integral to the solution's development. Common examples include development notes or instructions, data files, and code clips. Miscellaneous files provide flexibility. For example, suppose you have a SQL Server Scripts Project that has several scripts for creation of tables and stored procedures in your database. You also have several data files for the tables with file extensions.bcp and execution instructions in a README.TXT file. You can attach the data and the README files as miscellaneous files to the project to take advantage of source control and other features of the project system. SQL Server Management Studio menus and toolbars change according to the format of the file you open. When you open a text file, for example, the Text Editor toolbar appears. If you open an XML Schema file, the XML Schema toolbar appears. While editing your XML Schema, the Text Editor toolbar is unavailable. When you switch between a project file and a miscellaneous file, all project-related commands and toolbars are replaced by those relevant to the miscellaneous file. Files That Manage Solutions and Projects Solutions (SQL Server Management Studio) Projects (SQL Server Management Studio)

24 Change the Default Location for Projects The default location for files and projects is the SQL Server Management Studio Projects folder in your My Documents folder. To change the default location for projects 1. Change the default location by opening or saving a file or project from another location. Microsoft SQL Server Management Studio stores the location of the previously opened project and uses it for the next opening or saving of a project.

25 Rename Solutions and Project Items You can rename a solution and its project items in. NOTE Projects and connections cannot be renamed. To rename a solution or item 1. In, select the solution or the project item that you want to rename. 2. On the View menu, click Properties Window. 3. In the Properties window, edit the (Name) property.

26 Close a Solution You can close a solution and remove it from. Closing a solution makes it unavailable for use by. NOTE Closing does not automatically close the solution. It only hides the window. To close a solution 1. On the File menu, click Close Solution.

27 View or Change the Properties of a Connection in a Project The properties of a connection saved in a project can be viewed and some can be modified. To change the properties of a connection in a project 1. In, right-click the connection, and then click Properties Window. 2. View the connection properties in the Properties window. You can change the Execution Timeout, Database, and Login Timeout properties. Associate a Query with a Connection in a Project Change the Connection Associated with a Query

28 Add Existing Items to a Project 12/4/ min to read Edit Online Add new items to a project to extend application functionality. An existing item can be a query or a miscellaneous file. SQL Server Management Studio has two project types: SQL Server Script Project, and Analysis Services Script Project. The project type determines the query files that you can add to the project. For example, you can add a Transact-SQL query (a file with a.sql extension) to a SQL Server Script project, but you cannot add it to an Analysis Services Script Project. To associate additional file extensions to a project type, see How to: Associate File Extensions to a Code Editor. To add an existing query or a miscellaneous file to a project 1. In, select a target project. 2. On the Project menu, click Add Existing Item. Look in Locate the files or folders to add to your project from this list. For XML Web services and ASP.NET Web applications, the files are located on the Web server. Desktop Displays the files and folders located on the desktop. My Projects Displays the files and folders at the default My Projects location. My Computer Displays the contents of your My Computer folder. File name Use this option to filter the files and folders that are displayed. Enter the full or partial file name on which to filter; use an asterisk ( * ) as a wildcard. NOTE Navigate to Web and network locations by entering the URL or network path in the File name box. For example, displays the files available at the mywebsite Web location, and \\myserver\myshare displays the files available at the myshare location on myserver. Files of type Use this option to filter files based on file extension. Each product lists default filters of the most common file types. Add Use this drop-down button to add the item to the project and open the item in its default editor. Add Copies the existing item to your project folder on disk and adds the item under the selected project in. Any changes made to the item are not reflected in the item at the original location. This is the default editor for the file type.

29 Add As Link Adds the selected file to the project and opens it with the default editor for the file type. This option opens the originally selected file and does not copy the file to the project folder. 3. If you are adding query files, the connection dialog will prompt you to specify a connection for the query. You can click Cancel on the connection dialog if you do not want to associate a connection to the query. 4. The file will be added to the Queries or Miscellaneous Files folder of the project. Add New Items to a Project Remove or Delete an Item or Project

30 Create a New Solution When you create a project, SQL Server Management Studio creates a solution to contain it. You can only open one solution at a time. SQL Server Management Studio does not allow you to create folders within projects. To organize your work, create multiple projects. To access, click on the View menu. To create a new solution and project 1. On the File menu, point to New, and then click Project. 2. In the New Project dialog box, click a type of project. 3. Optionally modify the project name in the Name text box. 4. Optionally modify the path for the solution in the Location text box. 5. Optionally modify the solution name in the Solution Name text box. 6. Click OK. Open Solutions from Source Control