Page History
| Table of Contents |
|---|
Configuring Editors
Abbreviations
You can create an abbreviation of the repeatedly or commonly used block of code. Abbreviations are editor type (e.g. SQL editor) specific.
Creating Abbreviations
To create new abbreviations
- On the Aqua Data Studio menu bar, click File > Options > expand editor > click Abbreviations.
- On the vertical bar of the Abbreviations pane, click
.
- Type a new abbreviation in the New Abbreviation dialog and then click OK.
- In the Expanded Text area, type the code fragment used repeatedly. Optionally, you can also add a description for the abbreviation in the Description area.
- In the Expand on drop-down list, choose a keystroke on which the abbreviation will expand, and then click OK.
Options and Keystrokes
This table lists the options and keystrokes using which you can perform various actions in the Abbreviation dialog.
| Option and Keystroke | Description |
| Add a new abbreviation. | |
(Alt + Delete) | Remove an existing abbreviation. |
(Alt + UP) | Move up one line. |
(Alt + Down) | Move down one line. |
| Copy an existing abbreviation. |
Appearance
You can change the overall look and feel of your editor. The editor background and foreground colors are configurable, so are the caret blink rate, style, and color.
Change an Editor's Appearance
To change an editor's appearance
- On the Aqua Data Studio menu bar, click File > Options > select editor > change settings shown in the red box > click OK.
Auto Indent
By default, Aqua Data Studio applies indentation of the current line to the next line when you press Enter. On unselecting this setting, no indentation is performed and the cursor is positioned in column 1 of the next line.
Change the Auto Indent Setting
To change the auto indent setting
- On the Aqua Data Studio menu bar, click File > Options > [Editor Type] > unselect/select the Auto Indent check box.
Set Text Limit Line Indicator
By default, a light gray vertical line appears at column 80 in the editor, indicating where a line exceeds 80 characters. You can set this text limit indicator to another value from the Options dialog. If you change the font, Aqua Data Studio plots the line based on the word space of the set font.
This table shows the comparison between the default view and when you set a new font.
Scenario 1: In the default view, the text limit line setting is set to 80 and the font is set to Monospaced, Plain, 12 | |
|---|---|
| Scenario 2: In the customized view, the text limit line setting is set to 80 and the font is set to Microsoft Himalaya, Plain, 12 |
Change the Text Limit Line Indicator Setting
To change the text limit line indicator setting
- On the Aqua Data Studio menu bar, click File > Options > select editor > select the Display Text Limit Line check box.
- (Optionally) In the Text Limit Character Count field set a new limit, and then click OK.
Configure Maximum Content Size
By default, the maximum content size for code insight features is 1000 K. If that limit is exceeded, all the code insight features, such as automatic code folding and tag completion are disabled. The maximum content size for code completion is 20000 K. If that limit is exceeded, features, such as code-completion, punctuation completion, indent guides and brace highlighting are disabled. In both cases, Aqua Data Studio displays the currently configured size and the actual content size.
Set a New Content Size
To set a new content size
- On the Aqua Data Studio menu bar, click File > Options > General.
- To set the content limit for code insight features, type the new size in the Maximum content size for code insight (K) field.
- To set the content limit for auto and punctuation completion, type the new size in the Maximum content size for code completion (K) field.
- Click OK and then restart Aqua Data Studio to apply the changes.
You might notice a slight performance delay in editors if you increase the content limit of code completion setting from 20000 K.
See Also
- For Editors: Code Insight & Code Completion Limits
- For Compare Tools: Code Completion Limits
Right-Click Options on the Annotation Bar
The right-click action in the Annotation Bar includes four options; show whitespaces, show line numbers, show indent guides and use soft wraps.
- Show Whitespaces: display white spaces and tabs in the code. Toggling this option will also change the option for all other open editors of the same type and persists in all the newly opened files for the same editor type.
- Show Line Numbers: display line numbers for each line of the code on the Annotation Bar. Toggling this option will also change the option for all other open editors of the same type and persists in all the newly opened files for the same editor type.
- Show Indent Guides: display vertical indent lines in the code for understanding the hierarchy of the structured script easily. Toggling this option will also change the option for all other open editors of the same type and persists in all the newly opened files for the same editor type.
- Use Soft Wraps: wrap longer lines exceeding the editor window to the next line.
Code Folding
Code folding is the ability to expand and collapse code fragments for easy management of a larger amount of code within one window. The code folding toggles (,
) reduce the code fragment to a single visible line, and the code appears in a tooltip on mouse-hover.
Code Folding Behavior in Editors
The following table explains the code folding behavior for all editors.
| Editor | Code Folding Behavior |
|---|---|
| SQL | Folds the entire code till the line separator. |
| HTML and XML | Folds the code within the matching tags. |
| Java/ Javascript/ Aquascript/ MongoJS | Folds the code within the parentheses. |
| Text | Code folding not supported. |
Folding Commands
Folding commands are accessible via:
The following table describes the code folding options in the Edit menu/right-click context menu.
| Option | Description |
| Expand | Expands the selected code. |
| Collapse | Collapses the selected code. |
| Expand All | Expands all the folded code. |
| Collapse All | Collapses all the folded code. |
| Fold Selection / Remove region | Folds the entire selected code, even if the code folding setting is disabled. |
Change Code Folding Setting
To change this setting
- On the Aqua Data Studio menu bar, click File > Options > select editor > select/unselect the Show Code Folding Outline check box > click OK.
Punctuation Completion
After you type an opening identifier in the editor, such as single quote, parentheses, or square brackets, the editor automatically adds a matching closing identifier and places the cursor between the two identifiers.
Punctuation Completion Settings
The following table describes the settings using which you can change punctuation completion.
| Option | Description |
| Insert Pair Bracket | Automatically inserts a corresponding closing bracket when you insert an opening bracket. |
| Insert Pair Quote | Automatically inserts a corresponding closing quote when you insert an opening quote. |
| Insert Pair ‘}’ on Pressing Enter | Automatically inserts a corresponding closing brace when you insert an opening brace. If the Insert Pair Bracket checkbox is unselected, then when Enter is pressed, the editor automatically inserts a closing brace “}.” |
Change Punctuation Completion Settings
To change this setting
- On the Aqua Data Studio menu bar, click File > Options > select editor > select/unselect the punctuation completion settings > click OK.
Encoding
Aqua Data Studio uses the following algorithm to identify encoding of a file and then applies this encoding while opening the file in its editor.
Aqua Data Studio first checks if Byte Order Mark (BOM) is added to the file. If BOM is added, Aqua Data Studio opens the file with the assigned encoding.
If BOM is not added, Aqua Data Studio attempts to recognize the encoding based on the file content.
If it recognizes UTF character encoding in the file contents, then Aqua Data Studio opens the file with UTF encoding.
If it cannot recognize the encoding by the file content, then Aqua Data Studio opens the file with the default encoding defined in File > Options > General > Editor Encoding (Default).
For new editors, Aqua Data Studio uses the default encoding defined in File > Options > General > Editor Encoding (Default).
Change the Default Encoding
File > Options > General > Editor Encoding (Default) is initialized to UTF-8 the first time you launch Aqua Data Studio.
To choose a different default encoding
- On the Aqua Data Studio menu bar, click File > Options > General.
- In the Editor Encoding (Default) drop-down list, choose a specific encoding. Choose System Dependent to have Aqua Data Studio use the default encoding of your operating system.
- Click OK.
Change Encoding of an Opened File
You can change the encoding of an opened file from the Status Bar. This action does not change the default encoding defined in the Options dialog. For example, if you change the encoding from UTF-8 to ISO-8859-1 from the Editor’s Status Bar, this change applies to that Editor instance only.
Encoding Compatibility
When the encoding of the opened file is not compatible with the set encoding, you are prompted to:
- Reload the content of the underlying file and show the file contents in the new encoding mode. The content of the underlying file stays unchanged.
- Convert the content of the underlying file in the new encoding mode. The content of the editor stays unchanged.
The gray exclamation marks mean that conversion/reload can cause information loss.
When you change the encoding of an opened file and then reload the file from the disk, if Aqua Data Studio finds differences between the contents of the opened file and the file saved on the disk then you are prompted to:
- Reload from the file system: The content of the editor changes based on the new encoding mode.
- Keep changes in memory: The content of the underlying file changes but does not affect the local copy.
If you are using the XML editor and you want to change the encoding, then you should specify an encoding declaration in the XML code. For example: ?xml version="1.0" encoding="UTF-8" standalone="no"?
Lens Mode
Hover the mouse on a warning/error stripe or anywhere outside the of the scroll box, the Lens Mode shows the code fragment to which the warning/error stripe applies, even if the code is outside the visible area of the editor. You can navigate to any part of the code visible in the lens mode with a single click.
Change Lens Mode Setting
To change this setting
On the Aqua Data Studio menu bar, click File > Options > select editor > select/unselect the Show Code Lens on Scrollbar Hover settings > click OK. 
Line Separators
Line separators denote a new line. Aqua Data Studio provides two line separators for existing files: Windows CRLF(\r\n) and Unix/OS X LF(\n) . For new files, the default line separator setting is system dependent.
Line Separator for Existing Files
To configure line separator for an existing file
- On an Editor's Status Bar, click
> choose a new line separator.
Line Separator for New Files
To configure line separator for new files
- On the Aqua Data Studio menu bar, click File > Options > select editor.
- In the Line Separator for New Files drop-down list, choose a new line separator and then click OK.
Selecting Text in the Editor
Block Selection
You can select a rectangular area of the text and perform various actions like insert, delete, and replace with block selection. After clicking on the editor's toolbar, you can select a location in the script and then hold down SHIFT and press the arrow keys to create a block from the caret position to the clicked location.
For example:
- You can select a block of text you want to delete and then delete them all with a single keystroke.
- You can replace multiple lines of text by making a block selection and typing the new text. The editor replaces the text for all lines at the same time.
- You can make multiline edits like add comments at the end of each line at one go.
Row Selection
Row selections cover text between two points in the script. You can select a location in the script and then hold down SHIFT and press the arrow keys to create a selection from the caret position to the clicked location.
The Print dialog can be launched from the toolbar () or by using the shortcut keys (CTRL/Command+P). For executed queries, you are prompted to choose the tab for printing. If no query has been executed, then the Print dialog is launched directly.
Use the Print dialog to configure the print layout and specify the text to print.
- Scope: Define the print scope. You can print the entire file or a selected region.
- Settings: Select the desired paper size and font, print with borders and line numbers, and choose the orientation style for the printout.
- Header and Footer: Specify the text you want as header or footer. By default, the editor will add the file name to the header and page number and total pages to the footer for any file printed from the editor.
- Advanced: Configure text wrapping and specify margins for the printout.
Navigate in Editors
Marker Bar
Marker bar highlights errors, warnings, bookmarks, search results, and highlighted usages in your code with multi-color tick marks on the editor’s scroll bar. On mouse-hover, the Lens Mode shows the code fragment to which the marker bar applies. The green marker bar indicates the locations of the search result; the black marker bar indicates bookmark locations; the red marker indicates error locations, and the light purple marker bar indicates highlighted usages in the AquaScript Editor.
Bookmarks
Bookmarks enable you to jump to the desired location within the file. A check sign () indicates bookmarks on the Annotation Bar. You can navigate between bookmarks by clicking the black marker bar or using Ctrl+Shift+Up (Command key on Mac) or Ctrl+Shift+Down (Command key on Mac) keystrokes.
To bookmark a line, perform any one of the following actions:
- On the Annotation bar, hold down the CTRL/Command key, and then left-click mouse next to the line numbers.
- Press Ctrl+Shift+M keystroke to create a bookmark.
- Right-click in the editor and then click Toggle Bookmark.
Similarly, to remove a bookmark, on the Annotation bar, hold down the CTRL/Command key and then left-click mouse. Alternatively, you can also right-click in the editor and then click Toggle Bookmark.
Go to Line
Go to Line navigates you to a specific line in the editor based on the user-entered number. You can view the current line and column number in the Status Bar. A colon separates the line and column number. To navigate to a specific line, click CTRL/Command+G and open the Go To Line dialog. Type the new line and column number separated by a colon, and then click OK. 
Find and Replace
You can find or find and replace specific text in the current file by using various toolbar options and keyboard shortcut keys. 
Find
The Find toolbar appears right below the editor’s toolbar when you click on the editor’s toolbar or use CTRL+F (for Windows and Linux) or Command+F (for Mac) keystroke.
- When you insert a string in the text box, the find operation immediately highlights every occurrence of the searched string in the current editor. To navigate between occurrences, use toggle buttons (
,
), shortcut keys; F3 (next occurrence) or SHIFT+F3 (previous occurrence), or marker bars.
- Additionally, you can:
- Set the search criterion such as the use of regular expressions, case-sensitive, and complete text match.
- Add, delete, select/unselect all occurrences from the find operation by using toggle buttons (
,
,
).
- View the count of the found occurrences in the upper-right corner of the toolbar.
Find and Replace
The Find and Replace toolbar appear right below the editor’s toolbar when you click on the editor’s toolbar or use CTRL+H (for Windows and Linux) or Command+H (for Mac) keystroke.
- Additionally, you can:
- Find and replace the highlighted text or replace all occurrences of the highlighted text at once.
- Exclude/include text in the replace operation. When excluding, the editor strikes off the current occurrence and moves to the next occurrence.
- Preserve the case of the found occurrences, and replace text only for the selected lines of the script as the replace criterion.
- View the count of the found occurrences in the upper-right corner of the toolbar.
You can use the recent search history () to see the list of the last few entries used for the find and find and replace operations.
Inline Diff Indicators
When you modify a file in a version controlled repository, Aqua Data Studio displays inline diff indicators on the Annotation bar. The inline diff indicator automatically indicates the differences between the edited file and its corresponding file in the repository using a different color for each action; a green diff indicator () signifies addition and a blue diff bar indicator (
) signifies replacement. An arrow
signifies deletion of lines.
Inline Diff Indicator Toolbar
A toolbar is displayed on clicking the inline diff indicator that provides options to edit the script. 
The following table describes the options in the toolbar.
| Icon | Description |
| Moves the cursor to the previous inline diff indicator. | |
| Moves the cursor to the next inline diff indicator. | |
| Rolls back to the last change made in the repository file. | |
| Shows the difference between the script before and after making the change in the file. | |
| Copies the replaced or deleted part of the script. |
Change Inline Diff Indicator Setting
To change this setting
- On the Aqua Data Studio menu bar, click File > Options > select editor > select/unselect the line Diff Sidebar check box > click OK.
Navigate between Inline Diff Indicators
You can navigate through changes made in the editor by using the Next Change and Previous Change commands of the Edit menu. 
Change Colors for Inline Diff Indicators
To change this setting
- On the Aqua Data Studio menu bar, click File > Options > Compare > type the new RGB color code for the desired setting > click OK. Additionally, you can also click
and choose a color from the color palette.
Change Font Size with Mouse Wheel
On Windows: You can change the font size (zoom) in the active editor by pressing CTRL and rotating the mouse wheel forward increases font size and rotating the mouse wheel backward decreases font size.
On OS X: Hold down the Command key and then on the trackpad use the two finger scroll to zoom.
You can also bind keyboard shortcuts to increase, decrease and reset font size. 
Change Font Size Setting
To change this setting
- On the Aqua Data Studio menu bar, click File > Options > expand General > click Appearance.
- Select/unselect the Change font size (Zoom) with Ctrl+Mouse Wheel check box and then click OK.
