Repository: flink Updated Branches: refs/heads/release-0.9 1cac3a4ba -> 2b6a837a2
[docs] fix broken scala shell link Project: http://git-wip-us.apache.org/repos/asf/flink/repo Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/2b6a837a Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/2b6a837a Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/2b6a837a Branch: refs/heads/release-0.9 Commit: 2b6a837a205f4bd5030105ec4568f6fd07cc8bce Parents: 1cac3a4 Author: Maximilian Michels <[email protected]> Authored: Fri Sep 25 13:05:52 2015 +0200 Committer: Maximilian Michels <[email protected]> Committed: Fri Sep 25 13:05:52 2015 +0200 ---------------------------------------------------------------------- docs/_includes/navbar.html | 2 +- docs/apis/scala_shell.md | 70 +++++++++++++++++++++++++++++++++++++++++ docs/scala_shell.md | 70 ----------------------------------------- 3 files changed, 71 insertions(+), 71 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flink/blob/2b6a837a/docs/_includes/navbar.html ---------------------------------------------------------------------- diff --git a/docs/_includes/navbar.html b/docs/_includes/navbar.html index 7c2e954..e934d52 100644 --- a/docs/_includes/navbar.html +++ b/docs/_includes/navbar.html @@ -80,7 +80,7 @@ under the License. <li><a href="{{ apis }}/python.html">Python API <span class="badge">Beta</span></a></li> <li class="divider"></li> - <li><a href="scala_shell.html">Interactive Scala Shell</a></li> + <li><a href="{{ apis }}/scala_shell.html">Interactive Scala Shell</a></li> <li><a href="{{ apis }}/dataset_transformations.html">Dataset Transformations</a></li> <li><a href="{{ apis }}/best_practices.html">Best Practices</a></li> <li><a href="{{ apis }}/example_connectors.html">Connectors</a></li> http://git-wip-us.apache.org/repos/asf/flink/blob/2b6a837a/docs/apis/scala_shell.md ---------------------------------------------------------------------- diff --git a/docs/apis/scala_shell.md b/docs/apis/scala_shell.md new file mode 100644 index 0000000..0ce070c --- /dev/null +++ b/docs/apis/scala_shell.md @@ -0,0 +1,70 @@ +--- +title: "Interactive Scala Shell" +--- +<!-- +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. +--> + + +Flink comes with an integrated interactive Scala Shell. +It can be used in a local setup as well as in a cluster setup. To get started with downloading +Flink and setting up a cluster please refer to +[local setup]({{ site.baseurl }}/setup/local_setup.html) or +[cluster setup]({{ site.baseurl }}/setup/cluster.html) + +To use the shell with an integrated Flink cluster just execute: + +~~~bash +bin/start-scala-shell.sh +~~~ + +in the root directory of your binary Flink directory. + +To use it with a running cluster you can supply the host and port of the JobManager with: + +~~~bash +bin/start-scala-shell.sh --host <hostname> --port <portnumber> +~~~ + +## Usage + +The shell will prebind the ExecutionEnvironment as "env", so far only batch mode is supported. + +The following example will execute the wordcount program in the Scala shell: + +~~~scala +Scala-Flink> val text = env.fromElements( + "To be, or not to be,--that is the question:--", + "Whether 'tis nobler in the mind to suffer", + "The slings and arrows of outrageous fortune", + "Or to take arms against a sea of troubles,") +Scala-Flink> val counts = text.flatMap { _.toLowerCase.split("\\W+") }.map { (_, 1) }.groupBy(0).sum(1) +Scala-Flink> counts.print() +~~~ + + +The print() command will automatically send the specified tasks to the JobManager for execution and will show the result of the computation in the terminal. + +It is possbile to write results to a file. However, in this case you need to call `execute`, to run your program: + +~~~scala +Scala-Flink> env.execute("MyProgram") +~~~ + +The Flink Shell comes with command history and autocompletion. + http://git-wip-us.apache.org/repos/asf/flink/blob/2b6a837a/docs/scala_shell.md ---------------------------------------------------------------------- diff --git a/docs/scala_shell.md b/docs/scala_shell.md deleted file mode 100644 index 0ce070c..0000000 --- a/docs/scala_shell.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "Interactive Scala Shell" ---- -<!-- -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. ---> - - -Flink comes with an integrated interactive Scala Shell. -It can be used in a local setup as well as in a cluster setup. To get started with downloading -Flink and setting up a cluster please refer to -[local setup]({{ site.baseurl }}/setup/local_setup.html) or -[cluster setup]({{ site.baseurl }}/setup/cluster.html) - -To use the shell with an integrated Flink cluster just execute: - -~~~bash -bin/start-scala-shell.sh -~~~ - -in the root directory of your binary Flink directory. - -To use it with a running cluster you can supply the host and port of the JobManager with: - -~~~bash -bin/start-scala-shell.sh --host <hostname> --port <portnumber> -~~~ - -## Usage - -The shell will prebind the ExecutionEnvironment as "env", so far only batch mode is supported. - -The following example will execute the wordcount program in the Scala shell: - -~~~scala -Scala-Flink> val text = env.fromElements( - "To be, or not to be,--that is the question:--", - "Whether 'tis nobler in the mind to suffer", - "The slings and arrows of outrageous fortune", - "Or to take arms against a sea of troubles,") -Scala-Flink> val counts = text.flatMap { _.toLowerCase.split("\\W+") }.map { (_, 1) }.groupBy(0).sum(1) -Scala-Flink> counts.print() -~~~ - - -The print() command will automatically send the specified tasks to the JobManager for execution and will show the result of the computation in the terminal. - -It is possbile to write results to a file. However, in this case you need to call `execute`, to run your program: - -~~~scala -Scala-Flink> env.execute("MyProgram") -~~~ - -The Flink Shell comes with command history and autocompletion. -
