Files
impala/shell/packaging
jasonmfehr f2f6b4b580 IMPALA-11375 Impala shell outputs details of each RPC
When the Impala shell is using the hs2 protocol, it makes multiple RPCs
to the Impala daemon.  These calls pass Thrift objects back and forth.
This change adds the '--show_rpc' which outputs the details of the RPCs
to stdout and the '--rpc_file' flag which outputs the RPC details to the
specified file path.

RPC details include:
- operation name
- request attempt count
- Impala session/query ids (if applicable)
- call duration
- call status (success/failure)
- request Thrift objects
- response Thrift objects

Certain information is not included in the RPC details:
- Thrift object attributes named 'secret' or 'password'
  are redacted.
- Thrift objects with a type of TRowSet or TGetRuntimeProfileResp
  are not include as the information contained within them is
  already available in the standard output from the Impala shell.

Testing:
- Added new tests in the end-to-end test suite.

Change-Id: I36f8dbc96726aa2a573133acbe8a558299381f8b
Reviewed-on: http://gerrit.cloudera.org:8080/19388
Reviewed-by: Impala Public Jenkins <impala-public-jenkins@cloudera.com>
Tested-by: Impala Public Jenkins <impala-public-jenkins@cloudera.com>
2023-01-12 23:31:14 +00:00
..

Impala Interactive Shell

You can use the Impala shell tool (impala-shell) to connect to an Impala service. The shell allows you to set up databases and tables, insert data, and issue queries. For ad hoc queries and exploration, you can submit SQL statements in an interactive session. The impala-shell interpreter accepts all the same SQL statements listed in Impala SQL Statements, plus some shell-only commands that you can use for tuning performance and diagnosing problems.

To automate your work, you can specify command-line options to process a single statement or a script file. (Other avenues for Impala automation via python are provided by Impyla or ODBC.)

Installing

$ pip install impala-shell

Online documentation

Quickstart

Non-interactive mode

Processing a single query, e.g., show tables:

$ impala-shell -i impalad-host.domain.com -d some_database -q 'show tables'

Processing a text file with a series of queries:

$ impala-shell -i impalad-host.domain.com -d some_database -f /path/to/queries.sql

Launching the interactive shell

To connect to an impalad host at the default service port (21000):

$ impala-shell -i impalad-host.domain.com
Starting Impala Shell without Kerberos authentication
Connected to impalad-host.domain.com:21000
Server version: impalad version 2.11.0-SNAPSHOT RELEASE (build d4596f9ca3ea32a8008cdc809a7ac9a3dea47962)
***********************************************************************************
Welcome to the Impala shell.
(Impala Shell v3.0.0-SNAPSHOT (73e90d2) built on Thu Mar  8 00:59:00 PST 2018)

The '-B' command line flag turns off pretty-printing for query results. Use this
flag to remove formatting from results you want to save for later, or to benchmark
Impala.
***********************************************************************************
[impalad-host.domain.com:21000] >

Launching the interactive shell (secure mode)

To connect to a secure host using kerberos and SSL:

$ impala-shell -k --ssl -i impalad-secure-host.domain.com

Disconnecting

To exit the shell when running interactively, press Ctrl-D at the shell prompt.