Arcadia Shell (ArcShell)
Arcadia Shell provides command-line access to the ArcEngine.
Note that arcengined
is the name of the daemon process that runs on the
server.
Location
The access to the Arcadia Shell depends on the installation environment that runs Arcadia Enterprise:
-
Parcels Install on Cloudera Manager
/opt/cloudera/parcels/ARCADIAENTERPRISE/lib/arcengine/shell/arcadia-shell
-
Stacks Install on Ambari Hortonworks
/opt/arcadia/lib/arcengine/shell/arcadia-shell
-
Red Hat Package Manager (RPM) Installation
/opt/arcadia/arcengine/shell/arcadia-shell
-
mapR Installation
/opt/arcadia/lib/arcengine/shell/arcadia-shell
Connection
By default, Arcadia Shell connects to
localhost
:31100
.
You have several options for override this default:
- Overriding the connection string
Use the option arcengined
to override the entire connection string:
--arcengined=host:port
- Overriding the port
Use the option arcengined_port
to override only the port of the connection string:
--arcengined_port=port_number
ArcShell Syntax
Arcadia shell has very simple invocation protocol (see the list of Options):
./arcadia-shell options
To see the startup options at any time, type the following at the command
prompt:
./arcadia-shell --help
Options
- -h, --help
- Show this help message and exit.
- -a ARCENGINED, -i ARCENGINED, --arcengined=ARCENGINED
-
Specify host
:
port
to
connect to for arcengined
, the daemon that runs on the arcengine
service.
Default: localhost
- -q QUERY, --query=QUERY
- Execute a query without the shell.
- Default: none
- -f QUERY_FILE, --query_file=QUERY_FILE
- Execute the queries in the query file, delimited by
;
.
- Default: none
- -k, --kerberos
- Connect to a kerberized Arcengined
- Default:
False
- -o OUTPUT_FILE, --output_file=OUTPUT_FILE
-
If set, writes query results to the specified file. Results from multiple
semicolon-terminated queries are appended to the same file.
Default: none
- -B, --delimited
- Output rows in delimited mode.
- Default:
False
- --print_header
-
Print column names in delimited mode when pretty-printed.
Default: False
- --output_delimiter=OUTPUT_DELIMITER
-
Field delimiter for output in delimited mode.
Default: \t
- -s KERBEROS_SERVICE_NAME, --kerberos_service_name=KERBEROS_SERVICE_NAME
-
Service name of a kerberized arcengined
.
Default: arcadia
- -V, --verbose
- Verbose output.
- Default:
True
- -p, --show_profiles
-
Always display query profiles after execution.
Default: False
- --quiet
- Disable verbose output.
- Default:
False
- -v, --version
- Print version information.
- Default:
False
- -c, --ignore_query_failure
- Continue on query failure.
- Default:
False
- -r, --refresh_after_connect
-
Refresh Arcadia catalog after connecting.
Default: False
- -d DEFAULT_DB, --database=DEFAULT_DB
-
Issues a use database command on startup.
Default: none
- -l, --ldap
-
Use LDAP to authenticate with Arcadia. Arcadia must be configured to allow LDAP
authentication.
Default: False
- -u USER, --user=USER
- User to authenticate with.
- Default:
vagrant
- --ssl
-
Connect to Arcadia through SSL-secured connection.
Default: False
- --ca_cert=CA_CERT
- Full path to certificate file used to authenticate Arcadia's SSL certificate. May
either be a copy of Arcadia's certificate (for self-signed certificates) or the
certificate of a trusted third-party CA. If not set, but SSL is enabled, the shell DOES
NOT verify Arcadia's server certificate.
- Default: none
- --config_file=CONFIG_FILE
-
Specify the configuration file to load options. File must have case-sensitive
'arcadia' header. Specifying this option within a config file has no effect.
Only specify this as a option on the command line.
Default: /home/vagrant/.arcadiarc
- --live_summary
- Print a query summary every 1 second while the query is running.
- Default:
False
- --live_progress
- Print a query's progress every 1s while the query is running.
- Default:
False
- --auth_creds_ok_in_clear
- If set, LDAP authentication may be used with an insecure connection to Impala.
- WARNING: Authentication credentials are therefore sent unencrypted, and may be
vulnerable to attack.
- Default: none
- --ldap_password_cmd=LDAP_PASSWORD_CMD
- Shell command ran to retrieve the LDAP password.
- Default: none
- --var=KEYVAL
- Define variable(s) to use within the Arcadia session.
- Default: none
- --arcengined_port=ARCENGINED_PORT
- Port number of
arcengined
to connect to.
- Default:
31100