Home

	Expand Search

SQL Advantage User's Guide

Chapter 1: Introduction

SQL Advantage Session Windows

SQL Advantage Session Windows

SQL Advantage may have zero, one, or more documents open at any given time, each having its own session window. Each new session window (see Figure 1-1) has a query window pane, where you enter your query scripts; and an associated message window pane, located below the query window pane. The message window pane displays query execution errors and informational messages. The message window pane is hidden if the splitter bar is pulled all the way down, and the query pane is hidden if the splitter bar is pulled all the way up.

Each session window may or may not have connection to a SQL Server. You can start editing a script in the query window pane without having a connection to a SQL Server. You can create and execute T-SQL queries (scripts) from the query window pane.

After you execute your queries, results are displayed in separate result windows (see "SQL Advantage Result Windows").

Note: Fatal communication errors and unexpected internal errors are displayed in alerts, not in the message window pane.

Figure 1-1: SQL Advantage Application and Session windows

SQL Advantage has the following application and session window indicators and controls:

• Application control menu
• Application window minimize/maximize controls
• Application window status bar
• Application window main menu bar
• Application window toolbar
• Session window control menu
• Session window minimize/maximize controls
• Session window status bar

About Menus

Note that menus in the SQL Advantage menu bar have one letter underlined; this is a mnemonic key that you can use, in combination with the Alt key, to select that menu should you not have a mouse.

For example:

• Application Window control menu, select Alt + Space
• Session Window control menu, select Alt + -
• Result Window control menu, select Alt + -
• File menu, select Alt + F
• Edit menu, select Alt + E
• View menu, select Alt + V
• Server menu, select Alt + S
• Query menu, select Alt + Q
• Window menu, select Alt + W
• Help menu, select Alt + H

Similarly, most menu commands have one letter underlined that you can use to invoke that command after the menu has been selected. Also, some menu commands have short-cut accelerator keys that you can use to invoke the command. Where applicable, these short cut accelerator keys appear to the right of the command in the menu.

Application Window Control Menu

The application window control menu is a drop-down menu displayed when you click the mouse button in the close box in the top left corner of the SQL Advantage application window (see Figure 1-1).

The application control menu has the following commands:

• Restore - Restores the application window to its previous size after it is minimized or maximized.
• Move - Lets you use the keyboard to move the application window to another position.
• Size - Lets you use the keyboard to change the size of the application window.
• Minimize - Reduces the application window to an icon on the desktop.
• Maximize - Enlarges the application window to its maximum size.
• Close - Closes your Windows session and dismisses the SQL Advantage application window.
• Switch To... - Opens a task list that you can use to switch between running applications and rearrange their windows and icons.

Main Menu Bar

Reading from left to right across the menu bar (see Figure 1-1), SQL Advantage has the following menus:

• File
• Edit
• View
• Server
• Query
• Window
• Help

File Menu

The File menu has the following commands:

• New - Opens a new session window to edit scripts. The new session window inherits global preferences (see "Setting Preferences" ).

  Note: Opening a new session window does not automatically establish a SQL Server connection.

• Open... - Opens an existing SQL Advantage query script, or saved results, from a saved file, into a new window.

  SQL Advantage remembers the last selected type of file in the current application.

  Up to four of the most-recently, worked-on files are listed at the bottom of the File menu. You can quickly reopen any of these files by clicking the file name.

  You can also quickly open any of your saved SQL Advantage files by double-clicking the appropriate filename in the File Manager.

  Note: To open a saved SQL Advantage file by double-clicking a filename in File Manager, you must establish an appropriate association for each type of SQL Advantage file (*.sql, *.txt, and *.rpt).

• Load... - Loads a query script into an active session window using the Load dialog box. A new script is inserted at the current cursor location in the query window pane. If text is selected in the query window pane prior to loading a script, the new script replaces the current text selection. This command is disabled if no query window is open.
• Close - Closes the active window. If there are any unsaved changes in the window, and you have set your preferences to do so, an optional closing message dialog box opens prompting you to save the changes first.

  Closing a session window disconnects the connection to SQL Server, if any. If a query session is in progress, you are prompted to cancel that query before closing.

  When closing a result window, if you set your preferences to do so, you are prompted to save first.

  You can also close a window using the window's control menu. If SQL Advantage has no query sessions or result windows open, this command is disabled.

• Save - For query windows, saves the current query script (with its messages) to a specified filename. Preferences, font information, and any messages are saved with session files. You can save the file as:
  • A session file which contains the query script and all associated messages and preferences. The default extension is .sql.
  • A text file which contains just the query script. The default extension is .txt.

  For result windows, saves the contents and font to a specified filename. You can save the file as:

  • A text file which contains just the result data for a single text result window. The default extension is .txt.
  • For grid result windows, a result file which contains the result data and grid layout information. The default extension is .rpt.
  • For multiple text result windows, a result file which contains the result data information. The default extension is .rpt.

  If the specified <filename> already exists, a prompt asks you if you want to overwrite it.

  A saved grid result window is reopened as a grid window. Its formatted options are saved with the result file.

  The first time you save a window to a file, the Save As dialog box opens to prompt you to specify the file name; thereafter, the file is saved immediately with no dialog prompt. To save an existing script or set of results under another name, choose Save As... from the File menu.

  If SQL Advantage has no query or result windows open, or if no changes have been made since the window was last saved, the Save command is disabled.

• Save As... - Saves the contents of the current active window and the font to a new renamed file without changing the existing file using the standard Windows Save As dialog box.

  For query windows, you can save the file as:

  • A session file which contains the query script and all associated messages and preferences. The default extension is .sql.
  • A text file which contains just the query script. The default extension is .txt.

  For result windows, you can save the file as:

  • For a single text result window, a text file which contains just the result data . The default extension is .txt.
  • For a single text result window, a result file which contains just the result data. The default extension is .rpt
  • For grid result windows, a result file which contains the result data and grid layout information. The default extension is .rpt.
  • For multiple text result windows, a result file which contains the result data information. The default extension is .rpt.

  If the specified <filename> already exists, a prompt asks you if you want to overwrite it.

  In the Save As dialog box, select the file type from the Save File As Type drop-down list. Note that this list is dependent upon the type of window that is currently active.

  If SQL Advantage has no query or result windows open, the Save As... command is disabled.

• Save All - Saves all the open, changed query and result windows to separate files. You are prompted for a different file name for each window if it has not been previously saved. If SQL Advantage has no query sessions or result windows open, this command is disabled.
• Preferences - Lets you set user preferences for SQL Advantage. When you choose Preferences from the File menu, you must then choose either global or session preferences from a cascading menu that opens to the right of the Preferences command. Session preferences apply only to the current session; global preferences, if changed, do not apply to the current session, but do apply to all newly created sessions.

  Set your session or global preferences in each of the following four categories:

  • Query - preferences for the query session window and query execution
  • Connection - preferences for SQL Server connection
  • Result - preferences fortype of result window and display of query results
  • Miscellaneous - miscellaneous application preferences

  Session preferences are disabled if the window having focus is not a session window.

• Print... - Controls how the contents of a query window pane, message window pane or result window are printed. The contents of the window having current focus are printed out. Before using this command, you must install and select a printer. To install and select a printer, see your Microsoft Windows documentation.

  You can print:

  • The complete document; that is, all the pages comprising a multipage document
  • A range of pages in the document; that is, a subset of the document
  • Only specific text selected in the query pane of the session window or the result pane of the result window. Text in the query pane of a text result window is not printed.

    Note: For a result window in grid output mode, you can print only the complete contents of a single cell (that is, partial contents of a cell are not allowed) or the complete contents of a contiguous group of cells, rows, or columns.

• Page Setup... - Lets you set page headers and footers, page margins, and the order in which pages are printed.
• Exit - Closes all open windows prompting you to save any unsaved data, performs the necessary clean-up before exiting from the application, and shuts down from SQL Server.

Edit Menu

The Edit menu has the following commands:

• Undo - Undoes the last edit operation on the current editable window only. If the last edit operation cannot be undone, this command is disabled. Where applicable, you can undo the Undo command (that is, redo).
• Cut - Removes selected text in the current window and puts it on the Clipboard. Text that you place on the Clipboard replaces the previous contents of the Clipboard. This command is available only after you select text.
• Copy - Copies selected text in the current window to the Clipboard. Text that you copy to the Clipboard replaces the previous contents of the Clipboard. Text may be copied from anywhere it can be selected.
• Paste - Inserts a copy of the Clipboard textual contents at the insertion point, in any text window, replacing the selection in the current window (if any) with the text on the Clipboard. This command is disabled if the Clipboard is empty, or does not contain text, or if the current window having focus is a grid window or the message pane of the session window.
• Clear/Clear All Messages - In the query window pane, the Clear command removes selected text in the current window. Note that this command does not copy selected text to the Clipboard.

  If you click or select text in the message window pane, this command changes to the Clear All Messages command which removes all messages displayed in the message window pane.

• Select All - Selects all text in the current query window pane, message window pane, or result window in text output mode; or all the rows/columns/cells in a result window in grid output mode.
• Find... - Lets you search for specific text sequences within the current query, message, or result window.
• Replace... - Lets you search for a specific text sequence within the current query, message, or result window in text output mode, and replace it with another specified text sequence. This function is disabled for session windowmessage panes and grid result windows .
• Font... - Lets you change the font in the current window. Font changes apply to the entire window. The Font command is disabled for grid result windows.

View Menu

The View menu has the following commands:

• Tool bar - Toggles the toolbar display on and off. When the toolbar is displayed, a check mark appears beside this command.
• Status bar - If a session window has focus, toggles the session window status bar display on and off, but not the application window status bar. When the session window loses focus, this command toggles the application window status bar display on and off. When the status bar is displayed, a check mark appears beside this command.
• Edit Cell... - Enabled only when you select a single cell in a grid result window; it is disabled if you attempt to select multiple cells. When results are displayed in grid output mode, results data for columns is displayed up to the display text length option specified in your Result Preferences.

  When you choose the Edit Cell... command, the Edit Cell dialog box opens to let you edit the full contents of the selected cell. You must click OK to accept your editing changes, or cancel the edit cell operation before you can perform any other work. Edited results cell content is for your information purposes only; it does not alter data in the database.

• Refresh Lists - Refreshes the contents of the database drop-down list box on the toolbar, and the Tables and Columns, Views and Columns, and Stored Procedures pick lists. This command is enabled only when a query session is open and you are connected to a SQL Server.
• Pick Lists - To enhance accuracy and increase productivity, floating, modeless pick lists let you easily insert column, table, view, and stored procedure names, and T-SQL commands and system procedures syntax into query windows. You can also use the stored procedures pick list to select and execute procedures.

  The pick lists are sensitive to the current session window's database connection and the Tables and Columns, Views and Columns, and Stored Procedures pick lists update themselves when the connection changes. The pick list subcommands are enabled only when a query window is open and has focus, and you are connected to a SQL Server. Pick lists are not enabled when a result window has focus, if the session window is minimized, or if there is no connection to SQL Server.

  • Tables & Columns - Invokes the Tables and Columns pick list. Each primary level in this hierarchal pick list represents a table with its columns indented beneath it. The tables are listed in alphabetical order by name, and the owner name follows the table name, in parentheses, if the owner is not dbo.
  • Views & Columns - Invokes the Views and Columns pick list. Each primary level in this hierarchal pick list represents a view with its columns indented beneath it. The views are listed in alphabetical order by name, and the owner name follows the view name, in parentheses, if the owner is not dbo.
  • Procedures - Invokes the Stored Procedures pick list. The stored procedures are listed in alphabetical order and include the system stored procedures. The owner name follows the stored procedure name, in parentheses, if the owner is not dbo.
  • T-SQL Commands Syntax - Invokes the T-SQL Commands Syntax pick list. The T-SQL commands are listed in alphabetical order.
  • System Procedures Syntax - Invokes the System Procedures Syntax pick list. The system procedures are listed in alphabetical order.

    Note: T-SQL Commands Syntax and System Procedures Syntax pick lists are disabled if not connected to SQL Server release 10.0 or later, or if the sp_syntax stored procedure is not fully installed on the SQL Server to which you are connected.

Server Menu

The Server menu has the following commands:

• Connect... - Lets you connect a session to a SQL Server by opening a connect dialog box. You may have multiple connections to one or more servers, but each connection is maintained within a different session window.

  If you choose Connect while connected to a SQL Server, you are prompted to disconnect from the current SQL Server before connecting to a different SQL Server, or the same one again.

• Disconnect - Enables dropping of the connection from a SQL Server in the active session window. A message box opens prompting you to confirm this intent. After disconnection, note that the session window remains open and any text in the query pane remains visible.

  Note: Before disconnecting, you must cancel any executing queries.

Query Menu

The Query menu has the following commands:

• Execute Query/Execute Selection - If you have a highlighted selection in the query window pane, the Execute Query command changes to the Execute Selection command.

  This command executes the script in the query window pane. SQL Advantage submits the script to SQL Server for execution. The current SQL Advantage session then waits for SQL Server to process the script. If there is no connection to SQL Server, you are prompted to connect before execution can happen.

  This command is disabled if:

  • There is no text in the session window query pane
  • The window with focus is not a session window
  • A query is executing for the current query window
  • The session window is minimized
• Cancel Execution - Cancels execution of a current query in progress. This command is enabled when there is an active query executing in the session window having focus, or when a result window is being filled (in which case, it cancels result display).
• History... - Lets you access the query script history by opening the History dialog box. This dialog box lists the last ten recorded scripts for the active query session.

  The first item in the list (the most-recently recorded) is initially selected. This command is disabled if a session window does not have focus or if there is no connection to a SQL Server.

• Execute Stored Procedure... - Opens the Execute Stored Procedure dialog box for you to execute a stored procedure. A drop-down list box is populated with stored procedures taken from the currently used database, from sybsystemprocs (the system stored procedures) if you are running SQL Server release 10.0 and later; and from the master database if you are running SQL Server pre-release 10.0. At the first invocation of this dialog, nothing is selected in the drop-down list box; otherwise, it remembers the last-selected stored procedure. This command is enabled only when a session window has focus, and you are connected to a SQL Server. Disabled if a query is executing in the session window.
• Joins... - To assist you in constructing joins, this command opens the Join Selection dialog box that displays column join candidates for any two selected tables or views (similar to the output from the system stored procedure, sp_helpjoins). You can paste this join query segment into the current query window. This command is enabled only when a session window has focus, and you are connected to SQL Server. Disabled if a query is executing in the session window.

Window Menu

The Window menu has the following commands:

• Cascade - Arranges the open group windows in an overlapping pattern so that the title bar of each window is visible.
• Tile - Arranges the open group windows in a tile pattern where each window is of equal size and all the tiled windows fill the monitor screen.
• Open Windows List - A horizontal line below the Windows menu commands divides the Window menu into two distinct areas. The area below the line lists open SQL Advantage windows. A check mark appears beside the window having current focus. To change focus to another window, choose the appropriate window name in the list.

Help Menu

The Help menu has the following commands:

• Contents - Displays the contents of the online help, reference information, and step-by-step instructions for using SQL Advantage.
• Search for Help on... - Lets you search in SQL Advantage online help for information related to specific topics. After choosing the Search for Help on... command, type the topic name or select it from the list in the Search dialog list box, and then click the Show Topics command button to see related topics.

  To display a particular topic from the list of topics, select it and then click Go To.

  To quickly search for information in the online help system, open the Search dialog box.

• How to Use Help - Instructions on how to use online help. In the Help window, use the scroll bar to view information not visible.
• Technical Support - Contact information for Sybase Technical Support.
• About SQL Advantage... - SQL Advantage release and copyright information.

Toolbar

SQL Advantage has a toolbar that provides quick access to some SQL Advantage menu commands (see Figure 1-2 and Table 1-1).

Toggle the toolbar display on and off by choosing Tool bar from the View menu. When the toolbar is displayed, a check mark appears beside this command.

Note the SQL Advantage toolbar follows standard Windows behavior as described in the Microsoft Windows User's Guide.

Figure 1-2: Toolbar

Toolbar Microhelp

When you position the mouse cursor over a toolbar command button, and wait 2 seconds or more before you click a mouse button, a one- or two-word message describing that command is displayed in a tooltip over the command button. An expanded microhelp description is also displayed in the application window status bar (see Figure 1-4):

Table 1-1: Toolbar Commands

Command	Description	For more information...
New	Same as the New command in the File menu	See "File Menu"
Open	Same as the Open command in the File menu	See "File Menu"
Save	Same as the Save command in the File menu	See "File Menu"
Print	Same as the Print command in the File menu	See "File Menu"
Preferences	Same as the Preferences command in the File menu. If a session window has focus when you invoke this command, you can set preferences just for the current session. If a session window does not have focus when you invoke this command, you can set global preferences which are retained between sessions.	See "File Menu"
Undo	Same as the Undo command in the Edit menu	See "Edit Menu"
Cut	Same as the Cut command in the Edit menu	See "Edit Menu"
Copy	Same as the Copy command in the Edit menu	See "Edit Menu"
Paste	Same as the Paste command in the Edit menu	See "Edit Menu"
Find	Same as the Find command in the Edit menu	See "Edit Menu"
Execute	Same as the Execute command in the Query menu	See "Query Menu"
Cancel Execution	Same as the Cancel Execution command in the Query menu	See "Query Menu"
Change Database	Lists all the available databases from the current session's connected SQL Server. To quickly change from one database to another within a connected session to SQL Server, select the appropriate database name from the drop-down list box.	See "Changing Database". Note that changing database changes the context of the first three pick lists in the View menu. For more information, see "Using the Tables and Columns Pick List", "Using the Views and Columns Pick List", and "Using the Stored Procedures Pick List".

Application Window Minimize Control

The application window Minimize command button (see Figure 1-1) reduces the SQL Advantage application window to an icon on the desktop. This command button performs the same function as the Minimize command in the application control menu.

Application Window Maximize Control

The application window Maximize command button (see Figure 1-1) enlarges the SQL Advantage application window to full screen size. This command button performs the same function as the Maximize command in the application control menu.

Application Window Restore Control

When the application window is maximized, the Maximize command button (see Figure 1-1) changes to the Restore command button. Clicking the Restore command button restores the SQL Advantage application window to its previous screen size. This command button performs the same function as the Restore command in the application control menu.

Session Window Control Menu

The session window control menu is a drop-down menu displayed when you click the mouse button in the close box in the upper left corner of the SQL Advantage session window (see Figure 1-1).

The session control menu has the following commands:

• Restore - Restores the session window to its previous size after it has been minimized or maximized.
• Move - Lets you use the keyboard to move the session window to another position.
• Size - Lets you use the keyboard to change the size of the session window.
• Minimize - Reduces the session window to an icon in the application.
• Maximize - Enlarges the session window to its maximum size.
• Close - Dismisses the SQL Advantage session window.
• Next - Takes you to the next SQL Advantage document in the open Windows list if you have more than one SQL Advantage document open (see "Window Menu"). If you have only one document open, it does nothing.

Session Window Minimize Control

The session window Minimize command button (see Figure 1-1) reduces the SQL Advantage session window to an icon within the application window. This command button performs the same function as the Minimize command in the session control menu.

Session Window Maximize Control

The session window Maximize command button (see Figure 1-1) enlarges the SQL Advantage session window to full size within the application window. This command button performs the same function as the Maximize command in the session control menu.

Session Window Restore Control

When the session window is maximized, the Maximize command button (see Figure 1-1) changes to the Restore command button. Clicking the Restore command button restores the SQL Advantage session window to its previous screen size. This command button performs the same function as the Restore command in the session control menu.

Session Window Status Bar

The session window status bar (see Figure 1-3) located at the bottom of the session window (see Figure 1-1) displays the following current session status:

• Session status
• SQL Server name
• Login name
• Current database the login is connected to, if any
• Result window display mode

  Figure 1-3: Session window status bar
  

When the display mode for the result window is Grid, SQL Advantage displays the word Grid on the status bar. When the display mode is set to Text output, SQL Advantage displays the word Text. If SQL Advantage is started from the command line with the -o option, it displays File:<filename>.

Application Window Status Bar

The application window status bar (see Figure 1-4) at the bottom of the SQL Advantage application window displays toolbar and menu command microhelp messages and keyboard lock key status.

To toggle the display of this status bar on and off, choose Status bar from the View menu. This is only if there are no session windows open, or if a result window has focus, otherwise, it toggles the session window status bar. When the status bar is displayed, a check mark appears beside this command.

Figure 1-4: Application window status bar