apache/pinot

Support Describe Pinot table and schema

Open

#6,298 opened on Nov 27, 2020

View on GitHub
 (9 comments) (0 reactions) (1 assignee)Java (1,234 forks)batch import
featurehelp wanted

Repository metrics

Stars
 (4,937 stars)
PR merge metrics
 (Avg merge 6d 7h) (186 merged PRs in 30d)

Description

Pinot table conf and schema access is from restful API only right now.

It would be good to support the built-in system tables, and we can query schema in SQL style. This will be useful for users to have a similar onboarding experience that everything can come from the query console. It's also good for Pinot integrations with other systems.

Query examples for references:

SHOW TABLES

DESCRIBE TABLE myTable

SHOW COLUMNS FROM myTable

SELECT 
    TABLE_SCHEMA,
    TABLE_NAME,
    COLUMN_NAME
FROM
    INFORMATION_SCHEMA.COLUMNS
WHERE
    TABLE_SCHEMA <> 'INFORMATION_SCHEMA'

Contributor guide

Research direction
Study Pinot's SQL parser and query engine to understand how to add new system tables for metadata queries like DESCRIBE TABLE and SHOW TABLES. Look at existing system tables and implement the necessary changes in the query engine to support these SQL commands.
Tech stack
javasql
Domain
backenddatabaseapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJava
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65