Open topic with navigation

Learn more about Toad for SQL Server at Dell Software Find solutions and downloads at the Toad for SQL Server Support Portal

About Editing SQL

The editor combines a powerful SQL and procedure editor and debugger into a single interface.

Notes:

• See Editor Shortcut Keys for more information about keyboard shortcuts used in the Editor.
• Toad has implemented a large script mode to improve performance when opening files larger than 2 MB. By default, when you open a large file, some features such as word wrap, syntax highlighting, and the Script Map are disabled in the Editor. When a large script loads, a message indicates that you are in large script mode in the right margin of the Editor. You can cancel large script mode by clearing the option in Tools | Options | Editor | General.
• To show the Script Map, Script Results or Group Execute panes for the current Editor window select Editor | Windows | <pane>.

To edit SQL

1. Select Tools | Edit.

2. Review the following to help enter SQL:

   • Complete SQL Statements Automatically

   • Explore and Edit Script with Script Map

   • Insert Code Snippets and Create Code Snippets
   • Add Toad Views

   • Recall SQL Statements 

   • Add or Remove Application Code 

   • View Objects at Cursor 

   • Record and Play Macros 

   • About Toad Script

3. Click to format the code. See Format SQL for more information.

4. Right-click a block of code in the Editor to see additional actions available in the context menu. For example, you can turn a line into comment, uppercase or lowercase it, surround with snippet, set numbered bookmark, collapse or expand nodes, send to Query Builder and etc. You can also right-click an object (e.g. a table) and manage it as if in the Object Explorer.

5. Select the block of code in the Editor, and click to validate the syntax.

   Note: Toad undoes any changes to the object and data in the database after executing the script (notice that the Result Sets tab is empty). To modify the object and data, you need to execute the script.

6. Debug code. See About Debugging SQL for more information.

7. Click to execute SQL on the current server or multiple servers at one time.See Group Execution of Scripts for more information. In the Editor toolbar, the execute SQL buttons are grouped under . The button will retain the function of the last execute action for the active Editor window. If you switch to another Editor window, the button will change to reflect the last action for that window.

8. To tune SQL, right-click a statement in the Editor and select Advanced | Optimize the Current Statement (available if you purchased a version of Toad that includes the SQL Optimizer). If you have not purchased this version, you can tune the statement by right-clicking it and selecting Advanced | Analyze in Database Engine Tuning Advisor.

9. Select the block of code in the Editor and click to create a stored procedure. Stored Procedure creation dialog automatically recognizes procedure body and declared parameters.

Tips:

• Toad automatically saves a backup copy of any modified editor file in the Application Data Directory to avoid losing your work. When you restart Toad after an unexpected close, Toad checks the timestamp on the backup file against the original file, and opens the file that has the latest timestamp. The document recovery option is in Tools | Options | Environment | General. See General Environment Options for more information.
• You can save the current connection, SQL script, executed results, filters, and group execute connections/results (if enabled) in a Toad editor file (.tef). This file format is useful for building scripts that have large result sets that you do not want to continue executing or for saving results when you have not finished building a script.

• You can create TOADSQLFILE.sql in order to use it's contents as template when opening new Editor window. Save it in a root folder for code snippets. See Code Completion Options for more information.

• The creation scripts that were sent to the Editor by right-clicking the object in the Object Explorer and selecting Generate SQL | To Editor | Creation script share the settings with Script tab of the Object Details pane. Unless the options are selected in the Script tab (constraints, dependencies, extended properties, etc.) their statements won't be displayed. See Work with SQL Scripts for more information.

• Editor supports floating window mode.

• The script is automatically checked for syntax errors when executing current statement (F9), checking syntax, changing database, or refreshing the Script Map. The syntax errors are listed in the Script Results pane in the Messages tab.

Configure Editor Options

You can specify options for the look and behavior of the SQL Editor by using the Toad Options dialog.

To configure Editor options

1. Select Tools | Options.

2. To specify one of the following options, select the corresponding page in the Options dialog.

   Option Description	Page in Options Dialog
   Display the tabs for the current connection only when using Tabbed windows	Select Environment | Interface
   Change background color of the Editor	Select Editor | General
   Use connection color as background color	Select Editor | General
   Position Editor tab headers vertically	Select Environment | Interface
   Set options to display line numbers, line modifications, and general text formatting	Select Editor | General
   Specify options to automatically replace typed text with the correct substitution text	Select Editor | Auto-replace
   Customize code formatting options including headers and layout characteristics	Select Editor | Formatter

of