Uploaded image for project: 'Spark'
  1. Spark
  2. SPARK-28588

Build a SQL reference doc

Attach filesAttach ScreenshotVotersWatch issueWatchersCreate sub-taskLinkCloneUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

    Details

    • Type: Umbrella
    • Status: Resolved
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: 3.0.0
    • Fix Version/s: 3.0.0
    • Component/s: SQL
    • Labels:
      None
    • Target Version/s:

      Description

      Spark SQL requires a SQL reference doc for end users, like all the other query engines. https://www.postgresql.org/docs/11/sql.html is an example. 

      Please follow the format of PRs that were merged. Below are couple of PRs that can

      be used as a guideline.

      PR1
      PR2

       

        Attachments

        Issue Links

        1.
        Create a table of content in the left hand side bar for SQL doc. Sub-task Resolved Dilip Biswal Actions
        2.
        NULL Handling Sub-task Resolved Dilip Biswal Actions
        3.
        Document INSERT statement in SQL Reference. Sub-task Resolved Huaxin Gao Actions
        4.
        Document LOAD DATA statement in SQL Reference. Sub-task Resolved Huaxin Gao Actions
        5.
        Document ANALYZE TABLE statement in SQL Reference. Sub-task Resolved Huaxin Gao Actions
        6.
        Document ALTER DATABASE statement. Sub-task Resolved Dilip Biswal Actions
        7.
        Document CACHE TABLE statement in SQL Reference. Sub-task Resolved Huaxin Gao Actions
        8.
        Document ALTER TABLE statement in SQL Reference [Phase 1] Sub-task Resolved pavithra ramachandran Actions
        9.
        Document CREATE DATABASE statement in SQL Reference. Sub-task Resolved Sharanabasappa G Keriwaddi Actions
        10.
        Document CREATE FUNCTION in SQL Reference. Sub-task Resolved Dilip Biswal Actions
        11.
        Document CREATE TABLE in SQL Reference. Sub-task Resolved pavithra ramachandran Actions
        12.
        Document CREATE VIEW statement in SQL Reference. Sub-task Resolved Aman Omer Actions
        13.
        Document DROP DATABASE statement in SQL Reference. Sub-task Resolved Sandeep Katta Actions
        14.
        Document DROP FUNCTION statement in SQL Reference. Sub-task Resolved Sandeep Katta Actions
        15.
        Document DROP TABLE/VIEW statement in SQL Reference. Sub-task Resolved Shivu Sondur Actions
        16.
        Document TRUNCATE TABLE in SQL Reference. Sub-task Resolved pavithra ramachandran Actions
        17.
        Document REPAIR TABLE statement in SQL Reference. Sub-task Resolved Huaxin Gao Actions
        18.
        Document SELECT statement in SQL Reference. Sub-task Resolved Dilip Biswal Actions
        19.
        Document DESCRIBE DATABASE in SQL Reference. Sub-task Resolved kevin yu Actions
        20.
        Document DESCRIBE TABLE in SQL Reference. Sub-task Resolved Dilip Biswal Actions
        21.
        Document DESCRIBE QUERY in SQL Reference. Sub-task Resolved Dilip Biswal Actions
        22.
        Document DESCRIBE FUNCTION in SQL Reference. Sub-task Resolved Dilip Biswal Actions
        23.
        Document SHOW COLUMNS in SQL Reference. Sub-task Resolved Dilip Biswal Actions
        24.
        Document SHOW DATABASES in SQL Reference. Sub-task Resolved Dilip Biswal Actions
        25.
        Document SHOW FUNCTIONS in SQL Reference. Sub-task Resolved Dilip Biswal Actions
        26.
        Document SHOW TABLE in SQL Reference Sub-task Resolved Shivu Sondur Actions
        27.
        Document SHOW TABLES in SQL Reference. Sub-task Resolved Shivu Sondur Actions
        28.
        Document SHOW TBLPROPERTIES in SQL Reference. Sub-task Resolved Dilip Biswal Actions
        29.
        Document SHOW PARTITIONS in SQL Reference. Sub-task Resolved Dilip Biswal Actions
        30.
        Document SHOW CREATE TABLE in SQL Reference. Sub-task Resolved Huaxin Gao Actions
        31.
        Document SET/RESET in SQL Reference. Sub-task Resolved Sharanabasappa G Keriwaddi Actions
        32.
        Document ADD FILE statement in SQL Reference. Sub-task Closed Unassigned Actions
        33.
        Document ADD JAR statement in SQL Reference. Sub-task Resolved Huaxin Gao Actions
        34.
        Document CREATE OR REPLACE FUNCTION in SQL Reference Sub-task Resolved Unassigned Actions
        35.
        Document SHOW FUNCTION LIKE SQL Reference Sub-task Resolved Unassigned Actions
        36.
        Document COMPUTE STAT in SQL Reference Sub-task Resolved Unassigned Actions
        37.
        Document USE DATABASE in SQL Reference Sub-task Resolved Shivu Sondur Actions
        38.
        Document CREATE ROLE Statement Sub-task Resolved Unassigned Actions
        39.
        Document CREATE TEMPORARY FUNCTION in SQL Reference Sub-task Resolved Unassigned Actions
        40.
        Document EXPLAIN Statement in SQL Reference. Sub-task Resolved pavithra ramachandran Actions
        41.
        Document DROP TEMPORARY FUNCTION in SQL Reference Sub-task Resolved Unassigned Actions
        42.
        Document SELECT CURRENT_DATABASE in SQL Reference Sub-task Resolved Unassigned Actions
        43.
        Document REFRESH statement in SQL Reference. Sub-task Resolved kevin yu Actions
        44.
        Document SET ROLE ADMIN in SQL Reference Sub-task Resolved Unassigned Actions
        45.
        Document UNCACHE TABLE in SQL Reference Sub-task Resolved Huaxin Gao Actions
        46.
        Document CLEAR CACHE in SQL Reference Sub-task Resolved Huaxin Gao Actions
        47.
        Document SHOW SCHEMAS statement in SQL Reference. Sub-task Resolved Unassigned Actions
        48.
        Document ALTER VIEW Statement in SQL Reference. Sub-task Resolved kevin yu Actions
        49.
        Document ANALYZE table Statement in SQL Reference. Sub-task Resolved Unassigned Actions
        50.
        Document workings of CBO Sub-task Resolved Unassigned Actions
        51.
        Document Working of Bucketing Sub-task Resolved Unassigned Actions
        52.
        Document working of Adaptive Sub-task Resolved Unassigned Actions
        53.
        Document working of Spark Streaming Sub-task Resolved Unassigned Actions
        54.
        Document LIST JAR in SQL Reference Sub-task Closed Unassigned Actions
        55.
        Document LIST FILE in SQL Reference Sub-task Closed Unassigned Actions
        56.
        Document scalar functions usage in APIs in SQL getting started. Sub-task Resolved Huaxin Gao Actions
        57.
        Document VALUES statement in SQL Reference. Sub-task Resolved Unassigned Actions
        58.
        Fix the typo errors in the SQL reference document merges Sub-task Resolved jobit mathew Actions
        59.
        Fix broken links in SQL Reference Sub-task Resolved Unassigned Actions
        60.
        standardize sql reference Sub-task Resolved Huaxin Gao Actions
        61.
        create function syntax has to be enhance in Doc for multiple dependent jars Sub-task Resolved Unassigned Actions
        62.
        Document WHERE Clause of SELECT statement in SQL Reference. Sub-task Resolved Dilip Biswal Actions
        63.
        Document GROUP BY Clause of SELECT statement in SQL Reference. Sub-task Resolved Dilip Biswal Actions
        64.
        Document HAVING Clause of SELECT statement in SQL Reference. Sub-task Resolved Dilip Biswal Actions
        65.
        Document ORDER BY Clause of SELECT statement in SQL Reference. Sub-task Resolved Dilip Biswal Actions
        66.
        Document SORT BY Clause of SELECT statement in SQL Reference. Sub-task Resolved Dilip Biswal Actions
        67.
        Document LIMIT Clause of SELECT statement in SQL Reference. Sub-task Resolved Dilip Biswal Actions
        68.
        Document CLUSTER BY Clause of SELECT statement in SQL Reference. Sub-task Resolved Dilip Biswal Actions
        69.
        Document DISTRIBUTE BY Clause of SELECT statement in SQL Reference. Sub-task Resolved Dilip Biswal Actions
        70.
        Document PARTITIONED BY Clause of CREATE statement in SQL Reference Sub-task Resolved Unassigned Actions
        71.
        Add a few main pages Sub-task Resolved Huaxin Gao Actions
        72.
        Document STORED AS Clause of CREATE statement in SQL Reference Sub-task Resolved Unassigned Actions
        73.
        Document Literal in SQL Reference Sub-task Resolved Huaxin Gao Actions
        74.
        Document ALTER TABLE statement in SQL Reference [Phase 2] Sub-task Resolved kevin yu Actions
        75.
        Add Documentation for Refresh Resources Sub-task Resolved Rakesh Raushan Actions
        76.
        Add a page to list all commands in SQL Reference Sub-task Resolved Huaxin Gao Actions
        77.
        Document UDF in SQL Reference Sub-task Resolved Huaxin Gao Actions
        78.
        create Function docs structure for SQL Reference Sub-task Resolved Huaxin Gao Actions
        79.
        Document Spark integration with Hive UDFs/UDAFs/UDTFs Sub-task Resolved Huaxin Gao Actions
        80.
        Document Hints Sub-task Resolved Huaxin Gao Actions
        81.
        Document Join in SQL Reference Sub-task Resolved Huaxin Gao Actions
        82.
        Document builtin aggregate function Sub-task Resolved Takeshi Yamamuro Actions
        83.
        Document TABLESAMPLE in SQL Reference Sub-task Resolved Huaxin Gao Actions
        84.
        Document aggregate filters in SQL references Sub-task Resolved Takeshi Yamamuro Actions
        85.
        Document Set Operators in SQL Reference Sub-task Resolved Huaxin Gao Actions
        86.
        Document aggregation in the sql reference doc Sub-task Resolved Unassigned Actions
        87.
        Add Documentation for JSON functions Sub-task Resolved Takeshi Yamamuro Actions
        88.
        Clean up the SQL documents in docs/sql-ref* Sub-task Resolved Takeshi Yamamuro Actions
        89.
        Document Window Function Sub-task Resolved Huaxin Gao Actions
        90.
        Document Table-valued Function and Inline Table Sub-task Resolved Huaxin Gao Actions
        91.
        Document Common Table Expression in SQL Reference Sub-task Resolved Huaxin Gao Actions
        92.
        Re-arrange Data Types page to document Floating Point Special Values Sub-task Resolved Huaxin Gao Actions
        93.
        document identifier in SQL Reference Sub-task Resolved Huaxin Gao Actions
        94.
        Document LIKE clause in SQL Reference Sub-task Resolved Huaxin Gao Actions
        95.
        Add links to subsections in SQL Reference main page Sub-task Resolved Huaxin Gao Actions
        96.
        SQL Reference clean up Sub-task Resolved Huaxin Gao Actions
        97.
        Remove HTML syntax in SQL reference Sub-task Resolved Huaxin Gao Actions
        98.
        Add partitioning hints in SQL reference Sub-task Resolved Huaxin Gao Actions
        99.
        change file locations for use db and refresh table Sub-task Resolved Huaxin Gao Actions

          Activity

            People

            • Assignee:
              huaxingao Huaxin Gao
              Reporter:
              smilegator Xiao Li

              Dates

              • Created:
                Updated:
                Resolved:

                Issue deployment