Skip to main content
Ctrl+K
🦊 Welcome to Kyuubi’s online documentation ✨, v1.10.1
Apache Kyuubi - Home Apache Kyuubi - Home

Admin Guide

  • Quick Start
    • Getting Started
    • Getting Started with Helm
    • Getting Started with Hive JDBC
  • Configurations
  • Deploying Kyuubi
    • Deploy Kyuubi On Kubernetes
    • Integration with Hive Metastore
    • Kyuubi High Availability Guide
    • Kyuubi Migration Guide
    • Deploy Kyuubi engines on YARN
    • Deploy Kyuubi engines on Kubernetes
    • The Share Level Of Kyuubi Engines
    • The TTL Of Kyuubi Engines
    • The Spark SQL Engine Configuration Guide
      • How To Use Spark Dynamic Resource Allocation (DRA) in Kyuubi
      • How To Use Spark Adaptive Query Execution (AQE) in Kyuubi
      • Solution for Large Query Results
      • Gluten
  • Security
    • Authentication
      • Configure Kyuubi to use Kerberos Authentication
      • Configure Kerberos for clients to Access Kerberized Kyuubi
      • Configure Kyuubi to use LDAP Authentication
      • Configure Kyuubi to Use JDBC Authentication
      • Configure Kyuubi to use Custom Authentication
    • Authorization
      • Spark AuthZ Plugin
        • Overview
        • Building
        • Installing
    • Kinit Auxiliary Service
    • Hadoop Credentials Manager
  • Monitoring
    • 1. Monitoring Kyuubi - Logging System
    • 2. Monitoring Kyuubi - Server Metrics
    • 3. Trouble Shooting
  • Tools
    • Administrator CLI
    • Kyuubi Administer Tool

User Guide

  • Clients & APIs
    • JDBC Drivers
      • Kyuubi Hive JDBC Driver
      • Hive JDBC Driver
      • MySQL Connectors
      • Trino JDBC Driver
    • Command Line Interface(CLI)s
      • Kyuubi Beeline
      • Hive Beeline
      • Trino command line interface
    • Business Intelligence Tools and SQL IDEs
      • Apache Superset
      • Cloudera Hue
      • DataGrip
      • DBeaver
      • PowerBI
      • Tableau
    • ODBC Drivers
    • Thrift APIs
    • RESTful APIs and Clients
      • REST API v1
    • Web UI
      • Engine UI
    • Python
      • PyHive
      • PySpark
      • Python-JayDeBeApi
    • Client Commons
      • Client Configuration Guide
      • Logging
      • Configure Kerberos for clients to Access Kerberized Kyuubi
      • Advanced Features
        • Using Different Kyuubi Engines
        • Sharing and Isolation for Kyuubi Engines
        • Setting Time to Live for Kyuubi Engines
        • Enabling Kyuubi Engine Pool
        • Running Scala Snippets
        • Plan Only Execution Mode

Extension Guide

  • Extensions
    • Server Side Extensions
      • Configure Kyuubi to use Custom Authentication
      • Inject Session Conf with Custom Config Advisor
      • Configure Kyuubi to use Custom EventHandler
      • Manage Applications against Extra Cluster Managers
    • Engine Side Extensions
      • Extensions for Spark
        • Z-Ordering Support
        • Auxiliary Optimization Rules
        • Kyuubi Spark AuthZ Plugin
        • Auxiliary SQL Functions
        • Connectors for Spark SQL Query Engine
        • SQL Lineage Support
        • Hive Dialect Support
      • Extensions for Flink
        • Connectors For Flink SQL Query Engine
        • Auxiliary SQL Functions
      • Extensions for Hive
        • Connectors for Hive SQL Query Engine
        • Auxiliary SQL Functions
      • Extensions for Trino
        • Connectors For Trino SQL Engine

Connectors

  • Connectors
    • Connectors for Spark SQL Query Engine
      • Delta Lake
      • Delta Lake with Microsoft Azure Blob Storage
      • Hudi
      • Iceberg
      • Kudu
      • Hive
      • Apache Paimon (Incubating)
      • TiDB
      • TPC-DS
      • TPC-H
    • Connectors For Flink SQL Query Engine
      • Apache Paimon (Incubating)
      • Hudi
      • Iceberg
    • Connectors for Hive SQL Query Engine
      • Apache Paimon (Incubating)
      • Iceberg
    • Connectors For Trino SQL Engine
      • Apache Paimon (Incubating)
      • Hudi
      • Iceberg

Kyuubi Insider

  • Overview
    • Architecture
    • Kyuubi v.s. HiveServer2
    • Kyuubi v.s. Spark Thrift JDBC/ODBC Server (STS)

Contributing

  • Contributing Code
    • Get Started
    • Code Style Guide
    • Building From Source
    • Building A Runnable Distribution
    • Running Tests
    • Debugging Kyuubi
    • Developer Tools
    • IntelliJ IDEA Setup Guide
    • Release Guide
  • Contributing Documentations
    • Get Started
    • Documentation Style Guide
    • Building Documentation

Appendix

  • Appendixes
    • 1. Terminologies
  • Repository
  • Suggest edit
  • .rst

Contributing Code

Contributing Code#

These sections explain the process, guidelines, and tools for contributing code to the Kyuubi project.

  • Get Started
    • Good First Issues
    • Help Wanted Issues
    • Code Contribution Programs
  • Code Style Guide
    • Scala Coding Style Guide
    • Java Coding Style Guide
    • Documentation Style Guide
  • Building From Source
    • Building With Maven
    • Building A Submodule Individually
    • Building Submodules Individually
    • Skipping Some Modules
    • Building Kyuubi Against Different Apache Spark Versions
    • Building Kyuubi Against Different Scala Versions
    • Building With Apache dlcdn Site
    • Building with the fast profile
  • Building A Runnable Distribution
  • Running Tests
    • Running Tests Fully
    • Running Tests for a Module
    • Running Tests for a Single Test
  • Debugging Kyuubi
    • Debugging Server
    • Debugging Engine
    • Debugging Apps
  • Developer Tools
    • Update Project Version
    • Update Dependency List
    • Format All Code
    • Append descriptions of new configurations to settings.md
    • Generative Tooling Usage
  • IntelliJ IDEA Setup Guide
    • Copyright Profile
    • Required Plugins
    • Formatter For Java
    • Formatter For Scala
    • Checkstyle For Scala
  • Release Guide
    • Introduction
    • Decide to release
    • Prepare for the release
    • Cut branch if for feature release
    • Build a release candidate
    • Vote on the release candidate
    • Finalize the Release
    • Promote the release
    • Remove the dist repo directories for deprecated release candidates
    • Keep other artifacts up-to-date

previous

Kyuubi v.s. Spark Thrift JDBC/ODBC Server (STS)

next

Get Started

By Apache Kyuubi Community

© Copyright 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.