Documentation 8.0
Aqua Data Studio 8.0
Supported RDBMS Servers
1. Installation
    1.1 Minimum Requirements
    1.2 Installing Aqua Data Studio in Windows OS
    1.3 Installing Aqua Data Studio in Linux OS
    1.4 Installing Aqua Data Studio in Mac OS
    1.5 Launcher & Memory Configuration
    1.6 Interface Language, Fonts & Character sets
    1.7 Charts and OpenGL/JOGL Configuration
    1.8 Application Logs & Support Information
    1.9 Configuration & Connection files
2. Registering a Database Server
    2.1 Oracle
    2.2 Oracle OCI
    2.3 DB2 iSeries
    2.4 DB2 LUW
    2.5 DB2 zOS
    2.6 MS SQL Server
    2.7 Sybase ASE
    2.8 Sybase Anywhere
    2.9 Sybase IQ
    2.10 Informix
    2.11 Teradata
    2.12 Aster nCluster
    2.13 MySQL
    2.14 PostgreSQL
    2.15 Apache Derby
    2.16 Generic JDBC
    2.17 Generic ODBC
3. JDBC Driver Configuration
    3.1 Oracle 8i JDBC Drivers
    3.2 Oracle 9i JDBC Drivers
    3.3 Oracle 10g JDBC Drivers
    3.4 Oracle 11g JDBC Drivers
    3.5 DB2 iSeries JDBC Drivers
    3.6 DB2 z/OS JDBC Drivers
    3.7 DB2 LUW 7.2 JDBC Drivers
    3.8 DB2 LUW 8.1 and DB2 UDB 8.2
    3.9 DB2 LUW 9.0 and DB2 UDB 9.5
    3.10 SQL Server JDBC Drivers
    3.11 Sybase ASE JDBC Drivers
    3.12 Sybase Anywhere JDBC Drivers
    3.13 Sybase IQ JDBC Drivers
    3.14 Informix JDBC Drivers
    3.15 Teradata JDBC Drivers
    3.16 Aster nCluster Drivers
    3.17 PostgreSQL JDBC Drivers
    3.18 MySQL JDBC Drivers
    3.19 Apache Derby JDBC Drivers
    3.20 SQLite JDBC Drivers
    3.21 Firebird JDBC Drivers
4. Workspace and Docking Framework
    4.1 Menus and Toolbar
    4.2 Shortcuts Toolbar
    4.3 Schema Browser
    4.4 Scripts Browser
    4.5 Details View
5. Query Analyzer - SQL Tool in ADS
    5.1 Invoking the Query Analyzer (CTRL+Q)
    5.2 Using the Query Analyzer
    5.3 Query Analyzer and its Environment
    5.4 Server Side Comments
    5.5 Parameterized Scripts
    5.6 Displaying Results of Queries
    5.7 Saving Query Results
    5.8 Tips and Tricks
    5.9. SQL Automation
        5.9.1 Insert, Update, Select
        5.9.2 Introduce Columns and Value Stubs
        5.9.3 Morph to Delimited List
        5.9.4 Formatting Statements
        5.9.5 Auto Completion
        5.9.6 Aqua Commands
    5.10. Charting Grids and Pivot Grids
        5.10.1 Working with Grids and Pivot Grids
        5.10.2 Working with Enhanced Charts
        5.10.3 Scripting Charts
        5.10.4 Chart Options
        5.10.5 Function Series
    5.11. Visual Explain Plan
        5.11.1 Using Explain Diagrams
        5.11.2 Sample Query Tuning Demo
6. SQL History (CTRL+ ALT+H)
7. Query Builder Tool in ADS
    7.1 Building Queries
    7.2 Workspace Reference
8. GUI Tools for Database Objects
    8.1 Creating Databases
    8.2 Creating Tables
    8.3 Creating Constraints
    8.4 Creating Indexes
    8.5 Creating Views & Triggers
    8.6 Creating Aliases & Synonyms
    8.7 Creating Storage Objects
    8.8 Multi Scripting Objects
9. Tools and Features
    9.1 How to Import Data using ADS
    9.2 How to Export Data using ADS
    9.3 Generate SQL Scripts using ADS
    9.4 Table Data Editor
    9.5 Server Script Generator
    9.6 Using Object Search in ADS
    9.7 Comparing two Database Schemas
    9.8 Using the Visual Explain White Board
    9.9 Using the Execution Monitor
    9.10 Generating ER Diagrams
10. Procedure, Function & Package Editor
11. SQL Debugger
    11.1.1 Oracle Debugger
    11.1.2 DB2 Debugger
    11.1.3 MS SQL Debugger
    11.1.4 Sybase Debugger
12. ER Modeler in ADS
    12.1 Notation and Normalization
    12.2 Creating Tables
    12.3 Creating Indexes
    12.4 Creating Constraints
    12.5 Creating Relationships & Subcategories
    12.6 Adding Notes and Regions
    12.7 Saving and Exporting an ER Model
    12.8 Forward Engineering
    12.9 Reverse Engineering
    12.10 ER Modeler Demo
    12.11 Converting ER Models DB to DB
13. Version Control in ADS
    13.1 Using a Subversion Repository
    13.2 Using a CVS Repository
    13.3 File Search in Version Control
14. Database Administrator Tools
    14.1 ORACLE DBA Tools
        14.1.1 Server Statistics
         14.1.2 Rollback Manager
         14.1.3 Log Manager
         14.1.4 Session Manager
         14.1.5 Instance Manager
         14.1.6 Storage Manager
         14.1.7 Security Manager
         14.1.8 SGA Manager
    14.2 SQL SERVER DBA Tools
        14.2.1 Instance Manager
        14.2.2 Session Manager
        14.2.3 Security Manager
        14.2.4 Storage Manager
        14.2.5 SQL Agent Manager
    14.3 SYBASE DBA Tools
        14.3.1 Instance Manager
        14.3.2 Session Manager
        14.3.3 Security Manager
        14.3.4 Storage Manager
    14.4 MySQL DBA Tools
        14.4.1 Instance Manager
        14.4.2 Session Manager
        14.4.3 Storage Manager
        14.4.4 Security Manager
    14.5 DB2 for LUW DBA Tools
        14.5.1 Instance Manager
        14.5.2 Session Manager
        14.5.3 Storage Manager
        14.5.4 Security Manager
15. Compare Tools in ADS
    15.1 File Compare
    15.2 Results Compare
    15.3 Directory Compare
    15.4 Tab Compare
    15.5 Schema Compare
    15.6 Copy History Compare
16. Editors & Viewers
17. Aqua Data Studio OPTIONS
    17.1 General Options
    17.2 Editor Options
    17.3 Compare and Results Options
    17.4 Query Analyzer Options
    17.5 Scripts and Results Options
    17.6 Visual Explain Options
    17.7 Formatter Options
    17.8 Permissions and Registration Options
    17.9 Key Mapping Options and Key Assist Tool
    17.10 Command line

4.1 Menus and Toolbar

Application Menus and Tooblar

Below is a list of all the available menus within the main application toolbar. Most of what Aqua Data Studio is capable of can be found in the main application toolbar and menus. When Aqua Data Studio is launched, the main application window and toolbars appear, with the Schema or Scripts Browser in focus depending on what was being viewed when the application was last exited. Information on the Query Analyzer Toolbar is available here.

Application Menus and Toolbar

  Application Menus  

1

File

  • New Document - Creates a new document, but requires that a query window be open first.
  • Open Document - Opens an existing document.
  • Close Document - closes the currently active document.
  • Save - Saves the active document.
  • Save As - Saves the active document prompting for a different name and destination.
  • Save All - Saves all open documents.
  • Save Results - Saves results of a query.
  • New Editor Window - Opens a new editor.
  • Print - Provides options for printing the current document.
  • Mount Directory - Allows the selection of a directory for mounting in the Script Browser.
  • Unmount Directory - Removes a directory from the Script Browser.
  • New Frame Window - Launches a new instance of Aqua Data Studio from within the same JVM (Java Virtual Machine)
  • Options - Opens the application Options window.
  • Exit - Exits Aqua Data Studio.
File Menu

2

Edit

  • Cut - Cuts the currently highlighted or selected text to the clipboard.
  • Copy - Copies the currently highlighted or selected text to the clipboard.
  • Paste - Pastes the currently copied text from the clipboard into an insertion point or over currently highlighted or selected text.
  • Paste ... - Paste History, allows items stored in the clipboard history to be selected for pasting.
  • Undo - Undo the last action.
  • Redo - Puts the last undone change back.
  • Select All - Selects all of the currently active document.
  • Incremental Find - Launches Find dialog and searches for one instance of the search term at a time.
  • Find - Launches the Find dialogue to allow searching of the currently active document.
  • Find Next - Finds the next instance of the search term.
  • Find Previous - Find the preceding instance of the search term.
  • Replace - Find instances of the search term and replace them with entered text.
  • Go To Line ... - Allows the user to move to a specific line within a document.
  • Toggle Bookmark - Hide or reveal a bookmark
  • Previous Bookmark - Move to the previous bookmark
  • Next Bookmark - Move to the next bookmark
  • To Lower Case - Changes the currently selected text to lower case.
  • To Upper Case - Changes the currently selected text to upper case.
Edit Menu

3

Server

  • New Server Group - Creates a new container for organizing registered servers.
  • Delete Server Group - Deletes a Server Group.
  • Register Server Clone - Copies the currently selected server’s settings and leaves the name blank so the user can duplicate server settings under a different name.
  • Register Server - Allows the user to register a new database server by providing its settings.
  • Unregister Server - Removes a server from the list of registered servers.
  • Server Properties - Lists the properties of the currently selected server.
  • Connect - Connects to the currently selected server.
  • Disconnect - Disconnects the currently selected server.
  • Query Analyzer - Launches the query analyzer with the currently selected server and database.
  • Query Analyzer Clone - Duplicates the contents of the query analyzer in a new query analyzer tab.
  • Querw Analyzer Window - Launches the query analyzer in a new window.
  • Query Builder - Launches the query builder.
  • Execute - Executes the statements written in the query analyzer.
Server Menu

4

Query

  • Parse - Parses the query.
  • Execute - Executes the query.
  • Execute Current - Executes the currently selected query.
  • Execute Edit - Executes an edit.
  • Execute Explain - Executes an explain.
  • Stop - Stops the currently running query.
  • Describe - Describes the definition of the tables in current query identified by the position of the cursor in the editor.
  • Auto Commit - Determines whether each statement executed is committed after execution or whether a manual commit is required.
  • Commit - Commits any executed SQL statements.
  • Rollback - Rollback any executed SQL statements not yet committed.
  • Reconnect - Reconnects to the currently selected server and database.
  • Auto Complete - Enables and disables Auto Completion.
  • Auto On All Schemas - Autocompletes on all schemas.
  • Refresh Auto Schema - Refreshes Auto Schema.
  • SQL History - Opens the SQL History Archive, displaying its contents.
  • Show Text - Displays results as text.
  • Show Text History - Determines whether the Text History results tab is displayed, which contains a history of results.
  • Show DBMS_OUTPUT - Determines whether the DBMS_OUTPUT results for Oracle are displayed.
  • Show Grid - Displays results as a grid.
  • Show Pivot Grid - Displays results as a pivot grid.
  • Show Execution Plan - Displays execution plans.
  • Show Client Statistics - Displays information on the execution of a query relating to the client.
  • Show Script Details - Determines whether detailed information on the execution of scripts are displayed.
Query Menu

5

Automate

  • Introduce Insert Stmt - Inserts text into editor of a simple INSERT statement template.
  • Introduce Update Stmt - Inserts text into editor of a simple UPDATE statement template.
  • Introduce Delete Stmt - Inserts text into editor of a simple DELETE statement template.
  • Introduce Select Stmt - Inserts text into editor of a simple SELECT statement template.
  • Introduce Columns - Inserts text into editor consisting of a list of columns belonging to the tables in the current SQL statement identified by the cursor position.
  • Introduce Qualified Columns - Inserts text into editor consisting of a list of fully qualified columns belonging to the tables in the current SQL statement identified by the cursor position.
  • Introduce Value Stubs - Inserts text into editor consisting of a list of text and numeric values matching the datatype of columns belonging to the tables in the current SQL statement identified by the cursor position.
  • Comment Statement - Comments out the current statement.
  • Comment Line - Comments out the current line.
  • Uncomment Comment - Removes the comments on a statement or selection.
  • Morph to Upper Case - Converts all selected text to Upper Case.
  • Morph to Lower Case - Converts all selected text to lower case.
  • Morph to Delimited List - Converts a list of items into a delimited list.
  • Format Current Statement - Formats the current statement.
  • Format Script- Formats the current script.
Automate Menu

6

Tools

  • Import Data - Opens the Import Data window.
  • Export Data - Opens the Export Data window.
  • Schema Script Generator - Generates scripts from schema objects.
  • Server Script Generator - Generates scripts for server use, such as backups and jobs.
  • Object Search - Opens the Object Search window.
  • Compare Tools
    • Schema Compare - Compares selected schema.
    • Tab Compare - Compares the contents of application tabs (currently open documents).
    • Directory Compare - Compares two directories.
    • File Compare - Compares two files.
    • Copy Compare - Compares clipboard history items.
    • Results Compare - Compares query results.
  • Explain Whiteboard - Displays multiple explain plains simultaneously for comparisons of explain plans.
  • Execution Monitor - Gives status and statistics of query executions.
Tools Menu

7

DBA Tools

  • Oracle
    • Instance Manager - Provides manageability of the Oracle instance allowing the user to view and modify server parameters. Including the monitoring and backup of the Oracle controlfile.
    • Storage Manager - Provides manageability of the Oracle tablespaces and datafiles. Allowing a user to visualize and maintained storage. Including object and file IO statistics.
    • Rollback Segment Manager - Provides the monitoring and maintenance or rollback segments, including current statements, transactions and execution plans.
    • Log Manager - Provides manageability of Redo Logs and Archive Logs. Allows users to create and manage redo logs including monitoring archive logs.
    • Security Manager - Provides manageability of users, roles and profiles. Allowing the user to manage permissions, roles and security of the Oracle database.
    • Session Manager - Provides manageability of database sessions, including user and system locks. Allowing the user to kill/disconnect sessions, start traces and monitor open cursors and user queries with execution plans.
    • SGA Manager - Provides manageability of the Oracle SGA area, including SQL Area, Lib Cache, Lib Cache Stats and a summary of the SGA. Allowing users to also pin and unpin code.
    • Server Statistics - Provides a summary of statistics for the Oracle instance, waits and latches.
  • DB2 LUW
    • Instance Manager - Provides manageability of the Sybase instance allowing the user to view and modify server parameters and viewing server version information.
    • Storage Manager - Provides manageability of the Sybase databases, database devices, dump devices and caches, allowing a user to visualize and maintain storage.
    • Security Manager - Provides manageability of logins, server roles, users and roles allowing the user to manage permissions, roles and security of the Sybase database.
    • Session Manager - Provides manageability of database sessions including user locks which allow the user to monitor and kill sessions.
  • SQL Server
    • Instance Manager - Provides manageability for the MS SQL instance allowing a user to view and modify server parameters and to view server version information and the server logs.
    • Storage Manager - Provides manageability for the MS SQL databases and datafiles allowing a user to visualize and maintain storage including backup devices.
    • Security Manager - Provides manageability for logins, server roles, users, roles and profiles allowing a user to manage permissions, roles and security of the MS SQL database.
    • Session Manager - Provides manageability for database sessions including user locks that allows a user to monitor and kill sessions.
    • SQL Server Agent - Provides manageability for the SQL Server Agent. This includes operators, jobs and alerts.
  • Sybase ASE
    • Instance Manager - Provides manageability of the Sybase instance allowing the user to view and modify server parameters and viewing server version information.
    • Storage Manager - Provides manageability of the Sybase databases, database devices, dump devices and caches, allowing a user to visualize and maintain storage.
    • Security Manager - Provides manageability of logins, server roles, users and roles allowing the user to manage permissions, roles and security of the Sybase database.
    • Session Manager - Provides manageability of database sessions including user locks which allow the user to monitor and kill sessions.
  • MySQL
    • Instance Manager - Provides manageability of the Sybase instance allowing the user to view and modify server parameters and viewing server version information.
    • Storage Manager - Provides manageability of the Sybase databases, database devices, dump devices and caches, allowing a user to visualize and maintain storage.
    • Security Manager - Provides manageability of logins, server roles, users and roles allowing the user to manage permissions, roles and security of the Sybase database.
    • Session Manager - Provides manageability of database sessions including user locks which allow the user to monitor and kill sessions.
Oracle DBA Tools Menu

DB2 LUW DBA Tools Menu

SQL Server DBA Tools Menu

Sybase ASE DBA Tools Menu

MySQL DBA Tools Menu

8

ER Modeler

  • New - Creates a new Entity Relationship (ER) Diagram.
  • Open - Opens an existing Entity Relationship (ER) Diagram.
  • Generate - Generates an Entity Relationship (ER) Diagram based on the objects selected in the Schema Browser.
ER Modeler Menu

9

Window

  • MultiTab/SplitPane Results - Switches between SplitPane view and MultiTab view when multipled documents are open.
  • Show/Hide Application Toolbar - Hides, reveals the Application Toolbar.
  • Show/Hide Query Toolbar - Hides, reveals the Query Toolbar.
  • Show/Hide Editor Window - Hides, reveals the Editor Window.
  • Show/Hide Query Results - Hides, reveals the Query Results.
  • Show/Hide Server Browser - Hides, reveals the Server Browser.
  • Show/Hide Panel Toolbar - Hides, reveals the Panel Toolbar.
  • Next Tab - Shifts focus to the next document.
  • Previous Tab - Shifts focus to the preceding document.
  • Next Inner Tab - Shifts focus to the next inner tab.
  • Rename Current Tab - Allows renaming of the currently active document tab.
  • Close Current Tab - Closes the current tab.
  • Close All But Current Tab - Closes all tabs but the currently active tab.
  • Close All Tabs - Closes all tabs.
  • Tab Focus Top/Bottom - Swaps focus from the tab top or bottom.
  • Focus Tree/Document - Swaps focus from the currently active document to the document tree, or vice versa.
Window Menu

10

Help

  • Key Assist - Opens the Key Assist window.
  • Online Documentation - Launches the default web browser and opens the documentation for Aqua Data Studio.
  • Mailing List - Launches the default web browser and opens the Aqua Data Studio mailing list discussions.
  • View Log - Launches Help Log and Console for error troubleshooting. The log begins capturing when it is launched.

    By default, a rolling file logger is always enabled to ~/.datastudio/datastudio.log

    This logger is configured to write up to 3 files of up to 300KB each, using "%d{M/d HH:mm:ss.SSS} %C{1}.%M %m%n layout.  (Logging month/day per Tanya’s request).

    This logger can be turned off by placing logger.config file into ~/.datastudio directory.  This file overrides built-in configuration and offers the developers or end users virtually unlimited configuration choices.

  • License - Displays the Company Name and License Key, also displays Evaluation Request Information
  • About Aqua Data Studio - Displays current version, Copyright, System, Fonts and JDBC Drivers information.
Help Menu
  Application Toolbar
11 Register Server (Insert) - Add a new database server
12 Unregister Server (Delete) - Remove a database server
13 Server Properties - Display database connection settings
14 Connect - Connect to the selected database server
15 Disconnect - Disconnect from the selected database server
16 Query Analyzer - Launch a new Query Analyzer tab
17 Query Analyzer Clone - Duplicate the contents of the current Query Analyzer tab in a new tab
18 Query Analyzer Window - Open a new Query Analyzer in a new window
19 Query Builder - Launch the Query Builder window
20 Editor (Text, HTML, XML, Java, JavaScript) & Image Viewer - Select the type of viewer/editor you wish to open. Double clicking on a file in the Server/Schema Browser opens the corresponding editor for that MIME type
21 SQL History [Archive] - Open the SQL History [Archive] window
22 Show Text - Display text results of queries
23 Show Text History - Display Text history
24 Show DBMS_OUTPUT - Display DBMS_OUTPUT
25 Show Grid - Show Grid Results
26 Show Pivot Grid - Show Pivot Grid Results
27 Show Execution Plan - Show the Execution Plan
28 Show Client Statistics - Show the Client Statistics
29 Show Script Details - Show the Script Details