Command Line Editing and History

NuoDB Manager uses JLine2 for its command line editing features. For more information about JLine2, see https://github.com/jline/jline2.

Keystrokes

The text CTRL+k is read as Control K and describes the character produced when the k key is pressed while the Control key is depressed. The text ESC+k is read as Escape K or Meta K and describes the character produced when the Meta key is depressed, and the k key is pressed. The Meta key is typically the Esc key or the Alt key.

Basic Commands

Key Command
CTRL + b Move back one character.
CTRL + f Move forward one character.
DEL or Backspace Delete the character to the left of the cursor.
ESC + d Delete the character underneath the cursor.
CTRL + a Move to the start of the line.
CTRL + e Move to the end of the line.
ESC + f Move forward a word, where a word is composed of letters and digits.
ESC + b Move backward a word.
CTRL + l Clear the screen, reprinting the current line at the top.
CTRL + k Kill the text from the current cursor position to the end of the line.
CTRL + u Kill the text from the current cursor position to the start of the line.
ESC + d Kill from the cursor to the end of the current word, or, if between words, to the end of the next word. Word boundaries are the same as those used by ESC + f.
ESC + DEL Kill from the cursor the start of the current word, or, if between words, to the start of the previous word. Word boundaries are the same as those used by ESC + b.
CTRL + w Kill from the cursor to the previous whitespace. This is different than ESC + DEL because the word boundaries differ.

Searching for Commands in the History

NuoDB Manager provides commands for searching through the command history for lines containing a specified string. There are two search modes: incremental and non-incremental. Incremental searches begin before the user has finished typing the search string. As each character of the search string is typed, NuoDB Manager displays the next entry from the history matching the string typed so far. An incremental search requires only as many characters as needed to find the desired history entry. To search backward in the history for a particular string, type CTRL + r. Typing CTRL + s searches forward through the history. CTRL + g will abort an incremental search and restore the original line. When the search is terminated, the history entry containing the search string becomes the current line.

In the following example, the user has typed three commands a, aa, aaa, after each command confirmation, the command is echo

Command Line Search Example

nuodb [domain]> help show
...
nuodb [domain]> show database config database foo
...
nuodb [domain] show domain summary
...
 
# Now you type just show with no new line...
nuodb [domain] show
 
# If you hit CTRL + s,  NuoDB Manager switches to incremental search mode and shows the first match starting from the current history item:
(i-search)`show': help show
 
# If you hit CTRL + r,  NuoDB Manager switches to reverse incremental search mode and shows the first match starting from the previous history item:
(reverse-i-search)`show': show domain summary
 

CTRL+r and CTRL+s navigates the previous next match.
CTRL+ g exits from incremental search.

Navigating History Commands

Key Command
ARROW UP Selects previous history item
ARROW DOWN Selects next history item
CTRL + s Finds next match in history
CTRL + r Finds previous match in history
CTRL + g Cancels incremental search

Command Completion

The TAB key lists all commands available. If the user has typed some characters, the list is filtered with the commands that start with those characters, like in the example below sh<TAB> results in show shutdown.

nuodb [domain] > sh<TAB>
show       shutdown 

Persistent History

NuoDB Manager command history is saved when nuodbmgr exits in the user's home folder as .nuodbmgr.history and it is reloaded in the following session. This can be disabled with the --noLineEditor command line option. The .nuodbmgr.history file is created with read/write privileges for only the owner of the file. This file may contain password information.

Configuration Files

NuoDB Manager reads two possible configuration files which are stored in the user's home folder:

File Content
.nuodbmgr.rc Standard JLine2 configuration settings as described at Configuration Properties.
.inputrc Standard Readline initialization settings as described at Readline Init File Syntax.

Disabling Command Line Editing

If command line editing causes any problems given your terminal configuration, it can be disabled with the nuodbmgr command line option --noLineEditor.