dilipbiswal commented on a change in pull request #26759: [SPARK-28794][SQL][DOC] Documentation for Create table Command URL: https://github.com/apache/spark/pull/26759#discussion_r367267170
########## File path: docs/sql-ref-syntax-ddl-create-table-datasource.md ########## @@ -0,0 +1,97 @@ +--- +layout: global +title: CREATE DATASOURCE TABLE +displayTitle: CREATE DATASOURCE TABLE +license: | + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--- + +### Description + +The `CREATE TABLE` statement creates a new table using a Data Source. + +### Syntax +{% highlight sql %} +CREATE TABLE [IF NOT EXISTS] [db_name.]table_name + [(col_name1 col_type1 [COMMENT col_comment1], ...)] + USING data_source + [OPTIONS (key1=val1, key2=val2, ...)] + [PARTITIONED BY (col_name1, col_name2, ...)] + [CLUSTERED BY (col_name3, col_name4, ...) INTO num_buckets BUCKETS] + [LOCATION path] + [COMMENT table_comment] + [TBLPROPERTIES (key1=val1, key2=val2, ...)] + [AS select_statement] +{% endhighlight %} + +### Parameters + +<dl> + <dt><code><em>USING data_source</em></code></dt> + <dd>Data Source is the file format used to create the table. Data source can be CSV, TXT, ORC, JDBC, PARQUET, etc.</dd> +</dl> + +<dl> + <dt><code><em>PARTITIONED BY</em></code></dt> + <dd>Partitions are created on the table, based on the columns specified.</dd> +</dl> + +<dl> + <dt><code><em>CLUSTERED BY</em></code></dt> + <dd> + Partitions created on the table will be bucketed into fixed buckets based on the column specified for bucketing.<br><br> + <b>NOTE:</b>Bucketing is an optimization technique that uses buckets (and bucketing columns) to determine data partitioning and avoid data shuffle. + </dd> +</dl> + +<dl> + <dt><code><em>LOCATION</em></code></dt> + <dd>Path to the directory where table data is stored, could be filesystem, HDFS, etc.</dd> +</dl> + +<dl> + <dt><code><em>COMMENT</em></code></dt> + <dd>Table comments are added.</dd> +</dl> + +<dl> + <dt><code><em>TBLPROPERTIES</em></code></dt> + <dd>Table properties that has to be set are specified such as `created.by.user`, `owner`, etc. + </dd> +</dl> + +<dl> + <dt><code><em>AS select_statement</em></code></dt> + <dd>The table is populated using the data from the select statement.</dd> +</dl> + +### Examples +{% highlight sql %} + +--Using data source +CREATE TABLE Student (width INT, length INT, height INT) USING CSV Review comment: perhaps change the column names to id, name, age to be more meaningful ? Also can you please put semi colon at the end in the examples just to be consistent with other docs ? cc @huaxingao can you please check on the consistency part if you have some time ? ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
