Skip to content

Commit fba59b5

Browse files
committed
deploy: b648b4a
1 parent 1348b2d commit fba59b5

1,308 files changed

Lines changed: 1780 additions & 1737 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Builtin.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@
237237
<ul style="display: none">
238238
<li class="md-nav__item md-version" id="project.version">
239239
<label class="md-nav__link" for="__version">
240-
<i class="md-icon" title="Version">label_outline</i> 0.14.16-9-3cf3f89-20250507T143400Z*
240+
<i class="md-icon" title="Version">label_outline</i> 0.14.17-31-b648b4a-20250714T202047Z*
241241
</label>
242242
</li>
243243
</ul>
@@ -277,9 +277,9 @@ <h1><a href="#built-in-functionality" name="built-in-functionality" class="ancho
277277
<p>Scio is a thin wrapper on top of Beam offering idiomatic Scala APIs. Check out the <a href="https://beam.apache.org/documentation/programming-guide/">Beam Programming Guide</a> first for a detailed explanation of the Beam programming model and concepts.</p>
278278
<h2><a href="#basics" name="basics" class="anchor"><span class="anchor-link"></span></a>Basics</h2>
279279
<ul>
280-
<li><a href="https://spotify.github.io/scio/api/com/spotify/scio/ScioContext.html" title="com.spotify.scio.ScioContext"><code>ScioContext</code></a> wraps Beam&rsquo;s <a href="https://beam.apache.org/releases/javadoc/2.64.0/?org/apache/beam/sdk/Pipeline.html" title="org.apache.beam.sdk.Pipeline"><code>Pipeline</code></a></li>
281-
<li><a href="https://spotify.github.io/scio/api/com/spotify/scio/values/SCollection.html" title="com.spotify.scio.values.SCollection"><code>SCollection</code></a> wraps Beam&rsquo;s <a href="https://beam.apache.org/releases/javadoc/2.64.0/?org/apache/beam/sdk/values/PCollection.html" title="org.apache.beam.sdk.values.PCollection"><code>PCollection</code></a></li>
282-
<li><a href="https://spotify.github.io/scio/api/com/spotify/scio/ScioResult.html" title="com.spotify.scio.ScioResult"><code>ScioResult</code></a> wraps Beam&rsquo;s <a href="https://beam.apache.org/releases/javadoc/2.64.0/?org/apache/beam/sdk/PipelineResult.html" title="org.apache.beam.sdk.PipelineResult"><code>PipelineResult</code></a></li>
280+
<li><a href="https://spotify.github.io/scio/api/com/spotify/scio/ScioContext.html" title="com.spotify.scio.ScioContext"><code>ScioContext</code></a> wraps Beam&rsquo;s <a href="https://beam.apache.org/releases/javadoc/2.66.0/?org/apache/beam/sdk/Pipeline.html" title="org.apache.beam.sdk.Pipeline"><code>Pipeline</code></a></li>
281+
<li><a href="https://spotify.github.io/scio/api/com/spotify/scio/values/SCollection.html" title="com.spotify.scio.values.SCollection"><code>SCollection</code></a> wraps Beam&rsquo;s <a href="https://beam.apache.org/releases/javadoc/2.66.0/?org/apache/beam/sdk/values/PCollection.html" title="org.apache.beam.sdk.values.PCollection"><code>PCollection</code></a></li>
282+
<li><a href="https://spotify.github.io/scio/api/com/spotify/scio/ScioResult.html" title="com.spotify.scio.ScioResult"><code>ScioResult</code></a> wraps Beam&rsquo;s <a href="https://beam.apache.org/releases/javadoc/2.66.0/?org/apache/beam/sdk/PipelineResult.html" title="org.apache.beam.sdk.PipelineResult"><code>PipelineResult</code></a></li>
283283
</ul>
284284
<p>See dedicated sections on:</p>
285285
<ul>
@@ -338,7 +338,7 @@ <h2><a href="#contextandargs" name="contextandargs" class="anchor"><span class="
338338
val cmdlineArgs: Array[String] = ???
339339
val (sc, args) = ContextAndArgs(cmdlineArgs)
340340
</code></pre>
341-
<p>If you need custom pipeline options, subclass Beam&rsquo;s <a href="https://beam.apache.org/releases/javadoc/2.64.0/?org/apache/beam/sdk/options/PipelineOptions.html" title="org.apache.beam.sdk.options.PipelineOptions"><code>PipelineOptions</code></a> and use <code>ContextAndArgs.typed</code>:</p>
341+
<p>If you need custom pipeline options, subclass Beam&rsquo;s <a href="https://beam.apache.org/releases/javadoc/2.66.0/?org/apache/beam/sdk/options/PipelineOptions.html" title="org.apache.beam.sdk.options.PipelineOptions"><code>PipelineOptions</code></a> and use <code>ContextAndArgs.typed</code>:</p>
342342
<pre class="prettyprint"><code class="language-scala mdoc:compile-only">import com.spotify.scio._
343343
import org.apache.beam.sdk.options.PipelineOptions
344344

@@ -357,7 +357,7 @@ <h3><a href="#counting" name="counting" class="anchor"><span class="anchor-link"
357357
<ul>
358358
<li><a href="https://spotify.github.io/scio/api/com/spotify/scio/values/SCollection.html#count:com.spotify.scio.values.SCollection[Long]" title="com.spotify.scio.values.SCollection"><code>count</code></a> (or <code>countByKey</code>) counts the number of elements</li>
359359
<li><a href="https://spotify.github.io/scio/api/com/spotify/scio/values/SCollection.html#countByValue:com.spotify.scio.values.SCollection[(T,Long)]" title="com.spotify.scio.values.SCollection"><code>countByValue</code></a> counts the number of elements for each value in a <code>SCollection[T]</code></li>
360-
<li><a href="https://spotify.github.io/scio/api/com/spotify/scio/values/SCollection.html#countApproxDistinct(estimator:com.spotify.scio.estimators.ApproxDistinctCounter[T]):com.spotify.scio.values.SCollection[Long]" title="com.spotify.scio.values.SCollection"><code>countApproxDistinct</code></a> (or <code>countApproxDistinctByKey</code>) estimates a distinct count, with Beam&rsquo;s <a href="https://beam.apache.org/releases/javadoc/2.64.0/?org/apache/beam/sdk/transforms/ApproximateUnique.html" title="org.apache.beam.sdk.transforms.ApproximateUnique"><code>ApproximateUnique</code></a> or Scio&rsquo;s HyperLogLog-based <a href="https://spotify.github.io/scio/api/com/spotify/scio/estimators/ApproxDistinctCounter.html" title="com.spotify.scio.estimators.ApproxDistinctCounter"><code>ApproxDistinctCounter</code></a></li>
360+
<li><a href="https://spotify.github.io/scio/api/com/spotify/scio/values/SCollection.html#countApproxDistinct(estimator:com.spotify.scio.estimators.ApproxDistinctCounter[T]):com.spotify.scio.values.SCollection[Long]" title="com.spotify.scio.values.SCollection"><code>countApproxDistinct</code></a> (or <code>countApproxDistinctByKey</code>) estimates a distinct count, with Beam&rsquo;s <a href="https://beam.apache.org/releases/javadoc/2.66.0/?org/apache/beam/sdk/transforms/ApproximateUnique.html" title="org.apache.beam.sdk.transforms.ApproximateUnique"><code>ApproximateUnique</code></a> or Scio&rsquo;s HyperLogLog-based <a href="https://spotify.github.io/scio/api/com/spotify/scio/estimators/ApproxDistinctCounter.html" title="com.spotify.scio.estimators.ApproxDistinctCounter"><code>ApproxDistinctCounter</code></a></li>
361361
</ul>
362362
<pre class="prettyprint"><code class="language-scala mdoc:compile-only">import com.spotify.scio.values.SCollection
363363
import com.spotify.scio.extra.hll.zetasketch.ZetaSketchHllPlusPlus
@@ -371,7 +371,7 @@ <h3><a href="#statistics" name="statistics" class="anchor"><span class="anchor-l
371371
<li><a href="https://spotify.github.io/scio/api/com/spotify/scio/values/SCollection.html#max(implicitord:Ordering[T]):com.spotify.scio.values.SCollection[T]" title="com.spotify.scio.values.SCollection"><code>max</code></a> (or <code>maxByKey</code>) finds the maximum element given some <a href="http://www.scala-lang.org/api/2.13.16/scala/math/Ordering.html" title="scala.math.Ordering"><code>Ordering</code></a></li>
372372
<li><a href="https://spotify.github.io/scio/api/com/spotify/scio/values/SCollection.html#min(implicitord:Ordering[T]):com.spotify.scio.values.SCollection[T]" title="com.spotify.scio.values.SCollection"><code>min</code></a> (or <code>minByKey</code>) finds the minimum element given some <a href="http://www.scala-lang.org/api/2.13.16/scala/math/Ordering.html" title="scala.math.Ordering"><code>Ordering</code></a></li>
373373
<li><a href="https://spotify.github.io/scio/api/com/spotify/scio/values/SCollection.html#mean(implicitev:Numeric[T]):com.spotify.scio.values.SCollection[Double]" title="com.spotify.scio.values.SCollection"><code>mean</code></a> finds the mean given some <a href="http://www.scala-lang.org/api/2.13.16/scala/math/Numeric.html" title="scala.math.Numeric"><code>Numeric</code></a></li>
374-
<li><a href="https://spotify.github.io/scio/api/com/spotify/scio/values/SCollection.html#quantilesApprox(numQuantiles:Int)(implicitord:Ordering[T]):com.spotify.scio.values.SCollection[Iterable[T]]" title="com.spotify.scio.values.SCollection"><code>quantilesApprox</code></a> (or <code>approxQuantilesByKey</code>) finds the distribution using Beam&rsquo;s <a href="https://beam.apache.org/releases/javadoc/2.64.0/?org/apache/beam/sdk/transforms/ApproximateQuantiles.html" title="org.apache.beam.sdk.transforms.ApproximateQuantiles"><code>ApproximateQuantiles</code></a></li>
374+
<li><a href="https://spotify.github.io/scio/api/com/spotify/scio/values/SCollection.html#quantilesApprox(numQuantiles:Int)(implicitord:Ordering[T]):com.spotify.scio.values.SCollection[Iterable[T]]" title="com.spotify.scio.values.SCollection"><code>quantilesApprox</code></a> (or <code>approxQuantilesByKey</code>) finds the distribution using Beam&rsquo;s <a href="https://beam.apache.org/releases/javadoc/2.66.0/?org/apache/beam/sdk/transforms/ApproximateQuantiles.html" title="org.apache.beam.sdk.transforms.ApproximateQuantiles"><code>ApproximateQuantiles</code></a></li>
375375
</ul>
376376
<p>For <code>SCollection</code>s containing <code>Double</code>, Scio additionally provides a <a href="https://spotify.github.io/scio/api/com/spotify/scio/values/DoubleSCollectionFunctions.html#stats:com.spotify.scio.values.SCollection[com.spotify.scio.util.StatCounter]" title="com.spotify.scio.values.DoubleSCollectionFunctions"><code>stats</code></a> method that computes the count, mean, min, max, variance, standard deviation, sample variance, and sample standard deviation over the <code>SCollection</code>. Convenience methods are available directly on the <a href="https://spotify.github.io/scio/api/com/spotify/scio/values/DoubleSCollectionFunctions.html" title="com.spotify.scio.values.DoubleSCollectionFunctions"><code>SCollection</code></a> if only a single value is required:</p>
377377
<pre class="prettyprint"><code class="language-scala mdoc:compile-only">import com.spotify.scio.values.SCollection
@@ -423,7 +423,7 @@ <h3><a href="#sums-combinations" name="sums-combinations" class="anchor"><span c
423423
</code></pre>
424424
<p>See also <a href="extras/Algebird.html">Algebird</a></p>
425425
<h2><a href="#metrics" name="metrics" class="anchor"><span class="anchor-link"></span></a>Metrics</h2>
426-
<p>Scio supports Beam&rsquo;s <a href="https://beam.apache.org/releases/javadoc/2.64.0/?org/apache/beam/sdk/metrics/Counter.html" title="org.apache.beam.sdk.metrics.Counter"><code>Counter</code></a> <a href="https://beam.apache.org/releases/javadoc/2.64.0/?org/apache/beam/sdk/metrics/Distribution.html" title="org.apache.beam.sdk.metrics.Distribution"><code>Distribution</code></a> and <a href="https://beam.apache.org/releases/javadoc/2.64.0/?org/apache/beam/sdk/metrics/Gauge.html" title="org.apache.beam.sdk.metrics.Gauge"><code>Gauge</code></a>.</p>
426+
<p>Scio supports Beam&rsquo;s <a href="https://beam.apache.org/releases/javadoc/2.66.0/?org/apache/beam/sdk/metrics/Counter.html" title="org.apache.beam.sdk.metrics.Counter"><code>Counter</code></a> <a href="https://beam.apache.org/releases/javadoc/2.66.0/?org/apache/beam/sdk/metrics/Distribution.html" title="org.apache.beam.sdk.metrics.Distribution"><code>Distribution</code></a> and <a href="https://beam.apache.org/releases/javadoc/2.66.0/?org/apache/beam/sdk/metrics/Gauge.html" title="org.apache.beam.sdk.metrics.Gauge"><code>Gauge</code></a>.</p>
427427
<p>See <a href="https://spotify.github.io/scio/examples/MetricsExample.scala.html">MetricsExample</a>.</p>
428428
<h2><a href="#scioresult" name="scioresult" class="anchor"><span class="anchor-link"></span></a>ScioResult</h2>
429429
<p><a href="https://spotify.github.io/scio/api/com/spotify/scio/ScioResult.html" title="com.spotify.scio.ScioResult"><code>ScioResult</code></a> can be used to access metric values, individually or as a group:</p>
@@ -596,7 +596,7 @@ <h2><a href="#misc" name="misc" class="anchor"><span class="anchor-link"></span>
596596
</div>
597597
<div class="print-only">
598598
<span class="md-source-file md-version">
599-
0.14.16-9-3cf3f89-20250507T143400Z*
599+
0.14.17-31-b648b4a-20250714T202047Z*
600600
</span>
601601
</div>
602602
</article>

FAQ.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@
233233
<ul style="display: none">
234234
<li class="md-nav__item md-version" id="project.version">
235235
<label class="md-nav__link" for="__version">
236-
<i class="md-icon" title="Version">label_outline</i> 0.14.16-9-3cf3f89-20250507T143400Z*
236+
<i class="md-icon" title="Version">label_outline</i> 0.14.17-31-b648b4a-20250714T202047Z*
237237
</label>
238238
</li>
239239
</ul>
@@ -585,7 +585,7 @@ <h4><a href="#how-do-i-access-various-files-outside-of-a-sciocontext-" name="how
585585
<ul>
586586
<li>For Scio version &gt;= <code>0.4.0</code></li>
587587
</ul>
588-
<p>Starting from Scio <code>0.4.0</code> you can use Apache Beam&rsquo;s <a href="https://beam.apache.org/releases/javadoc/2.64.0/?org/apache/beam/sdk/io/FileSystems.html" title="org.apache.beam.sdk.io.FileSystems"><code>Filesystems</code></a> abstraction:</p>
588+
<p>Starting from Scio <code>0.4.0</code> you can use Apache Beam&rsquo;s <a href="https://beam.apache.org/releases/javadoc/2.66.0/?org/apache/beam/sdk/io/FileSystems.html" title="org.apache.beam.sdk.io.FileSystems"><code>Filesystems</code></a> abstraction:</p>
589589
<pre class="prettyprint"><code class="language-scala mdoc:reset:silent">import org.apache.beam.sdk.io.FileSystems
590590
// the path can be any of the supported Filesystems, e.g. local, GCS, HDFS
591591
def readmeResource = FileSystems.matchNewResource(&quot;gs://&lt;bucket&gt;/README.md&quot;, false)
@@ -595,7 +595,7 @@ <h4><a href="#how-do-i-access-various-files-outside-of-a-sciocontext-" name="how
595595
<li>For Scio version &lt; <code>0.4.0</code></li>
596596
</ul><div class="callout note "><div class="callout-title">Note</div>
597597
<p>This part is GCS specific.</p></div>
598-
<p>You can get a <a href="https://beam.apache.org/releases/javadoc/2.64.0/?org/apache/beam/sdk/extensions/gcp/options/GcsOptions.html#getGcsUtil--" title="org.apache.beam.sdk.extensions.gcp.options.GcsOptions"><code>GcsUtil</code></a> instance from <code>ScioContext</code>, which can be used to open GCS files in read or write mode.</p>
598+
<p>You can get a <a href="https://beam.apache.org/releases/javadoc/2.66.0/?org/apache/beam/sdk/extensions/gcp/options/GcsOptions.html#getGcsUtil--" title="org.apache.beam.sdk.extensions.gcp.options.GcsOptions"><code>GcsUtil</code></a> instance from <code>ScioContext</code>, which can be used to open GCS files in read or write mode.</p>
599599
<pre class="prettyprint"><code class="language-scala mdoc:reset:silent">import com.spotify.scio.ContextAndArgs
600600
import org.apache.beam.sdk.extensions.gcp.options.GcsOptions
601601

@@ -786,7 +786,7 @@ <h4><a href="#how-to-inspect-the-content-of-an-scollection-" name="how-to-inspec
786786
<li>In <a href="./Scio-REPL.html">Scio-REPL</a>, use <code>runAndCollect()</code> to execute the pipeline and materialize the contents of an <code>SCollection</code></li>
787787
</ul>
788788
<h4><a href="#how-do-i-improve-side-input-performance-" name="how-do-i-improve-side-input-performance-" class="anchor"><span class="anchor-link"></span></a>How do I improve side input performance?</h4>
789-
<p>By default, Dataflow workers allocate 100MB (see <a href="https://beam.apache.org/releases/javadoc/2.64.0/?org/apache/beam/runners/dataflow/options/DataflowWorkerHarnessOptions.html#getWorkerCacheMb--" title="org.apache.beam.runners.dataflow.options.DataflowWorkerHarnessOptions"><code>DataflowWorkerHarnessOptions#getWorkerCacheMb</code></a>) of memory for caching side inputs, and falls back to disk or network. Therefore jobs with large side inputs may be slow. To override this default, register <code>DataflowWorkerHarnessOptions</code> before parsing command line arguments and then pass <code>--workerCacheMb=N</code> when submitting the job.</p>
789+
<p>By default, Dataflow workers allocate 100MB (see <a href="https://beam.apache.org/releases/javadoc/2.66.0/?org/apache/beam/runners/dataflow/options/DataflowWorkerHarnessOptions.html#getWorkerCacheMb--" title="org.apache.beam.runners.dataflow.options.DataflowWorkerHarnessOptions"><code>DataflowWorkerHarnessOptions#getWorkerCacheMb</code></a>) of memory for caching side inputs, and falls back to disk or network. Therefore jobs with large side inputs may be slow. To override this default, register <code>DataflowWorkerHarnessOptions</code> before parsing command line arguments and then pass <code>--workerCacheMb=N</code> when submitting the job.</p>
790790
<pre class="prettyprint"><code class="language-scala mdoc:reset:silent">import com.spotify.scio._
791791
import org.apache.beam.sdk.options.PipelineOptionsFactory
792792
import org.apache.beam.runners.dataflow.options.DataflowWorkerHarnessOptions
@@ -830,7 +830,7 @@ <h4><a href="#how-to-manually-investigate-a-cloud-dataflow-worker" name="how-to-
830830
</div>
831831
<div class="print-only">
832832
<span class="md-source-file md-version">
833-
0.14.16-9-3cf3f89-20250507T143400Z*
833+
0.14.17-31-b648b4a-20250714T202047Z*
834834
</span>
835835
</div>
836836
</article>

0 commit comments

Comments
 (0)