Go to file
Alexander Rashed 996cdccc09
[KYUUBI #6567] Fix compatibility of pyhive with setuptools==72.0.0
# 🔍 Description
## Issue References 🔗
This pull request fixes #6567

## Describe Your Solution 🔧
With `setuptools==72.0.0`, the `test` command was removed after being deprecated for a long time.
This completely breaks the installation of any packages using the `test` command, including PyHive.
This PR fixes PyHive to be compatible with `setuptools` 72+ again.
It seems that `setup.py test` wasn't used anywhere at all, which is why I just removed it.

## Types of changes 🔖
- [x] Bugfix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Test Plan 🧪

#### Behavior Without This Pull Request ⚰️
```
$ pip install -e .
Obtaining file:///home/localstack/Repos/kyuubi/python
  Preparing metadata (setup.py) ... error
  error: subprocess-exited-with-error

  × python setup.py egg_info did not run successfully.
  │ exit code: 1
  ╰─> [6 lines of output]
      Traceback (most recent call last):
        File "<string>", line 2, in <module>
        File "<pip-setuptools-caller>", line 34, in <module>
        File "/home/localstack/Repos/kyuubi/python/setup.py", line 4, in <module>
          from setuptools.command.test import test as TestCommand
      ModuleNotFoundError: No module named 'setuptools.command.test'
      [end of output]

  note: This error originates from a subprocess, and is likely not a problem with pip.
error: metadata-generation-failed

× Encountered error while generating package metadata.
╰─> See above for output.

note: This is an issue with the package mentioned above, not pip.
hint: See above for details
```

#### Behavior With This Pull Request 🎉
```
$ pip install --upgrade setuptools
Requirement already satisfied: setuptools in .../.pyenv/versions/3.11.5/lib/python3.11/site-packages (72.0.0)
$ pip install -e .
Obtaining file:///home/.../repos/kyuubi/python
  Preparing metadata (setup.py) ... done
Collecting future (from PyHive==0.7.0)
  Obtaining dependency information for future from ae30dadffc/future-1.0.0-py3-none-any.whl.metadata
  Using cached future-1.0.0-py3-none-any.whl.metadata (4.0 kB)
Requirement already satisfied: python-dateutil in /home/.../.pyenv/versions/3.11.5/lib/python3.11/site-packages (from PyHive==0.7.0) (2.8.2)
Requirement already satisfied: six>=1.5 in /home/.../.pyenv/versions/3.11.5/lib/python3.11/site-packages (from python-dateutil->PyHive==0.7.0) (1.16.0)
Using cached future-1.0.0-py3-none-any.whl (491 kB)
Installing collected packages: future, PyHive
  Running setup.py develop for PyHive
Successfully installed PyHive-0.7.0 future-1.0.0

[notice] A new release of pip is available: 23.2.1 -> 24.1.2
[notice] To update, run: pip install --upgrade pip
```

#### Related Unit Tests
None

---

# Checklist 📝

- [x] This patch was not authored or co-authored using [Generative Tooling](https://www.apache.org/legal/generative-tooling.html)

**Be nice. Be informative.**

Closes #6568 from alexrashed/fix-pyhive-setuptools-72.

Closes #6567

acfb80903 [Alexander Rashed] remove usage of setuptools.command.test

Authored-by: Alexander Rashed <alexander.rashed@localstack.cloud>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2024-07-29 23:56:52 +08:00
.github [KYUUBI #6545] Deprecate and remove building support for Spark 3.2 2024-07-22 11:59:34 +08:00
.idea
bin [KYUUBI #6523] Support configuration with --conf options 2024-07-18 11:33:17 +08:00
build [KYUUBI #6559] Various improvments for release scripts 2024-07-23 21:15:52 +08:00
charts/kyuubi [KYUUBI #6550] Delete updateStrategy.rollingUpdate.maxUnavailable because it is alpha feature 2024-07-23 11:30:20 +08:00
conf [KYUUBI #6268] Specify logDir for RollingFile filePattern 2024-04-09 17:27:56 +08:00
dev [KYUUBI #6545] Deprecate and remove building support for Spark 3.2 2024-07-22 11:59:34 +08:00
docker [KYUUBI #6558] Bump Iceberg 1.6.0 2024-07-25 22:37:21 +08:00
docs [KYUUBI #6566] Fix typos in KyuubiConf 2024-07-29 20:42:37 +08:00
extensions [KYUUBI #6541] [AUTHZ] Fix DataSourceV2RelationTableExtractor can't get the 'database' attribute if it's a Paimon plan. 2024-07-28 23:25:04 +08:00
externals [KYUUBI #6545] Deprecate and remove building support for Spark 3.2 2024-07-22 11:59:34 +08:00
integration-tests [KYUUBI #6499] Rewrite some utility methods in Java 2024-06-25 09:59:03 +08:00
kyuubi-assembly [RELEASE] Bump 1.10.0-SNAPSHOT 2024-03-13 14:24:49 +08:00
kyuubi-common [KYUUBI #6566] Fix typos in KyuubiConf 2024-07-29 20:42:37 +08:00
kyuubi-ctl [KYUUBI #6216] Support to deny some client ips to make connection 2024-04-07 16:32:00 +08:00
kyuubi-events [KYUUBI #6290] Add custom exception serialization for SparkOperationEvent 2024-04-11 19:29:41 +08:00
kyuubi-ha [KYUUBI #4847][FOLLOWUP] Exclude the alive probe sessions in terminating checker 2024-05-09 08:48:21 -07:00
kyuubi-hive-beeline Revert "[KYUUBI #6526] Kyuubi BeeLine wrongly process JDBC URL that contains --" 2024-07-08 16:39:11 +08:00
kyuubi-hive-jdbc [KYUUBI #6396][FOLLOWUP] Avoid NPE 2024-05-27 06:31:39 +00:00
kyuubi-hive-jdbc-shaded [KYUUBI #6391] Bump Arrow from 15.0.2 to 16.0.0 2024-05-20 19:26:15 +08:00
kyuubi-metrics [KYUUBI #6392] Support javax.servlet and jakarta.servlet co-exist 2024-05-20 21:09:30 +08:00
kyuubi-rest-client [KYUUBI #6008] RESTful API supports killing engine forcibly 2024-07-01 15:28:09 +08:00
kyuubi-server [KYUUBI #6542] KyuubiBatchService should wait for HTTP server started before picking jobs 2024-07-18 11:39:58 +08:00
kyuubi-util [KYUUBI #6499] Rewrite some utility methods in Java 2024-06-25 09:59:03 +08:00
kyuubi-util-scala [RELEASE] Bump 1.10.0-SNAPSHOT 2024-03-13 14:24:49 +08:00
kyuubi-zookeeper [KYUUBI #6499] Rewrite some utility methods in Java 2024-06-25 09:59:03 +08:00
licenses
licenses-binary [KYUUBI #6392] Support javax.servlet and jakarta.servlet co-exist 2024-05-20 21:09:30 +08:00
python [KYUUBI #6567] Fix compatibility of pyhive with setuptools==72.0.0 2024-07-29 23:56:52 +08:00
.asf.yaml
.dockerignore
.gitattributes
.gitignore [KYUUBI #6416] Generate flattened POM 2024-05-24 18:20:25 +08:00
.rat-excludes [KYUUBI #5686][FOLLOWUP] Rename pyhive to python 2024-04-09 20:30:02 +08:00
.readthedocs.yaml
.scalafmt.conf
codecov.yml
CONTRIBUTING.md [KYUUBI #6068] Remove community section from user docs 2024-02-21 05:20:42 +00:00
LICENSE
LICENSE-binary [KYUUBI #6458] Remove commons-logging from binary release 2024-06-11 11:32:30 +08:00
NOTICE [KYUUBI #6434] Add footnote about pyhive origin 2024-06-24 10:30:51 +08:00
NOTICE-binary [KYUUBI #6458] Remove commons-logging from binary release 2024-06-11 11:32:30 +08:00
pom.xml [KYUUBI #6558] Bump Iceberg 1.6.0 2024-07-25 22:37:21 +08:00
README.md
scalastyle-config.xml

Kyuubi logo

Project - Documentation - Who's using

Apache Kyuubi

Apache Kyuubi™ is a distributed and multi-tenant gateway to provide serverless SQL on data warehouses and lakehouses.

What is Kyuubi?

Kyuubi provides a pure SQL gateway through Thrift JDBC/ODBC interface for end-users to manipulate large-scale data with pre-programmed and extensible Spark SQL engines. This "out-of-the-box" model minimizes the barriers and costs for end-users to use Spark at the client side. At the server-side, Kyuubi server and engines' multi-tenant architecture provides the administrators a way to achieve computing resource isolation, data security, high availability, high client concurrency, etc.

  • A HiveServer2-like API
  • Multi-tenant Spark Support
  • Running Spark in a serverless way

Target Users

Kyuubi's goal is to make it easy and efficient for anyone to use Spark(maybe other engines soon) and facilitate users to handle big data like ordinary data. Here, anyone means that users do not need to have a Spark technical background but a human language, SQL only. Sometimes, SQL skills are unnecessary when integrating Kyuubi with Apache Superset, which supports rich visualizations and dashboards.

In typical big data production environments with Kyuubi, there should be system administrators and end-users.

  • System administrators: A small group consists of Spark experts responsible for Kyuubi deployment, configuration, and tuning.
  • End-users: Focus on business data of their own, not where it stores, how it computes.

Additionally, the Kyuubi community will continuously optimize the whole system with various features, such as History-Based Optimizer, Auto-tuning, Materialized View, SQL Dialects, Functions, etc.

Usage scenarios

Port workloads from HiveServer2 to Spark SQL

In typical big data production environments, especially secured ones, all bundled services manage access control lists to restricting access to authorized users. For example, Hadoop YARN divides compute resources into queues. With Queue ACLs, it can identify and control which users/groups can take actions on particular queues. Similarly, HDFS ACLs control access of HDFS files by providing a way to set different permissions for specific users/groups.

Apache Spark is a unified analytics engine for large-scale data processing. It provides a Distributed SQL Engine, a.k.a, the Spark Thrift Server(STS), designed to be seamlessly compatible with HiveServer2 and get even better performance.

HiveServer2 can identify and authenticate a caller, and then if the caller also has permissions for the YARN queue and HDFS files, it succeeds. Otherwise, it fails. However, on the one hand, STS is a single Spark application. The user and queue to which STS belongs are uniquely determined at startup. Consequently, STS cannot leverage cluster managers such as YARN and Kubernetes for resource isolation and sharing or control the access for callers by the single user inside the whole system. On the other hand, the Thrift Server is coupled in the Spark driver's JVM process. This coupled architecture puts a high risk on server stability and makes it unable to handle high client concurrency or apply high availability such as load balancing as it is stateful.

Kyuubi extends the use of STS in a multi-tenant model based on a unified interface and relies on the concept of multi-tenancy to interact with cluster managers to finally gain the ability of resources sharing/isolation and data security. The loosely coupled architecture of the Kyuubi server and engine dramatically improves the client concurrency and service stability of the service itself.

DataLake/Lakehouse Support

The vision of Kyuubi is to unify the portal and become an easy-to-use data lake management platform. Different kinds of workloads, such as ETL processing and BI analytics, can be supported by one platform, using one copy of data, with one SQL interface.

  • Logical View support via Kyuubi DataLake Metadata APIs
  • Multiple Catalogs support
  • SQL Standard Authorization support for DataLake(coming)

Cloud Native Support

Kyuubi can deploy its engines on different kinds of Cluster Managers, such as, Hadoop YARN, Kubernetes, etc.

The Kyuubi Ecosystem(present and future)

The figure below shows our vision for the Kyuubi Ecosystem. Some of them have been realized, some in development, and others would not be possible without your help.

Online Documentation Documentation Status

Quick Start

Ready? Getting Started with Kyuubi.

Contributing

Project & Community Status

Aside

The project took its name from a character of a popular Japanese manga - Naruto. The character is named Kyuubi Kitsune/Kurama, which is a nine-tailed fox in mythology. Kyuubi spread the power and spirit of fire, which is used here to represent the powerful Apache Spark. Its nine tails stand for end-to-end multi-tenancy support of this project.