This is an automated email from the ASF dual-hosted git repository. mergebot-role pushed a commit to branch mergebot in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit 25ed1461bc2a5e86c3de7227da5fbf5085203157 Author: Andrew Pilloud <apill...@google.com> AuthorDate: Fri Jun 29 15:16:29 2018 -0700 Add SQL Set page --- src/_includes/section-menu/sdks.html | 1 + src/documentation/dsls/sql/set.md | 55 ++++++++++++++++++++++++++++++++++++ 2 files changed, 56 insertions(+) diff --git a/src/_includes/section-menu/sdks.html b/src/_includes/section-menu/sdks.html index ba300e5..ff4806b 100644 --- a/src/_includes/section-menu/sdks.html +++ b/src/_includes/section-menu/sdks.html @@ -70,6 +70,7 @@ <li><a href="{{ site.baseurl }}/documentation/dsls/sql/scalar-functions/">Scalar functions</a></li> <li><a href="{{ site.baseurl }}/documentation/dsls/sql/aggregate-functions/">Aggregate functions</a></li> <li><a href="{{ site.baseurl }}/documentation/dsls/sql/user-defined-functions/">User-defined functions</a></li> + <li><a href="{{ site.baseurl }}/documentation/dsls/sql/set/">SET Pipeline Options</a></li> </ul> </li> </ul> diff --git a/src/documentation/dsls/sql/set.md b/src/documentation/dsls/sql/set.md new file mode 100644 index 0000000..c2be505 --- /dev/null +++ b/src/documentation/dsls/sql/set.md @@ -0,0 +1,55 @@ +--- +layout: section +title: "Beam SQL: SET and RESET Statement" +section_menu: section-menu/sdks.html +permalink: /documentation/dsls/sql/set/ +--- +<!-- +Licensed 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. +--> + +# SET and RESET Pipeline Options + +Beam SQL's `SET` and `RESET` statements allow the user to [configure Pipeline +Options]({{ site.baseurl }}/documentation/programming-guide/#configuring-pipeline-options) +via the SQL shell. These are the same Pipeline Options passed to other Beam +applications on the command line in the `--<option>=<value>` format. + +## Syntax + +``` +SET option = value +``` + +The SET command sets a Pipeline Option. + +* `option`: The case sensitive name of the Pipeline Option, specified as an + [Identifier]({{ site.baseurl }}/documentation/dsls/sql/lexical/#identifiers). +* `value`: The case sensitive value of the Pipeline Option, specified as an + [Identifier]({{ site.baseurl }}/documentation/dsls/sql/lexical/#identifiers). + For flag options that have no value on the command line, use `true`. + +``` +RESET option +``` + +The RESET command resets a Pipeline Option to its default value. + +* `option`: The case sensitive name of the Pipeline Option, specified as an + [Identifier]({{ site.baseurl }}/documentation/dsls/sql/lexical/#identifiers). + +## Common Options + +* ```SET project = `my_gcp_project` ```: Sets the default GCP project + to`my_gcp_project`. +* `SET runner = DataflowRunner`: Sets the pipeline to run on Dataflow.