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

Build a SQL reference doc

    XMLWordPrintableJSON

Details

    • Umbrella
    • Status: Resolved
    • Major
    • Resolution: Done
    • 3.0.0
    • 3.0.0
    • SQL
    • None

    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

          is related to

          Improvement - An improvement or enhancement to an existing feature or task. SPARK-31429 Add additional fields in ExpressionDescription for more granular category in documentation

          • Major - Major loss of function.
          • Resolved
          links to

          Web Link GitHub Pull Request #27216

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

          Activity

            People

              huaxingao Huaxin Gao
              smilegator Xiao Li
              Votes:
              2 Vote for this issue
              Watchers:
              11 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: