spark-instrumented-optimizer/docs/sql-ref-syntax-dml-insert-into.md
Takeshi Yamamuro 179289f0bf [SPARK-31383][SQL][DOC] Clean up the SQL documents in docs/sql-ref*
### What changes were proposed in this pull request?

This PR intends to clean up the SQL documents in `doc/sql-ref*`.
Main changes are as follows;

 - Fixes wrong syntaxes and capitalize sub-titles
 - Adds some DDL queries in `Examples` so that users can run examples there
 - Makes query output in `Examples` follows the `Dataset.showString` (right-aligned) format
 - Adds/Removes spaces, Indents, or blank lines to follow the format below;

```
---
license...
---

### Description

Writes what's the syntax is.

### Syntax

{% highlight sql %}
SELECT...
    WHERE... // 4 indents after the second line
    ...
{% endhighlight %}

### Parameters

<dl>

  <dt><code><em>Param Name</em></code></dt>
  <dd>
    Param Description
  </dd>
  ...
</dl>

### Examples

{% highlight sql %}
-- It is better that users are able to execute example queries here.
-- So, we prepare test data in the first section if possible.
CREATE TABLE t (key STRING, value DOUBLE);
INSERT INTO t VALUES
    ('a', 1.0), ('a', 2.0), ('b', 3.0), ('c', 4.0);

-- query output has 2 indents and it follows the `Dataset.showString`
-- format (right-aligned).
SELECT * FROM t;
  +---+-----+
  |key|value|
  +---+-----+
  |  a|  1.0|
  |  a|  2.0|
  |  b|  3.0|
  |  c|  4.0|
  +---+-----+

-- Query statements after the second line have 4 indents.
SELECT key, SUM(value)
    FROM t
    GROUP BY key;
  +---+----------+
  |key|sum(value)|
  +---+----------+
  |  c|       4.0|
  |  b|       3.0|
  |  a|       3.0|
  +---+----------+
...
{% endhighlight %}

### Related Statements

 * [XXX](xxx.html)
 * ...
```

### Why are the changes needed?

The most changes of this PR are pretty minor, but I think the consistent formats/rules to write documents are important for long-term maintenance in our community

### Does this PR introduce any user-facing change?

Yes.

### How was this patch tested?

Manually checked.

Closes #28151 from maropu/MakeRightAligned.

Authored-by: Takeshi Yamamuro <yamamuro@apache.org>
Signed-off-by: Sean Owen <srowen@gmail.com>
2020-04-12 23:40:36 -05:00

8.5 KiB

layout title displayTitle license
global INSERT INTO INSERT INTO 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 INSERT INTO statement inserts new rows into a table. The inserted rows can be specified by value expressions or result from a query.

Syntax

{% highlight sql %} INSERT INTO [ TABLE ] table_identifier [ partition_spec ] { { VALUES ( { value | NULL } [ , ... ] ) [ , ( ... ) ] } | query } {% endhighlight %}

Parameters

table_identifier
Specifies a table name, which may be optionally qualified with a database name.

Syntax: [ database_name. ] table_name
partition_spec
An optional parameter that specifies a comma separated list of key and value pairs for partitions.

Syntax: PARTITION (partition_col_name = partition_col_val [ , ... ])
VALUES ( { value | NULL } [ , ... ] ) [ , ( ... ) ]
Specifies the values to be inserted. Either an explicitly specified value or a NULL can be inserted. A comma must be used to separate each value in the clause. More than one set of values can be specified to insert multiple rows.
query
A query that produces the rows to be inserted. It can be in one of following formats:
  • a SELECT statement
  • a TABLE statement
  • a FROM statement

Examples

Single Row Insert Using a VALUES Clause

{% highlight sql %} CREATE TABLE students (name VARCHAR(64), address VARCHAR(64), student_id INT) USING PARQUET PARTITIONED BY (student_id);

INSERT INTO students VALUES ('Amy Smith', '123 Park Ave, San Jose', 111111);

SELECT * FROM students; +---------+---------------------+----------+ | name| address|student_id| +---------+---------------------+----------+ |Amy Smith|123 Park Ave,San Jose| 111111| +---------+---------------------+----------+ {% endhighlight %}

Multi-Row Insert Using a VALUES Clause

{% highlight sql %} INSERT INTO students VALUES ('Bob Brown', '456 Taylor St, Cupertino', 222222), ('Cathy Johnson', '789 Race Ave, Palo Alto', 333333);

SELECT * FROM students; +-------------+------------------------+----------+ | name| address|student_id| +-------------+------------------------+----------+ | Amy Smith| 123 Park Ave, San Jose| 111111| +-------------+------------------------+----------+ | Bob Brown|456 Taylor St, Cupertino| 222222| +-------------+------------------------+----------+ |Cathy Johnson| 789 Race Ave, Palo Alto| 333333| +--------------+-----------------------+----------+ {% endhighlight %}

Insert Using a SELECT Statement

{% highlight sql %} -- Assuming the persons table has already been created and populated. SELECT * FROM persons; +-------------+-------------------------+---------+ | name| address| ssn| +-------------+-------------------------+---------+ |Dora Williams|134 Forest Ave, Melo Park|123456789| +-------------+-------------------------+---------+ | Eddie Davis| 245 Market St, Milpitas|345678901| +-------------+-------------------------+---------+

INSERT INTO students PARTITION (student_id = 444444) SELECT name, address FROM persons WHERE name = "Dora Williams";

SELECT * FROM students; +-------------+-------------------------+----------+ | name| address|student_id| +-------------+-------------------------+----------+ | Amy Smith| 123 Park Ave, San Jose| 111111| +-------------+-------------------------+----------+ | Bob Brown| 456 Taylor St, Cupertino| 222222| +-------------+-------------------------+----------+ |Cathy Johnson| 789 Race Ave, Palo Alto| 333333| +-------------+-------------------------+----------+ |Dora Williams|134 Forest Ave, Melo Park| 444444| +-------------+-------------------------+----------+ {% endhighlight %}

Insert Using a TABLE Statement

{% highlight sql %} -- Assuming the visiting_students table has already been created and populated. SELECT * FROM visiting_students; +-------------+---------------------+----------+ | name| address|student_id| +-------------+---------------------+----------+ |Fleur Laurent|345 Copper St, London| 777777| +-------------+---------------------+----------+ |Gordon Martin| 779 Lake Ave, Oxford| 888888| +-------------+---------------------+----------+

INSERT INTO students TABLE visiting_students;

SELECT * FROM students; +-------------+-------------------------+----------+ | name| address|student_id| +-------------+-------------------------+----------+ | Amy Smith| 123 Park Ave,San Jose| 111111| +-------------+-------------------------+----------+ | Bob Brown| 456 Taylor St, Cupertino| 222222| +-------------+-------------------------+----------+ |Cathy Johnson| 789 Race Ave, Palo Alto| 333333| +-------------+-------------------------+----------+ |Dora Williams|134 Forest Ave, Melo Park| 444444| +-------------+-------------------------+----------+ |Fleur Laurent| 345 Copper St, London| 777777| +-------------+-------------------------+----------+ |Gordon Martin| 779 Lake Ave, Oxford| 888888| +-------------+-------------------------+----------+ {% endhighlight %}

Insert Using a FROM Statement

{% highlight sql %} -- Assuming the applicants table has already been created and populated. SELECT * FROM applicants; +-----------+--------------------------+----------+---------+ | name| address|student_id|qualified| +-----------+--------------------------+----------+---------+ |Helen Davis| 469 Mission St, San Diego| 999999| true| +-----------+--------------------------+----------+---------+ | Ivy King|367 Leigh Ave, Santa Clara| 101010| false| +-----------+--------------------------+----------+---------+ | Jason Wang| 908 Bird St, Saratoga| 121212| true| +-----------+--------------------------+----------+---------+

INSERT INTO students FROM applicants SELECT name, address, id applicants WHERE qualified = true;

SELECT * FROM students; +-------------+-------------------------+----------+ | name| address|student_id| +-------------+-------------------------+----------+ | Amy Smith| 123 Park Ave, San Jose| 111111| +-------------+-------------------------+----------+ | Bob Brown| 456 Taylor St, Cupertino| 222222| +-------------+-------------------------+----------+ |Cathy Johnson| 789 Race Ave, Palo Alto| 333333| +-------------+-------------------------+----------+ |Dora Williams|134 Forest Ave, Melo Park| 444444| +-------------+-------------------------+----------+ |Fleur Laurent| 345 Copper St, London| 777777| +-------------+-------------------------+----------+ |Gordon Martin| 779 Lake Ave, Oxford| 888888| +-------------+-------------------------+----------+ | Helen Davis|469 Mission St, San Diego| 999999| +-------------+-------------------------+----------+ | Jason Wang| 908 Bird St, Saratoga| 121212| +-------------+-------------------------+----------+ {% endhighlight %}