# Beeswax

The Beeswax application enables you to perform queries on Apache Hive, a data warehousing system designed to work with Hadoop. For information about Hive, see Hive Documentation. You can create Hive databases, tables and partitions, load data, create, run, and manage queries, and download the results in a Microsoft Office Excel worksheet file or a comma-separated values file.

Thanks to HiveServer2 integration, Hue is getting the benefits from Sentry (How to configure Sentry Video). In addition to the security provided, Hue’s interface becomes more consistent. For example, a user without permissions on a database or table won’t see it in the query editor or in the Metastore app.

HiveServer2 also provides performant access to the Metastore.

On top of this, the Beeswax Hive UI is a Web editor for increasing the productivity:

- Syntax highlighting and auto completion

- Submit several queries and check they progress later

- UDF integration

- Multiple queries execution

- Select and send a fraction of a query

- Download or save the query results

- Navigate through the metadata

## Hue 2.x

We recommend to use at least Hue 2.5. Have Hue point to HiveServer2 by updating the Beeswax section in the hue.ini:

    [beeswax]
      beeswax_server_host=<FQDN of Beeswax server>
      server_interface=hiveserver2
      beeswax_server_port=10000

## Hue 3.x

Hue 3 does not bundle Beeswaxd anymore, and is configured by default to use HiveServer2. If HiveServer2 is not on the same machine as Hue update hue.ini with:

    [beeswax]
     hive_server_host=<FQDN of HiveServer2>

Other Hive specific settings (e.g. security, impersonation) are read from a local /etc/hive/conf/hive-site.xml. We recommend to keep this one in exact sync with the original Hive one (or put Hue and Hive on the same machine).

Note:

If you are using Hive 0.12 or later, Hue needs to have HUE-1561 (or use Hue 3.0 or later).

##
With Sentry: Hue 2.x or 3.x

Hue will automatically work with a HiveServer2 configured with Sentry.

Notice that HiveServer2 impersonation (described below) should be turned off in case of Sentry. Permissions of the impersonated user (e.g. ‘bob’) will be used instead of the ones of the ‘hue’ user. Also we need the warehouse permissions to be owned by hive:hive with 770 so that only super users in hive group can read, write.

HiveServer2 needs to be using strong authentication like Kerberos/LDAP for Sentry to work.

# Troubleshooting without Sentry

    org.apache.hive.service.cli.HiveSQLException: Error while processing statement: FAILED: Execution Error, return code 1 from org.apache.hadoop.hive.ql.exec.DDLTask. MetaException(message:Got exception: org.apache.hadoop.security.AccessControlException Permission denied: user=hive, access=WRITE, inode="/user/test/data":test:supergroup:drwxr-xr-x

By default HiveServer2 now owns the Hive warehouse (default ‘/user/hive/warehouse’), meaning the data files need to belong to the ‘hive’ user. If you get this error when creating a table, change the permission of the data directory (here /user/test/data) to ‘write’ for everybody or revert HiveServer2 to the old Beeswax behavior by authorizing ‘hive’ to impersonate the user.

Adding ‘hive’ as a Hadoop proxy user and edit your hive-site.xml:

     <property>
       <name>hive.server2.enable.doAs</name>
       <value>true</value>
     </property>

Then restart HiveServer2:

    sudo service hive-server2 restart

Another common error when using YARN is:

    Cannot initialize Cluster. Please check your configuration for mapreduce.framework.name and the correspond server addresses.

It means that the HADOOP_MAPRED_HOME environment variable is not set to:

    export HADOOP_MAPRED_HOME=/usr/lib/hadoop-mapreduce

HADOOP_HOME could also be wrong.

    TTransportException('Could not start SASL: Error in sasl_client_start (-4) SASL(-4): no mechanism available: No worthy mechs found',)

Hue is missing a SASL lib in your system.

HiveServer2 supports 3 authentication modes specified by the ‘hive.server2.authentication’ in hive-site.xml:

- NOSASL

- NONE (default)

- KERBEROS

Only NOSASL does not require SASL, so you either switch to it or install the missing packages.

Hue will pick the value from its local /etc/hive/conf/hive-site.xml so make sure it is synced with the original hive-site.xml (manually or via CM Beeswax safety valve).

    Error while compiling statement: FAILED: RuntimeException org.apache.hadoop.security.AccessControlException: Permission denied: user=admin, access=WRITE, inode="/tmp/hive-hive":hive:hdfs:drwxr-xr-x at org.apache.hadoop.hdfs.server.namenode.FSPermissionChecker.check(FSPermissionChecker.java:234) at org.apache.hadoop.hdfs.server.namenode.FSPermissionChecker.check(FSPermissionChecker.java:214) at org.apache.hadoop.hdfs.server.namenode.FSPermissionChecker.checkPermission(FSPermissionChecker.java:158)

The Hive HDFS workspace ‘/tmp/hive-hive’ would need to be set to 1777 permissions.

# Troubleshooting with Sentry

    AuthorizationException: User 'hue/test.com' does not have privileges to execute 'CREATE' on: default.sample_08"

The user ‘hue’ is not configured in Sentry and have not the CREATE table permission.

## Beeswax and Hive Installation and Configuration

Beeswax is installed and configured as part of Hue. For information about installing and configuring Hue, see Hue Installation in http://www.cloudera.com/content/cloudera-content/cloudera-docs/CDH4/latest/CDH4-Installation-Guide/CDH4-Installation-Guide.html.

Beeswax assumes an existing Hive installation. The Hue installation instructions include the configuration necessary for Beeswax to access Hive. You can view the current Hive configuration from the Settings tab in the Beeswax application.

By default, a Beeswax user can see the saved queries for all users – both his/her own queries and those of other Beeswax users. To restrict viewing saved queries to the query owner and Hue administrators, set the `share_saved_queries` property under the `[beeswax]` section in the Hue configuration file to `false`.

## Starting Beeswax

Click the Beeswax icon () in the navigation bar at the top of the Hue browser page.

## Managing Databases, Tables, and Partitions

You can create databases, tables, partitions, and load data by executing Hive data manipulation statements in the Beeswax application.

You can also use the Metastore Manager application to manage the databases, tables, and partitions and load data.

## Installing Example Queries and Tables

Note: You must be a superuser to perform this task.

1. Click . The Quick Start Wizard opens.
2. Click Step 2: Examples.
3. Click Beeswax (Hive UI).

## Query Editor

The Query Editor view lets you create, save, and submit queries in the Hive Query Language (HQL), which is similar to Structured Query Language (SQL). When you submit a query, the Beeswax Server uses Hive to run the queries. You can either wait for the query to complete, or return later to find the queries in the History view. You can also request to receive an email message after the query is completed.

In the box to the left of the Query field, you can select a database, override the default Hive and Hadoop settings, specify file resources and user-defined functions, enable users to enter parameters at run-time, and request email notification when the job is complete. See Advanced Query Settings for details on using these settings.

### Creating Queries

1. In the Query Editor window, type a query or multiple queries separated by a semicolon ";". To be presented with a drop-down of autocomplete options, type CTRL+spacebar when entering a query.
2. To save your query and advanced settings to use again later, click Save As, enter a name and description, and then click OK. To save changes to an existing query, click Save.
3. If you want to view the execution plan for the query, click Explain. For more information, see http://wiki.apache.org/hadoop/Hive/LanguageManual/Explain.

### Loading Queries into the Query Editor

1. Do one of the following:
   - Click the My Queries tab.
     1. Click the Recent Saved Queries or Recent Run Queries tab to display the respective queries.
   - Click the Saved Queries tab.
2. Click a query name. The query is loaded into the Query Editor.

### Running Queries

Note: To run a query, you must be logged in to Hue as a user that also has a Unix user account on the remote server.

1. To execute a portion of the query, highlight one or more query statements.
2. Click Execute. The Query Results window appears with the results of your query.
   - To view a log of the query execution, click Log at the top of the results display. You can use the information in this tab to debug your query.
   - To view the query that generated these results, click Query at the top of the results display.
   - To view the columns of the query, click Columns.
   - To return to the query in the Query Editor, click Unsaved Query.
3. If there are multiple statements in the query, click Next in the Multi-statement query pane to execute the remaining statements.

Note: Under MR JOBS, you can view any MapReduce jobs that the query generated.

### Downloading and Saving Query Results

Important:

- You can only save results to a file when the results were generated by a MapReduce job.
- This is the preferred way to save when the result is large (for example > 1M rows).

1. Do any of the following to download or save the query results:
   - Click Download as CSV to download the results in a comma-separated values file suitable for use in other applications.
   - Click Download as XLS to download the results in a Microsoft Office Excel worksheet file.
   - Click Save to save the results in a table or HDFS file.
     - To save the results in a new table, select In a new table, enter a table name, and then click Save.
     - To save the results in an HDFS file, select In an HDFS directory, enter a path and then click Save. You can then download the file with File Browser.

### Advanced Query Settings

The pane to the left of the Query Editor lets you specify the following options:

Option | Description
--- | ---
DATABASE | The database containing the table definitions.
SETTINGS | Override the Hive and Hadoop default settings. To configure a new setting: Click Add. For Key, enter a Hive or Hadoop configuration variable name. For Value, enter the value you want to use for the variable. For example, to override the directory where structured Hive query logs are created, you would enter `hive.querylog.location` for Key, and a path for Value. To view the default settings, click the Settings tab at the top of the page. For information about Hive configuration variables, see: http://wiki.apache.org/hadoop/Hive/AdminManual/Configuration. For information about Hadoop configuration variables, see: http://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/mapred-default.xml.
FILE RESOURCES | Make files locally accessible at query execution time available on the Hadoop cluster. Hive uses the Hadoop Distributed Cache to distribute the added files to all machines in the cluster at query execution time. Click Add to configure a new setting. From the Type drop-down menu, choose one of the following: jar — Adds the specified resources to the Java classpath. archive — Unarchives the specified resources when distributing them. file — Adds the specified resources to the distributed cache. Typically, this might be a transform script (or similar) to be executed. For Path, enter the path to the file or click to browse and select the file. Note: It is not necessary to specify files used in a transform script if the files are available in the same path on all machines in the Hadoop cluster.
USER-DEFINED FUNCTIONS | Specify user-defined functions. Click Add to configure a new setting. Specify the function name in the Name field, and specify the class name for Class name. You must specify a JAR file for the user-defined functions in FILE RESOURCES. To include a user-defined function in a query, add a $ (dollar sign) before the function name in the query. For example, if MyTable is a user-defined function name in the query, you would type: `SELECT * $``MyTable`
PARAMETERIZATION | Indicate that a dialog box should display to enter parameter values when a query containing the string $parametername is executed. Enabled by default.
EMAIL NOTIFICATION | Indicate that an email message should be sent after a query completes. The email is sent to the email address specified in the logged-in user's profile.

### Viewing Query History

You can view the history of queries that you have run previously. Results for these queries are available for one week or until Hue is restarted.

1. Click History. A list of your saved and unsaved queries displays in the Query History window.
2. To display the queries for all users, click Show everyone's queries. To display your queries only, click Show my queries.
3. To display the automatically generated actions performed on a user's behalf, click Show auto actions. To display user queries again, click Show user queries.

### Viewing, Editing, Copying, and Deleting Saved Queries

You can view a list of saved queries of all users by clicking My Queries and then selecting either Recent Saved Queries or Recent Run Queries tab to display the respective queries or clicking Saved Queries. You can copy any query, but you can edit, delete, and view the history of only your own queries.

Saved Query | Procedure
--- | ---
Edit | Click Saved Queries. The Queries window displays. Check the checkbox next to the query and click Edit. The query displays in the Query Editor window. Change the query and then click Save. You can also click Save As, enter a new name, and click OK to save a copy of the query.
Copy | Click Saved Queries. The Queries window displays. Check the checkbox next to the query and click Copy. The query displays in the Query Editor window. Change the query as necessary and then click Save. You can also click Save As, enter a new name, and click OK to save a copy of the query.
Copy in Query History | Click History. The Query History window displays. To display the queries for all users, click Show everyone's queries. The queries for all users display in the History window. Click the query you want to copy. A copy of the query displays in the Query Editor window. Change the query, if necessary, and then click Save As, enter a new name, and click OK to save the query.
Delete | Click Saved Queries. The Queries window displays. Check the checkbox next to the query and click Delete. Click Yes to confirm the deletion.