[TASK][EASY] Improve kyuubi-beeline help message

[pan3793]

What's the level of this task?

EASY

Code of Conduct

• I agree to follow this project's Code of Conduct

Search before creating

• I have searched in the task list and found no similar tasks.

Mentor

• I have sufficient expertise on this task, and I volunteer to be a mentor of this task to guide contributors through the task.

Skill requirements

• Basic knowledge of Java and Kyuubi

Background and Goals

The current kyuubi-beeline output message has some errors and is not very pretty.

$ bin/kyuubi-beeline --help
Usage: java org.apache.hive.cli.beeline.BeeLine 
   -u <database url>               the JDBC URL to connect to
   -c <named url>                  the named JDBC URL to connect to,
                                   which should be present in beeline-site.xml
                                   as the value of beeline.hs2.jdbc.url.<namedUrl>
   -r                              reconnect to last saved connect url (in conjunction with !save)
   -n <username>                   the username to connect as
   -p <password>                   the password to connect as
   -d <driver class>               the driver class to use
   -i <init file>                  script file for initialization
   -e <query>                      query that should be executed
   -f <exec file>                  script file that should be executed
   -w (or) --password-file <password file>  the password file to read password from
   --hiveconf property=value       Use value for given property
   --hivevar name=value            hive variable name and value
                                   This is Hive specific settings in which variables
                                   can be set at session level and referenced in Hive
                                   commands or queries.
   --property-file=<property-file> the file to read connection properties (url, driver, user, password) from
   --color=[true/false]            control whether color is used for display
   --showHeader=[true/false]       show column names in query results
   --escapeCRLF=[true/false]       show carriage return and line feeds in query results as escaped \r and \n 
   --headerInterval=ROWS;          the interval between which heades are displayed
   --fastConnect=[true/false]      skip building table/column list for tab-completion
   --autoCommit=[true/false]       enable/disable automatic transaction commit
   --verbose=[true/false]          show verbose error messages and debug info
   --showWarnings=[true/false]     display connection warnings
   --showDbInPrompt=[true/false]   display the current database name in the prompt
   --showNestedErrs=[true/false]   display nested errors
   --numberFormat=[pattern]        format numbers using DecimalFormat pattern
   --force=[true/false]            continue running script even after errors
   --maxWidth=MAXWIDTH             the maximum width of the terminal
   --maxColumnWidth=MAXCOLWIDTH    the maximum width to use when displaying columns
   --silent=[true/false]           be more silent
   --autosave=[true/false]         automatically save preferences
   --outputformat=[table/vertical/csv2/tsv2/dsv/csv/tsv]  format mode for result display
                                   Note that csv, and tsv are deprecated - use csv2, tsv2 instead
   --incremental=[true/false]      Defaults to false. When set to false, the entire result set
                                   is fetched and buffered before being displayed, yielding optimal
                                   display column sizing. When set to true, result rows are displayed
                                   immediately as they are fetched, yielding lower latency and
                                   memory usage at the price of extra display column padding.
                                   Setting --incremental=true is recommended if you encounter an OutOfMemory
                                   on the client side (due to the fetched result set size being large).
                                   Only applicable if --outputformat=table.
   --incrementalBufferRows=NUMROWS the number of rows to buffer when printing rows on stdout,
                                   defaults to 1000; only applicable if --incremental=true
                                   and --outputformat=table
   --truncateTable=[true/false]    truncate table column when it exceeds length
   --delimiterForDSV=DELIMITER     specify the delimiter for delimiter-separated values output format (default: |)
   --isolation=LEVEL               set the transaction isolation level
   --nullemptystring=[true/false]  set to true to get historic behavior of printing null as empty string
   --maxHistoryRows=MAXHISTORYROWS The maximum number of rows to store beeline history.
   --delimiter=DELIMITER           set the query delimiter; multi-char delimiters are allowed, but quotation
                                   marks, slashes, and -- are not allowed; defaults to ;
   --convertBinaryArrayToString=[true/false]    display binary column data as string or as byte array 
   --help                          display this message
 
   Example:
    1. Connect using simple authentication to HiveServer2 on localhost:10000
    $ beeline -u jdbc:hive2://localhost:10000 username password

    2. Connect using simple authentication to HiveServer2 on hs.local:10000 using -n for username and -p for password
    $ beeline -n username -p password -u jdbc:hive2://hs2.local:10012

    3. Connect using Kerberos authentication with hive/localhost@mydomain.com as HiveServer2 principal
    $ beeline -u "jdbc:hive2://hs2.local:10013/default;principal=hive/localhost@mydomain.com"

    4. Connect using SSL connection to HiveServer2 on localhost at 10000
    $ beeline "jdbc:hive2://localhost:10000/default;ssl=true;sslTrustStore=/usr/local/truststore;trustStorePassword=mytruststorepassword"

    5. Connect using LDAP authentication
    $ beeline -u jdbc:hive2://hs2.local:10013/default <ldap-username> <ldap-password>
 
Usage: java org.apache.hive.beeline.KyuubiBeeLine
   --python-mode                   Execute python code/script.

Implementation steps

• kyuubi-beeline is derived from Hive beeline, we have made some changes since forking, some reference to Hive is improper now and we should remove them
• replace jdbc:hive2// with jdbc:kyuubi//
• update and validate examples
• other changes

Additional context

Introduction of 2024H1 Kyuubi Code Contribution Program

[ShockleysxX]

take assign!

[pan3793]

@ShockleysxX thanks, assigned

[pan3793]

@ShockleysxX Do you have any progress on this task? An easy task typically costs a few hours to complete.

[pan3793]

Revoked as the assignor has no response

[liuxiaocs7]

Could I continue to do this task, may be in 3 days

[pan3793]

@liuxiaocs7 assigned, thanks

[dupen01]

Hi, I am also interested in this issue, and I have already made modifications about the help message of kyuubi-beeline locally. Here's how my implementation works. May I submit a PR for this?

$ ./bin/kyuubi-beeline --help
Usage: kyuubi-beeline <options>. 

Options:
   -u <database url>                 The JDBC URL to connect to.
   -c <named url>                    The named JDBC URL to connect to,
                                     which should be present in beeline-site.xml
                                     as the value of beeline.kyuubi.jdbc.url.<namedUrl>.

   -r                                Reconnect to last saved connect url (in conjunction with !save).
   -n <username>                     The username to connect as.
   -p <password>                     The password to connect as.
   -d <driver class>                 The driver class to use.
   -i <init file>                    Script file for initialization.
   -e <query>                        Query that should be executed.
   -f <exec file>                    Script file that should be executed.
   -w, --password-file <file>        The password file to read password from.
   --hiveconf property=value         Use value for given property.
   --hivevar name=value              Hive variable name and value.
                                     This is Hive specific settings in which variables
                                     can be set at session level and referenced in Hive
                                     commands or queries.

   --property-file=<property-file>   The file to read connection properties (url, driver, user, password) from.
   --color=[true|false]              Control whether color is used for display.
   --showHeader=[true|false]         Show column names in query results.
   --escapeCRLF=[true|false]         Show carriage return and line feeds in query results as escaped \r and \n. 
   --headerInterval=ROWS;            The interval between which heades are displayed.
   --fastConnect=[true|false]        Skip building table/column list for tab-completion.
   --autoCommit=[true|false]         Enable/disable automatic transaction commit.
   --verbose=[true|false]            Show verbose error messages and debug info.
   --showWarnings=[true|false]       Display connection warnings.
   --showDbInPrompt=[true|false]     Display the current database name in the prompt.
   --showNestedErrs=[true|false]     Display nested errors.
   --numberFormat=[pattern]          Format numbers using DecimalFormat pattern.
   --force=[true|false]              Continue running script even after errors.
   --maxWidth=MAXWIDTH               The maximum width of the terminal.
   --maxColumnWidth=MAXCOLWIDTH      The maximum width to use when displaying columns.
   --silent=[true|false]             Be more silent.
   --autosave=[true|false]           Automatically save preferences.
   --outputformat=<format mode>      Format mode for result display.
                                     The available options ars [table|vertical|csv2|tsv2|dsv|csv|tsv|json|jsonfile]. 
                                     Note that csv, and tsv are deprecated, use csv2, tsv2 instead.

   --incremental=[true|false]        Defaults to false. When set to false, the entire result set
                                     is fetched and buffered before being displayed, yielding optimal
                                     display column sizing. When set to true, result rows are displayed
                                     immediately as they are fetched, yielding lower latency and
                                     memory usage at the price of extra display column padding.
                                     Setting --incremental=true is recommended if you encounter an OutOfMemory
                                     on the client side (due to the fetched result set size being large).
                                     Only applicable if --outputformat=table.

   --incrementalBufferRows=NUMROWS   The number of rows to buffer when printing rows on stdout,
                                     defaults to 1000; only applicable if --incremental=true
                                     and --outputformat=table.

   --truncateTable=[true|false]      Truncate table column when it exceeds length.
   --delimiterForDSV=DELIMITER       Specify the delimiter for delimiter-separated values output format (default: |).
   --isolation=LEVEL                 Set the transaction isolation level.
   --nullemptystring=[true|false]    Set to true to get historic behavior of printing null as empty string.
   --maxHistoryRows=MAXHISTORYROWS   The maximum number of rows to store beeline history.
   --delimiter=DELIMITER             Set the query delimiter; multi-char delimiters are allowed, but quotation
                                     marks, slashes, and -- are not allowed; defaults to ;

   --convertBinaryArrayToString=[true|false]
                                     Display binary column data as string or as byte array.

   --python-mode                     Execute python code/script.
   --help                            Display this message.
 
   Example:
    1. Connect using simple authentication to KyuubiServer on localhost:10009
    $ kyuubi-beeline -u jdbc:kyuubi://localhost:10009 username password

    2. Connect using simple authentication to KyuubiServer on kyuubi.local:10009 using -n for username and -p for password
    $ kyuubi-beeline -n username -p password -u jdbc:kyuubi://kyuubi.local:10009

    3. Connect using Kerberos authentication with hive/localhost@mydomain.com as KyuubiServer principal
    $ kyuubi-beeline -u "jdbc:kyuubi://kyuubi.local:10009/default;principal=hive/localhost@mydomain.com"

    4. Connect using SSL connection to KyuubiServer on localhost at 10009
    $ kyuubi-beeline "jdbc:kyuubi://localhost:10009/default;ssl=true;sslTrustStore=/usr/local/truststore;trustStorePassword=mytruststorepassword"

    5. Connect using LDAP authentication
    $ kyuubi-beeline -u jdbc:kyuubi://kyuubi.local:10009/default <ldap-username> <ldap-password>

[pan3793]

@dupen01 thanks for your passion, let's wait for @liuxiaocs7's response for a while (one day)

[liuxiaocs7]

Hi, @dupen01, I've been working on my thesis for the past days resulting in not really starting it yet, so you can continue this task and look forward to your contribution! CC @pan3793

[pan3793]

good luck and thanks for response @liuxiaocs7, I re-assigned this task to @dupen01