Home Home Screenshots Download Documentation Contact Licensing

Documentation: Aqua Data Studio 4.7     HTML Documentation download, ZIP: ads-docs.zip (Size: 20MB) / ads-docs-no-shots.zip (Size: 368KB)
  Getting Started
  Installation
  JDBC Drivers
  I. Oracle
  II. DB2 UDB
  III. SQL Server
  IV. Sybase ASE
  V. Sybase Anywhere
  VI. Informix
  VII. PostgreSQL
  VIII. MySQL
  Character sets
  Registering Servers
  I. MSDE 2000
  II. SQL Express 2005
  III. PostgreSQL SSL
  Application
  I. Browser & Scripting 
  II. Visual Editing
  III. SQL History
  IV. Shortcut Toolbar
  V. Options
  VI. Settings
  Query Window
  I. Basics
  II. Shortcut Keys
  III. Toolbar
  IV. Server Side Comments
  V. SQL Automation
  VI. Variable Binding
  VII. Results
  VIII. Save Results
  IX. Auto-completion
  X. SQL Formatter
  XI. Permissions
  XII. Parameterized
  Visual Explain Plan
  I. Basics
  II. Explain Plan
  III. Explain Diagram
  IV. Whiteboard
  Procedure Editor
  Tools
  I. Table Data Editor
  II. Script Generator
  III. ER Diagram
  IV. Query Builder
  V. Import Tool
  VI. Export Tool

  Oracle DBA Tools
  I. Instance Manager
  II. Storage Manager
  III. Rollback Manager
  IV. Log Manager
  V. Security Manager
  VI. Session Manager
  VII. SGA Manager
  VIII. Server Statistics
Application Options - Aqua Data Studio has different configurable options, which may be accessed through the Menu:File->Options command. The option dialog contiains 6 tabs: General, Editor, Results, Query Analyzer, Scripts and Results Fromat Options.

Note: All application options are stored in a file called datastudio.properties in the user home directory. This file may be modified manually or deleted to set all settings back to default.

Aqua Data Studio Options
General - The General options include Scripts, Password, Scripting and History. The Scripts Filter options allows you to filter the files displayed in the script browser.

Aqua Data Studio General Options
  • Appearance:

          Look and Feel:Look and Feel used by the application.
          Look and Feel Font:The font used by the application for the user interface components.
          SQL Editor Font:The font used by the SQL Editor in the Query Analyzer.
          Text Results Font:The font used by the Text Results panel in the Query Analyzer.
          Grid Results Font:The font used by the Grid Results in the Query Analyzer.
          Editor Background Color:The background color for the Query Editor and results.

  • General:

          Script Filters:File extensions which identify scripts to be displayed in the schema browser, script browser and file dialogs.
          Display Server Type:Display server type [Production/Development/Test] on server node.
          ';' Statement separator:In SQL Scripts, interpret ';' at end of line as statement separator. NOTE: Enabling this feature may cause issues with PL/SQL, Transact-SQL and Procedure DDL statements.
          Save Passwords:Save passwords when registering a server.
          Maximum # of lines in Text History:Maximum # of lines in the Text History results.
          Maximum # of Message Lines:Maximum # of lines in the Messages results.
          SQL Server Quoted Identifier (Default):The default value for quoted identifier when registering a SQL Server server.
          Sybase Quoted Identifier (Default):The default value for quoted identifier when registering a Sybase server.

  • Query Windows:

          Do not prompt to save for new scripts:Determines whether the application will prompt the user to save a modified query window when closing the window.
          MultiTab Query Window:Determines whether the Query Window arranges the editor and results in a split pane or multitab pane.
          Prompt for commit when auto-commit is OFF:Determines whether the application will prompt the user to commit if rows are modified and auto-commit is not enabled.
          Changeable Oracle Schema:Determines whether the Query Window allows the user to change the schema context of the connection in the toolbar for Oracle connections.
          Changeable DB2 Schema:Determines whether the Query Window allows the user to change the schema context of the connection in the toolbar for DB2 connections.

  • Scripting:

          Indentation:Number of space identations when generating DDL scripts.
          Statement Separator:Statement separator to use when generating DDL scripts.

  • Table Data Editor:

          Transactions Required for Table Data Editor:Determines whether the Table Data Editor requires transactions. NOTE: If this is set to false, the Table Data Editor can't guarantee single row modifications for row updates.

  • Editor - The Editor section allows you to configure settings in the SQL Editor for auto-completion, syntax coloring and tab conversion options.
    Aqua Data Studio Editor Options
  • General: General options ...

          Highlight matching brace: Determines whether matching brace is auto-highlighted.

  • Auto Completion: Supports customization of auto completion behavior in the editor ...

          Auto Popup: Code completion window automatically appears when appropriate.
          Auto Popup Delay: How long to wait (in milliseconds) before automatically popping up the completion window.
          Instant Substitution: Code completion performs instant substitution, if the search result contains only one item.
          Maximumn Pane Size: The maximum size of the completion pane window.
          Minimum Pane Size: The minimum size of the completion pane window.

  • Syntax Coloring: Provides the ability to enable/disable and set the syntax color for keywords ...

          Enable Auto-Completion: Determines whether Syntax Coloring is enabled.
          SQL 92/99 Keywords: The color used for standard SQL 92 and 99 keywords.
          Numerics: The color used for numbers.
          Vendor Keywords: The color used for vendor specific keywords.
          Data Types: The color used for database specific data types.
          System Functions: The color used for database specific system functions.
          System Tables: The color used for database system tables.
          Quoted Strings: The color used for single quoted strings.
          Comments: The color used for commented text.
          Aqua Commands: The color used for aqua commands.

  • Tabs: Provides the ability to set the behavior of the Tab/Space conversion in the editor ...

          Expand Tabs to spaces: Determines whether a TAB is expanded to spaces or whether a real TAB is used.
          Number of Spaces in Tab expand: Number of spaces to expand in a TAB if Expand Tab is enabled.
          Size of Tabs: The display size in characters of a TAB.

  • Results - In the Results section you may choose different options on the results in the Query Analyzer, including how the data is retieved and how it is displayed. There are also configuration options for Visual Explain.
    Aqua Data Studio Results Options
  • Script Execution:

          Stop On Error: Stop executing statements after a failed query.

  • Data Retrieval:

          Convert binary to hex: Convert binary results to hex.
          Maximum BLOB Blocks: Maximum number of 8k blocks to retrieve from BLOB values.
          Maximum CLOB Lines: Maximum number of lines to retrieve from CLOB values.

  • Text Results:

          Maximum column length: Maximum length of characters to display per column.
          Display SQL Statement: Determines whether the SQL statements are displayed for each query.
          Display query statistics: Determines whether the statistics are displayed for each query. (ALT-SHIFT-R).
          Display warning headers: Determines whether the warning headers are displayed along with the warning messages.
          Always display 'records effected' count: Will display "records effected" even if Display Query Stats are off.

  • Message Results:

          Clear message results before execute: Determines whether to clear the message results tab before executing a statement or script.

  • Grid Results:

          Alternate row colors: Determines whether the colors of every other row uses a customized colore scheme.
          Alternate row foreground: Determines the foreground of the alternate row.
          Alternate row background: Determines the background of the alternate row.
          Clipboard Copy as default format: Determines whether Copy to clipboard will copy numeric values as the full value in the default format.

  • Syntax Coloring:

          Enabled: Determines whether Syntax Coloring is enabled.
          SQL Statements: The color used for SQL Statements.
          SQL Errors: The color used for SQL error messages.


  • Query Analyzer - Allows you to set the default values for the Query Analyzer. Any new query window opened will have the default values for 'Auto-Completion', 'Auto-Commit', 'Max Results' and 'Auto On All Schemas'. Aqua Data Studio Query Analyzer Options
    Scripts - Allows you to define how comments are handled within scripts. You may define what types of comments are Server Side Comments for each database. You may also define the quoted identifier and whether to qualify an object with the schema when scripting objects to a query window. Aqua Data Studio Scripts Options
    Results Format - Allows you to define how datatypes are formatted in the Text and Grid results. Aqua Data Studio Format Options
    Visual Explain - Allows you to configure different options for visual explain plans and diagrams. Aqua Data Studio Visual Explain
  • Oracle Visual Explain:

          Create explain table:Create explain table if it does not exist prior to executing query
          Drop explain table:Drop explain table after executing query
          Use dynamic explain table:Determines whether to use a dynamic explain table name (AQUA_EXPLAIN_[SESSIONID]) or a user defined table
          Explain schema:The schema name of the explain table to use if a user defined explain table is selected
          Explain table:The table name of the explain table to use if a user defined explain table is selected
          Display commit warning:Display commit warning when auto-commit is disabled and CREATE/DROP is enabled
          Color critical nodes:Determines on whether to color code the highest cost nodes in an explain plan
          Color critical operations:Determines on whether to color code the highest cost operations in an explain plan (i.e. 'Full Table Scan' and 'Cartesian Join')

  • DB2 Visual Explain:

          Create explain tables:Create explain tables if they do not exist before executing query
          Drop explain tables:Drop explain tables after executing query
          Color critical path:Determines on whether to color code the path to the highest code path in an explain plan
          Color critical nodes:Determines on whether to color code the highest cost nodes in an explain plan
          Color critical operations:Determines on whether to color code the highest cost operations in an explain plan (i.e. 'Full Table Scan' and 'Cartesian Join')

  • MS SQL Server Visual Explain:

          Color critical path:Color critical path
          Color critical nodes:Determines on whether to color code the highest cost nodes in an explain plan
          Color critical operations:Determines on whether to color code the highest cost operations in an explain plan (i.e. 'Full Table Scan' and 'Cartesian Join')

  • Critical Path:

          Background:Background color of the nodes in the critical path
          Foreground:Foreground color of the nodes in the critical path

  • Critical Node:

          Background of 1st critical node:Background color of the highest cost node
          Foreground of 1st critical node:Foreground color of the highest cost node
          Background of 2nd critical node:Background color of the 2nd highest cost node
          Foreground of 2nd critical node:Foreground color of the 2nd highest cost node
          Background of 3rd critical node:Background color of the 3rd highest cost node
          Foreground of 3rd critical node:Foreground color of the 3rd highest cost node

  • Critical Operation:

          Background of 1st critical operation:Background color of 1st level critical operation
          Foreground of 1st critical operation:Foreground color of 1st level critical operation
          Background of 2nd critical operation:Background color of 2nd level critical operation
          Foreground of 2nd critical operation:Foreground color of 2nd level critical operation
          Background of 3rd critical operation:Background color of 3rd level critical operation
          Foreground of 3rd critical operation:Foreground color of 3rd level critical operation

  • Formatter - In the Results section you may choose different options on the results in the Query Analyzer, including how the data is retieved and how it is displayed. There are also configuration options for Visual Explain.
    Aqua Data Studio Formatter Options
  • General:

          Show Options Dialog: Whether the Options Dialog will be shown before formatting.

  • Line Break:

          Before Comma: Adds a line break before the comma.
          After Comma: Adds a line break after the comma.
          Before Logical Operators: Adds a line break before logical operators (e.g. AND, OR).
          After Logical Operators: Adds a line break before logical operators (e.g. AND, OR).
          After SQL Keywords: Adds a line break after SQL keywords (e.g. SELECT, FROM, WHERE).
          Break for CASE Keywords: Adds line breaks for CASE keywords (i.e. CASE, WHEN, THEN, ELSE, END).
          Break for Brackets: Adds line breaks for brackets in AND, OR and WHEN.
          Wrap Line: Wraps line automatically.
          Line Wrap Column: The maximum column before line wraps.

  • Uppercase:

          SQL Keywords: Turns SQL keywords uppercase.
          Full SQL: Turns the full SQL statement uppercase.

  • Indentation:

          Number of spaces per Tab: Number of spaces to expand in a TAB if Tabs are used for indentation.
          Use Tabs for Indentation: Determines whether a real TAB is used or whether a TAB is expanded to spaces.
          Alignment on Operators: Alignment on =, , > and AS.
          Alignment on JOIN: Alignment on table joins.


  • Permissions - In the Results section you may choose different options on the results in the Query Analyzer, including how the data is retieved and how it is displayed. There are also configuration options for Visual Explain.
    Aqua Data Studio Permission Options
  • Default Production Server Permissions:

          Query Analzyer: Allows SELECT Statements: Determines whether SELECT statements may be executed in the Query Analyzer window for Production servers.
          Query Analzyer: Allows INSERT Statements: Determines whether SELECT statements may be executed in the Query Analyzer window for Production servers.
          Query Analzyer: Allows UPDATE Statements: Determines whether SELECT statements may be executed in the Query Analyzer window for Production servers.
          Query Analzyer: Allows DELETE Statements: Determines whether SELECT statements may be executed in the Query Analyzer window for Production servers.
          Query Analzyer: Allows TRUNCATE Statements: Determines whether SELECT statements may be executed in the Query Analyzer window for Production servers.
          Query Analzyer: Allows DDL Statements: Determines whether DDL (CREATE/ALTER/DROP) statements may be executed in the Query Analyzer window for Production servers.
          Query Analzyer: Allows All Other SQL Statements: Determines whether SQL statements other then SELECT, INSERT, UPDATE, DELETE, TRUNCATE, CREATE, ALTER or DROP may be executed in the Query Analyzer window for Production servers.

  • Default Development Server Permissions:

          Query Analzyer: Allows SELECT Statements: Determines whether SELECT statements may be executed in the Query Analyzer window for Development servers.
          Query Analzyer: Allows INSERT Statements: Determines whether SELECT statements may be executed in the Query Analyzer window for Development servers.
          Query Analzyer: Allows UPDATE Statements: Determines whether SELECT statements may be executed in the Query Analyzer window for Development servers.
          Query Analzyer: Allows DELETE Statements: Determines whether SELECT statements may be executed in the Query Analyzer window for Development servers.
          Query Analzyer: Allows TRUNCATE Statements: Determines whether SELECT statements may be executed in the Query Analyzer window for Development servers.
          Query Analzyer: Allows DDL Statements: Determines whether DDL (CREATE/ALTER/DROP) statements may be executed in the Query Analyzer window for Development servers.
          Query Analzyer: Allows All Other SQL Statements: Determines whether SQL statements other then SELECT, INSERT, UPDATE, DELETE, TRUNCATE, CREATE, ALTER or DROP may be executed in the Query Analyzer window for Development servers.

  • Default Test Server Permissions:

          Query Analzyer: Allows SELECT Statements: Determines whether SELECT statements may be executed in the Query Analyzer window for Test servers.
          Query Analzyer: Allows INSERT Statements: Determines whether SELECT statements may be executed in the Query Analyzer window for Test servers.
          Query Analzyer: Allows UPDATE Statements: Determines whether SELECT statements may be executed in the Query Analyzer window for Test servers.
          Query Analzyer: Allows DELETE Statements: Determines whether SELECT statements may be executed in the Query Analyzer window for Test servers.
          Query Analzyer: Allows TRUNCATE Statements: Determines whether SELECT statements may be executed in the Query Analyzer window for Test servers.
          Query Analzyer: Allows DDL Statements: Determines whether DDL (CREATE/ALTER/DROP) statements may be executed in the Query Analyzer window for Test servers.
          Query Analzyer: Allows All Other SQL Statements: Determines whether SQL statements other then SELECT, INSERT, UPDATE, DELETE, TRUNCATE, CREATE, ALTER or DROP may be executed in the Query Analyzer window for Test servers.



  • Home Screenshots Downloads Documentation Support Licensing Copyright© 2001-2006 AquaFold, Inc. All Rights Reserved