README.md 5.0 KB

# Hue - SQL Assistant for Databases and Data Warehouses ![Hue Logo](https://raw.githubusercontent.com/cloudera/hue/master/docs/images/hue_logo.png) ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/cloudera/hue/commitflow-py3.yml?style=for-the-badge&logo=githubactions) [![Docker Pulls](https://img.shields.io/docker/pulls/gethue/hue?style=for-the-badge&logo=docker&color=blue)](https://registry.hub.docker.com/u/gethue/hue/) [![GitHub contributors](https://img.shields.io/github/contributors-anon/cloudera/hue?style=for-the-badge&logo=github)](https://github.com/cloudera/hue/graphs/contributors) [![GitHub stars](https://img.shields.io/github/stars/cloudera/hue?style=for-the-badge&logo=github&color=yellow)](https://github.com/cloudera/hue/stargazers) [![License](https://img.shields.io/badge/License-Apache%202.0-blue?style=for-the-badge&logo=opensourceinitiative)](LICENSE.txt) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/cloudera/hue) **Query. Explore. Share.**

🗄️ Overview

Hue is a mature SQL Assistant for querying Databases & Data Warehouses, trusted by:

  • 1000+ customers worldwide
  • Top Fortune 500 enterprises

Organizations use Hue to quickly answer questions via self-service querying, executing hundreds of thousands of queries daily.

Key Features

  • ✏️ Interactive SQL editing with syntax highlighting and autocomplete
  • 📁 File Browser for navigating and operating on HDFS, S3, ABFS, Ozone, and Google Storage (GS) files
  • 📊 Job Browser for monitoring and managing Hive queries, Impala queries, YARN applications, and Livy Spark jobs
  • 🗃️ Table Browser for exploring and managing database tables, schemas, and metadata
  • 📤 Table Importer for creating Hive and Impala tables from CSV/Excel files, with support for uploading from local system or importing from remote filesystems (HDFS, S3, ABFS, Ozone, GS)
  • 🔗 Multiple database connectors including Hive, Impala, MySQL, PostgreSQL, and more

🔗 Useful Links

Hue Editor

🚀 Getting Started

Try Hue Now

Choose one of these deployment options to start the server, then configure the databases you want to query:

🐳 Docker

Start Hue instantly:

docker run -it -p 8888:8888 gethue/hue:latest

Hue will be available at http://localhost:8888

📖 See the Docker Guide or watch the Quick Start Video

☸️ Kubernetes

helm repo add gethue https://helm.gethue.com
helm repo update
helm install hue gethue/hue

📖 Read more about configurations in the Kubernetes docs

💻 Development Setup

Quick Start with Docker

Use the Dev Environment Docker for the fastest setup.

Manual Setup

  1. Install dependencies
  2. Clone and build:

    git clone https://github.com/cloudera/hue.git
    cd hue
    make apps
    build/env/bin/hue runserver
    

Hue will be available at http://localhost:8000

📖 Read more in the development documentation

🧩 Components

Hue offers several powerful components:

  • SQL Editor - Interactive query interface
  • SQL Parsers - Syntax handling for multiple dialects
  • REST/Python/CLI APIs - Programmatic access to all functionality

📖 Learn about components and APIs

🤝 Contributing

We welcome contributions! Please see our CONTRIBUTING.md guide to get started.

📜 License

Apache License, Version 2.0