dupen01 opened a new pull request, #6300:
URL: https://github.com/apache/kyuubi/pull/6300
# :mag: Description
## Issue References ๐
<!-- Append the issue number after #. If there is no issue for you to link
create one or -->
<!-- If there are no issues to link, please provide details here. -->
This pull request fixes #6251
## Describe Your Solution ๐ง
As `kyuubi-beeline` is derived from Hive `beeline`, I haven't made extensive
modifications to its help message, only adjusting some formatting to enhance
its appearance. Below are the specific changes:
1. Replace `jdbc:hive2//` with `jdbc:kyuubi//`.
2. Replace `beeline` with `kyuubi-beeline`.
3. Capitalize the first letter.
4. If the comment for a parameter spans multiple lines, add an additional
`\n` at the end of the comment to separate it from the following line.
5. Append the help information for `--python-mode` to the front of `--help`.
6. Other changes within the example.
Here is the whole help message:
```
$ ./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/[email protected] as KyuubiServer principal
$ kyuubi-beeline -u
"jdbc:kyuubi://kyuubi.local:10009/default;principal=hive/[email protected]"
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>
```
If you have any suggested revisions, I will promptly respond and make the
necessary adjustments.
## Types of changes :bookmark:
<!--- What types of changes does your code introduce? Put an `x` in all the
boxes that apply: -->
- [x] Bugfix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
## Test Plan ๐งช
#### Behavior Without This Pull Request :coffin:
#### Behavior With This Pull Request :tada:
#### Related Unit Tests
---
# Checklist ๐
<!--- Go over all the following points, and put an `x` in all the boxes that
apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here
to help! -->
- [ ] This patch was not authored or co-authored using [Generative
Tooling](https://www.apache.org/legal/generative-tooling.html)
**Be nice. Be informative.**
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
