Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
seddonm1 committed Jul 30, 2019
1 parent 61398f2 commit f0b3cc4
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs-src/content/deploy/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,10 @@ This example is included to demonstrate:
|ETL_CONF_TAGS|etl.config.tags|Custom key/value tags separated by space to add to all logging messages.<br><br>E.g. `ETL_CONF_TAGS=cost_center=123456 owner=jovyan`.|
|ETL_CONF_ENV|etl.config.environment|The `environment` to run under.<br><br>E.g. if `ETL_CONF_ENV` is set to `production` then a stage with `"environments": ["production", "test"]` would be executed and one with `"environments": ["test"]` would not be executed.|
|ETL_CONF_ENV_ID|etl.config.environment.id|An environment identifier to be added to all logging messages. Could be something like a [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) which allows joining to logs produced by ephemeral compute started by something like [Terraform](https://www.terraform.io/).|
|ETL_CONF_IGNORE_ENVIRONMENTS|etl.config.ignoreEnvironments|Allows skipping the `environments` tests and execute all stages/plugins.|
|ETL_CONF_URI|etl.config.uri|The URI of the job file to execute.|
|ETL_CONF_STREAMING|etl.config.streaming|Run in [Structured Streaming](https://spark.apache.org/docs/latest/structured-streaming-programming-guide.html) mode or not. Boolean default `false`.|
|ETL_CONF_STORAGE_LEVEL|etl.config.storageLevel|The [StorageLevel](https://spark.apache.org/docs/latest/api/scala/index.html#org.apache.spark.storage.StorageLevel$) used when persisting datasets. String default `MEMORY_AND_DISK_SER`.|
|ETL_CONF_IMMUTABLE_VIEWS|etl.config.immutableViews|Prevent reusing view names multiple times within a job (calls `createTempView` instead of `createOrReplaceTempView`). Boolean default `false`.|

Additionally there are permissions arguments that can be used to retrieve the job file from cloud storage:

Expand Down
6 changes: 6 additions & 0 deletions docs-src/content/validate/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,12 @@ FROM (
) valid
```

The `FILTER` function can be used to select errors only from a certain field:

```sql
SIZE(FILTER(_errors, _error -> _error.field == 'fieldname'))
```

With a text message:

```sql
Expand Down
12 changes: 6 additions & 6 deletions docs/deploy/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -513,6 +513,12 @@ <h2 id="configuration-parameters">Configuration Parameters</h2>
<td>An environment identifier to be added to all logging messages. Could be something like a <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> which allows joining to logs produced by ephemeral compute started by something like <a href="https://www.terraform.io/">Terraform</a>.</td>
</tr>

<tr>
<td>ETL_CONF_IGNORE_ENVIRONMENTS</td>
<td>etl.config.ignoreEnvironments</td>
<td>Allows skipping the <code>environments</code> tests and execute all stages/plugins.</td>
</tr>

<tr>
<td>ETL_CONF_URI</td>
<td>etl.config.uri</td>
Expand All @@ -530,12 +536,6 @@ <h2 id="configuration-parameters">Configuration Parameters</h2>
<td>etl.config.storageLevel</td>
<td>The <a href="https://spark.apache.org/docs/latest/api/scala/index.html#org.apache.spark.storage.StorageLevel$">StorageLevel</a> used when persisting datasets. String default <code>MEMORY_AND_DISK_SER</code>.</td>
</tr>

<tr>
<td>ETL_CONF_IMMUTABLE_VIEWS</td>
<td>etl.config.immutableViews</td>
<td>Prevent reusing view names multiple times within a job (calls <code>createTempView</code> instead of <code>createOrReplaceTempView</code>). Boolean default <code>false</code>.</td>
</tr>
</tbody>
</table>

Expand Down
5 changes: 5 additions & 0 deletions docs/validate/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -655,6 +655,11 @@ <h4 id="complete">Complete</h4>
) valid
</code></pre>

<p>The <code>FILTER</code> function can be used to select errors only from a certain field:</p>

<pre><code class="language-sql">SIZE(FILTER(_errors, _error -&gt; _error.field == 'fieldname'))
</code></pre>

<p>With a text message:</p>

<pre><code class="language-sql">SELECT
Expand Down

0 comments on commit f0b3cc4

Please sign in to comment.