|
|
@@ -1,70 +1,120 @@
|
|
|
-[](https://circleci.com/gh/cloudera/hue/tree/master)
|
|
|
-[](https://registry.hub.docker.com/u/gethue/hue/)
|
|
|
-
|
|
|
+<div align="center">
|
|
|
+
|
|
|
+# Hue - SQL Assistant for Databases and Data Warehouses
|
|
|
|
|
|

|
|
|
|
|
|
+
|
|
|
+[](https://registry.hub.docker.com/u/gethue/hue/)
|
|
|
+[](https://github.com/cloudera/hue/graphs/contributors)
|
|
|
+[](https://github.com/cloudera/hue/stargazers)
|
|
|
+[](LICENSE.txt)
|
|
|
+
|
|
|
+[](https://deepwiki.com/cloudera/hue)
|
|
|
+
|
|
|
+**Query. Explore. Share.**
|
|
|
+
|
|
|
+</div>
|
|
|
|
|
|
-# Query. Explore. Share.
|
|
|
+## 🗄️ Overview
|
|
|
|
|
|
-Hue is a mature SQL Assistant for querying Databases & Data Warehouses.
|
|
|
+Hue is a mature SQL Assistant for querying Databases & Data Warehouses, trusted by:
|
|
|
|
|
|
-* 1000+ customers
|
|
|
-* Top Fortune 500
|
|
|
+* **1000+ customers** worldwide
|
|
|
+* **Top Fortune 500** enterprises
|
|
|
|
|
|
-use Hue to quickly answer questions via self-service querying and are executing 100s of 1000s of queries daily.
|
|
|
+Organizations use Hue to quickly answer questions via self-service querying, executing hundreds of thousands of queries daily.
|
|
|
|
|
|
-Read more on [gethue.com](http://gethue.com) and
|
|
|
-- Connect to a [database](https://docs.gethue.com/administrator/configuration/connectors/)
|
|
|
-- Build your own Editor with the [SQL Scratchpad](https://docs.gethue.com/developer/components/scratchpad/)
|
|
|
-- Boot the [Query Service](https://docs.gethue.com/administrator/installation/cloud/#kubernetes) and query via the UI/[API](https://docs.gethue.com/developer/api/)
|
|
|
+### 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
|
|
|
+
|
|
|
+- 🏠 **Website**: [gethue.com](https://gethue.com)
|
|
|
+- 🔌 **Connect to a database**: [Configuration Guide](https://docs.gethue.com/administrator/configuration/connectors/)
|
|
|
+- 🛠️ **Build your own Editor**: [SQL Scratchpad](https://docs.gethue.com/developer/components/scratchpad/)
|
|
|
+- ⚙️ **Query Service**: [Kubernetes Setup](https://docs.gethue.com/administrator/installation/cloud/#kubernetes) and [API](https://docs.gethue.com/developer/api/)
|
|
|
|
|
|

|
|
|
|
|
|
-# Getting Started
|
|
|
+## 🚀 Getting Started
|
|
|
+
|
|
|
+### Try Hue Now
|
|
|
+
|
|
|
+- 🌐 **Live demo**: [demo.gethue.com](https://demo.gethue.com/)
|
|
|
+- 🧪 **Quick integrations**:
|
|
|
+ - [Hive](https://docs.gethue.com/administrator/configuration/connectors/#apache-hive)
|
|
|
+ - [Impala](https://gethue.com/blog/quickstart-sql-editor-for-apache-impala/)
|
|
|
+ - [Trino/Presto](https://docs.gethue.com/administrator/configuration/connectors/#trino-presto)
|
|
|
+ - [Phoenix SQL / HBase](https://gethue.com/blog/querying-live-kafka-data-in-apache-hbase-with-phoenix/)
|
|
|
+ - [Spark SQL](https://gethue.com/blog/querying-spark-sql-with-spark-thrift-server-and-hue-editor/)
|
|
|
+
|
|
|
+Choose one of these deployment options to start the server, then [configure the databases](https://docs.gethue.com/administrator/configuration/connectors/) you want to query:
|
|
|
+
|
|
|
+### 🐳 Docker
|
|
|
+
|
|
|
+Start Hue instantly:
|
|
|
+
|
|
|
+```bash
|
|
|
+docker run -it -p 8888:8888 gethue/hue:latest
|
|
|
+```
|
|
|
+
|
|
|
+Hue will be available at [http://localhost:8888](http://localhost:8888)
|
|
|
+
|
|
|
+📖 See the [Docker Guide](https://github.com/cloudera/hue/tree/master/tools/docker/hue) or watch the [Quick Start Video](http://gethue.com/getting-started-with-hue-in-2-minutes-with-docker/)
|
|
|
+
|
|
|
+### ☸️ Kubernetes
|
|
|
|
|
|
-Quick Demos:
|
|
|
+```bash
|
|
|
+helm repo add gethue https://helm.gethue.com
|
|
|
+helm repo update
|
|
|
+helm install hue gethue/hue
|
|
|
+```
|
|
|
|
|
|
-* Docker Compose: [Impala](https://gethue.com/blog/quickstart-sql-editor-for-apache-impala/), [Flink SQL](https://gethue.com/blog/sql-querying-live-kafka-logs-and-sending-live-updates-with-flink-sql/), [ksqlDB](https://gethue.com/blog/tutorial-query-live-data-stream-with-kafka-sql/), [Phoenix SQL / HBase](https://gethue.com/blog/querying-live-kafka-data-in-apache-hbase-with-phoenix/), [Spark SQL](https://gethue.com/blog/querying-spark-sql-with-spark-thrift-server-and-hue-editor/)
|
|
|
-* Live instance: [demo.gethue.com](https://demo.gethue.com/)
|
|
|
+📖 Read more about configurations in the [Kubernetes docs](tools/kubernetes/)
|
|
|
|
|
|
-Three ways to start the server then configure the [databases](https://docs.gethue.com/administrator/configuration/connectors/) you want to query:
|
|
|
+### 💻 Development Setup
|
|
|
|
|
|
-## Docker
|
|
|
-Start Hue in a single click with the [Docker Guide](https://github.com/cloudera/hue/tree/master/tools/docker/hue) or the
|
|
|
-[video blog post](http://gethue.com/getting-started-with-hue-in-2-minutes-with-docker/).
|
|
|
+#### Quick Start with Docker
|
|
|
|
|
|
- docker run -it -p 8888:8888 gethue/hue:latest
|
|
|
+Use the [Dev Environment Docker](https://docs.gethue.com/developer/development/#dev-docker) for the fastest setup.
|
|
|
|
|
|
-Now Hue should be up and running on your default Docker IP on [http://localhost:8888](http://localhost:8888)!
|
|
|
+#### Manual Setup
|
|
|
|
|
|
-## Kubernetes
|
|
|
+1. Install [dependencies](https://docs.gethue.com/administrator/installation/dependencies/)
|
|
|
+2. Clone and build:
|
|
|
|
|
|
- helm repo add gethue https://helm.gethue.com
|
|
|
- helm repo update
|
|
|
- helm install hue gethue/hue
|
|
|
+```bash
|
|
|
+git clone https://github.com/cloudera/hue.git
|
|
|
+cd hue
|
|
|
+make apps
|
|
|
+build/env/bin/hue runserver
|
|
|
+```
|
|
|
|
|
|
-Read more about configurations at [tools/kubernetes](tools/kubernetes/).
|
|
|
+Hue will be available at [http://localhost:8000](http://localhost:8000)
|
|
|
|
|
|
-## Development
|
|
|
+📖 Read more in the [development documentation](https://docs.gethue.com/developer/development/)
|
|
|
|
|
|
-For a very Quick Start go with the [Dev Environment Docker](https://docs.gethue.com/developer/development/#dev-docker).
|
|
|
+## 🧩 Components
|
|
|
|
|
|
-Or install the [dependencies](https://docs.gethue.com/administrator/installation/dependencies/), clone the repository, build and get the server running.
|
|
|
+Hue offers several powerful components:
|
|
|
|
|
|
- # <install OS dependencies>
|
|
|
- git clone https://github.com/cloudera/hue.git
|
|
|
- cd hue
|
|
|
- make apps
|
|
|
- build/env/bin/hue runserver
|
|
|
+- **SQL Editor** - Interactive query interface
|
|
|
+- **SQL Parsers** - Syntax handling for multiple dialects
|
|
|
+- **REST/Python/CLI APIs** - Programmatic access to all functionality
|
|
|
|
|
|
-Now Hue should be running on [http://localhost:8000](http://localhost:8000)!
|
|
|
+📖 Learn about [components](https://docs.gethue.com/developer/components/) and [APIs](https://docs.gethue.com/developer/api/)
|
|
|
|
|
|
-Read more in the [documentation](https://docs.gethue.com/developer/development/).
|
|
|
+## 🤝 Contributing
|
|
|
|
|
|
-# Components
|
|
|
+We welcome contributions! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) guide to get started.
|
|
|
|
|
|
-SQL Editor, Parsers [components](https://docs.gethue.com/developer/components/) and REST/Python/CLI [APIs](https://docs.gethue.com/developer/api/).
|
|
|
+## 📜 License
|
|
|
|
|
|
-# License
|
|
|
-[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
|
|
|
+[Apache License, Version 2.0](LICENSE.txt)
|