Add section for SQL shell by akedin · Pull Request #527 · apache/beam-site

akedin · 2018-08-07T22:05:57Z

Add documentation section for Beam SQL Shell

http://apache-beam-website-pull-requests.storage.googleapis.com/527/documentation/dsls/sql/shell/index.html

akedin · 2018-08-07T22:07:21Z

R: @apilloud @melap
FYI: @xumingmin @xumingming

apilloud

Few minor comments, but LGTM.

apilloud · 2018-08-07T22:11:42Z

src/documentation/dsls/sql/shell.md

+
+## Overview
+
+Starting with version 2.6.0, Beam SQL includes an interactive shell, called the Beam SQL shell. The shell allows you to write pipelines as SQL queries without needing the Java SDK. By default, Beam uses the `DirectRunner` to execute the queries as Beam pipelines.


nit: Should we make this 2.7.0? These instructions won't work in 2.6.0.

These instructions should work as of late June. 2.6.0 RC was only cut last week.

Removed the instructions for :run, replaced with installDist. Works locally

apilloud · 2018-08-07T22:11:45Z

src/documentation/dsls/sql/shell.md

+
+The `CREATE TABLE` statement registers the CSV file as a table in Beam SQL and specifies the table's schema. This statement does not directly create a persistent physical table; it only describes the source/sink to Beam SQL so that you can use the table in the queries that read data and write data.
+
+_For more information about `CREATE TABLE` syntax and supported table types, see the [CREATE TABLE reference page](https://beam.apache.org/documentation/dsls/sql/create-table/)._


use {{ site.baseurl }}

apilloud · 2018-08-07T22:12:17Z

src/documentation/dsls/sql/shell.md

+```
+
+
+_For more information about `SELECT` syntax, see the [SELECT reference page](https://beam.apache.org/documentation/dsls/sql/select/)._


use {{ site.baseurl }}

apilloud · 2018-08-07T22:13:09Z

src/documentation/dsls/sql/shell.md

+
+## Quickstart
+
+To use Beam SQL shell, you must first clone the [Beam SDK repository](https://github.com/apache/beam). Then, from the root of the repository clone, execute the Gradle task to run the shell ([source code](https://github.com/apache/beam/blob/master/sdks/java/extensions/sql/shell/build.gradle#L39)) by running the following command:


Linking to line numbers in master is a bad idea. Can you use a release tag or commit?

That will become stale quick as well. Do you think linking just to the file is better?

Just linking to the file would probably be good. The target audience of the SQL shell probably doesn't care about the code, so just dropping the links might be a good option too.

apilloud · 2018-08-07T22:14:09Z

src/documentation/dsls/sql/shell.md

+
+By default, Beam uses the `DirectRunner` to run the pipeline on the machine where you're executing the commands. If you want to run the pipeline with a different runner, you must perform two steps:
+
+1.  Make sure the SQL shell includes the desired runner. Add the corresponding project id to the `-Pbeam.sql.shell.bundled` parameter of the Gradle invocation ([source code](https://github.com/apache/beam/blob/master/sdks/java/extensions/sql/shell/build.gradle#L26), [project ids](https://github.com/apache/beam/blob/master/settings.gradle)). For example, use the following command to include Flink runner:


Same comment about line numbers in master.

Dropped the line number

melap

LGTM

akedin · 2018-08-08T22:20:54Z

@melap , 2.6.0 is out, can we merge this? Thank you

melap · 2018-08-08T23:26:07Z

@asfgit merge

apilloud approved these changes Aug 7, 2018

View reviewed changes

Add section for SQL shell

c42c415

akedin force-pushed the sql-shell-section branch from 238c7f1 to c42c415 Compare August 7, 2018 22:46

melap approved these changes Aug 7, 2018

View reviewed changes

asfgit closed this in f079eb1 Aug 8, 2018

swegner pushed a commit to swegner/beam that referenced this pull request Sep 19, 2018

This closes apache/beam-site#527

164fe02


		## Overview

		Starting with version 2.6.0, Beam SQL includes an interactive shell, called the Beam SQL shell. The shell allows you to write pipelines as SQL queries without needing the Java SDK. By default, Beam uses the `DirectRunner` to execute the queries as Beam pipelines.


		The `CREATE TABLE` statement registers the CSV file as a table in Beam SQL and specifies the table's schema. This statement does not directly create a persistent physical table; it only describes the source/sink to Beam SQL so that you can use the table in the queries that read data and write data.

		_For more information about `CREATE TABLE` syntax and supported table types, see the [CREATE TABLE reference page](https://beam.apache.org/documentation/dsls/sql/create-table/)._

		```


		_For more information about `SELECT` syntax, see the [SELECT reference page](https://beam.apache.org/documentation/dsls/sql/select/)._


		## Quickstart

		To use Beam SQL shell, you must first clone the [Beam SDK repository](https://github.com/apache/beam). Then, from the root of the repository clone, execute the Gradle task to run the shell ([source code](https://github.com/apache/beam/blob/master/sdks/java/extensions/sql/shell/build.gradle#L39)) by running the following command:


		By default, Beam uses the `DirectRunner` to run the pipeline on the machine where you're executing the commands. If you want to run the pipeline with a different runner, you must perform two steps:

		1. Make sure the SQL shell includes the desired runner. Add the corresponding project id to the `-Pbeam.sql.shell.bundled` parameter of the Gradle invocation ([source code](https://github.com/apache/beam/blob/master/sdks/java/extensions/sql/shell/build.gradle#L26), [project ids](https://github.com/apache/beam/blob/master/settings.gradle)). For example, use the following command to include Flink runner:

Comments

Conversation

akedin commented Aug 7, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

akedin commented Aug 7, 2018

Uh oh!

apilloud left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

melap left a comment

Choose a reason for hiding this comment

Uh oh!

akedin commented Aug 8, 2018

Uh oh!

melap commented Aug 8, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

akedin commented Aug 7, 2018 •

edited

Loading