accumulo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Billie Rinaldi (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (ACCUMULO-376) Shell command list needs orginization
Date Wed, 02 May 2012 15:32:50 GMT

    [ https://issues.apache.org/jira/browse/ACCUMULO-376?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13266637#comment-13266637
] 

Billie Rinaldi commented on ACCUMULO-376:
-----------------------------------------

I propose the following grouping.  Any suggestions?

{noformat}
-- Debugging Commands -------------------
classpath          -  lists the current files on the classpath
debug              -  turns debug logging on or off
listscans          -  list what scans are currently running in accumulo. See the
                      accumulo.core.client.admin.ActiveScan javadoc for more
                      information about columns.
trace              -  turns trace logging on or off

-- Exiting Commands ---------------------
bye                -  exits the shell
exit               -  exits the shell
quit               -  exits the shell

-- Help Commands ------------------------
about              -  displays information about this program
help               -  provides information about the available commands
info               -  displays information about this program
?                  -  provides information about the available commands

-- Iterator Configuration ---------------
deleteiter         -  deletes a table-specific iterator
deletescaniter     -  deletes a table-specific scan iterator so it is no longer
                      used during this shell session
listiter           -  lists table-specific iterators
setiter            -  sets a table-specific iterator
setscaniter        -  sets a table-specific scan iterator for this shell session

-- Permissions Administration Commands --
grant              -  grants system or table permissions for a user
revoke             -  revokes system or table permissions from a user
systempermissions  -  displays a list of valid system permissions
tablepermissions   -  displays a list of valid table permissions
userpermissions    -  displays a user's system and table permissions

-- Shell Execution Commands -------------
execfile           -  specifies a file containing accumulo commands to execute
history            -  Generates a list of commands previously executed

-- Shell State Commands -----------------
authenticate       -  verifies a user's credentials
cls                -  clears the screen
clear              -  clears the screen
notable            -  returns to a tableless shell state
sleep              -  sleep for the given number of seconds
table              -  switches to the specified table
user               -  switches to the specified user
whoami             -  reports the current user name

-- Table Administration Commands --------
clonetable         -  clone a table
config             -  prints system properties and table specific properties
createtable        -  creates a new table, with optional aggregators and
                      optionally pre-split
deletetable        -  deletes a table
droptable          -  deletes a table
du                 -  Prints how much space is used by files referenced by a
                      table.  When multiple tables are specified it prints how
                      much space is used by files shared between tables, if any.
offline            -  starts the process of taking table offline
online             -  starts the process of putting a table online
renametable        -  rename a table
tables             -  displays a list of all existing tables

-- Table Control Commands ---------------
addsplits          -  add split points to an existing table
compact            -  sets all tablets for a table to major compact as soon as
                      possible (based on current time)
flush              -  flushes a tables data that is currently in memory to disk
getgroups          -  gets the locality groups for a given table
getsplits          -  retrieves the current split points for tablets in the
                      current table
merge              -  merge tablets in a table
setgroups          -  sets the locality groups for a given table (for binary or
                      commas, use Java API)

-- User Administration Commands ---------
createuser         -  creates a new user
deleteuser         -  deletes a user
dropuser           -  deletes a user
getauths           -  displays the maximum scan authorizations for a user
passwd             -  changes a user's password
setauths           -  sets the maximum scan authorizations for a user
users              -  displays a list of existing users

-- Writing, Reading, and Removing Data --
delete             -  deletes a record from a table
deletemany         -  scans a table and deletes the resulting records
deleterows         -  delete a range of rows in a table.  Note that rows
                      matching the start row ARE NOT deleted, but rows matching
                      the end row ARE deleted.
egrep              -  searches each row, column family, column qualifier and
                      value, in parallel, on the server side (using a java
                      Matcher, so put .* before and after your term if you're
                      not matching the whole element)
formatter          -  specifies a formatter to use for displaying table entries
grep               -  searches each row, column family, column qualifier and
                      value in a table for a substring (not a regular
                      expression), in parallel, on the server side
importdirectory    -  bulk imports an entire directory of data files to the
                      current table.  The boolean argument determines if
                      accumulo sets the time.
insert             -  inserts a record
maxrow             -  find the max row in a table within a given range
scan               -  scans the table, and displays the resulting records
{noformat}
                
> Shell command list needs orginization
> -------------------------------------
>
>                 Key: ACCUMULO-376
>                 URL: https://issues.apache.org/jira/browse/ACCUMULO-376
>             Project: Accumulo
>          Issue Type: Improvement
>          Components: client
>            Reporter: Keith Turner
>            Assignee: Billie Rinaldi
>             Fix For: 1.5.0
>
>
> When you type help in the shell, it prints outs this long list of commands.  I think
it would be nice if the commands were organized into groups.  Seems like this would make the
information easier to digest.  So the output might look something like the following.
> {noformat}
> user@instance> help
> Table Administration
>  createtable - 
>  online -
>  offline -
> Data Modification
>  insert -
>  delete -
> Data Retrieval
>  egrep -
>  grep - 
>  scan -
> {noformat}
> Need to come up with a list of groups.
>   

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message