diff --git a/extend/common-interface/config-file.md b/extend/common-interface/config-file.md index 384f6320..1330c111 100644 --- a/extend/common-interface/config-file.md +++ b/extend/common-interface/config-file.md @@ -250,15 +250,15 @@ A sample configuration file might look like this: "source": "destination.csv", "destination": "out.c-main.test", "incremental": false, - "colummns": [], + "columns": [], "primary_key": [], "delete_where": [], "delimiter": ",", "enclosure": "\"" }, { - "source": "write-alwayss.csv", - "destination": "out.c-main.output-even-on-error" + "source": "write-always.csv", + "destination": "out.c-main.output-even-on-error", "write_always": true } ], diff --git a/extend/common-interface/development-branches.md b/extend/common-interface/development-branches.md index 61d0d4c5..f7ba2457 100644 --- a/extend/common-interface/development-branches.md +++ b/extend/common-interface/development-branches.md @@ -18,7 +18,7 @@ components that modify external resources (e.g., database writers) and those tha ### Is a Component Executed in a Branch Context? -When the [Job Queue](/extend/job-queue/) executes a job in a branch, it sets the [`KBC_BRANCHID` environment variable](/extend/common-interface/environment/#environment-variables) to the current branch ID, which is unique accross the stack. +When the [Job Queue](/extend/job-queue/) executes a job in a branch, it sets the [`KBC_BRANCHID` environment variable](/extend/common-interface/environment/#environment-variables) to the current branch ID, which is unique across the stack. Typically, the fact that a component is executed in a branch is not very important to the component itself. It behaves the same way, and the Keboola job runner does all the heavy lifting. diff --git a/extend/common-interface/folders.md b/extend/common-interface/folders.md index 56d2dda2..10dd3c3b 100644 --- a/extend/common-interface/folders.md +++ b/extend/common-interface/folders.md @@ -185,7 +185,7 @@ The component can run arbitrary queries against the database. The database crede "host": "database.example.com", "warehouse": "test", "database": "my-db", - "schema": "my-schema" + "schema": "my-schema", "user": "john-doe", "password": "secret" } @@ -217,7 +217,7 @@ and unloaded from when the job finishes (when staging storage output is set). The workspace is created just before the job starts and is deleted when the job is terminated. If this option is enabled, the data and the manifests will be loaded to the azure storage blob container under the -data folder similarly to how it does when using the default [local filesystem](extend/common-interface/folders/#root-folder-data). +data folder similarly to how it does when using the default [local filesystem](/extend/common-interface/folders/#root-folder-data). ### Files Files are loaded into the workspace as `[file name]/[file ID]`. For example, if a file 'test.txt' with ID '12345' is in @@ -229,9 +229,9 @@ the input mapping then the file will appear in the storage blob container with U Synapse only exports tables as sliced files. So for example, if you set as table input mapping the table `in.c-main.my-input` as source and `my-input.csv` as destination then in the ABS workspace you will find it with the following structure: -- [containerName]/data/in/tables/my-inpupt.csv/[random identifier1].txt -- [containerName]/data/in/tables/my-inpupt.csv/[random identifier2].txt -- [containerName]/data/in/tables/my-inpupt.csv/[random identifier3].txt +- [containerName]/data/in/tables/my-input.csv/[random identifier1].txt +- [containerName]/data/in/tables/my-input.csv/[random identifier2].txt +- [containerName]/data/in/tables/my-input.csv/[random identifier3].txt ### Mappings diff --git a/extend/common-interface/logging.md b/extend/common-interface/logging.md index 1e7ffaa9..3d53a787 100644 --- a/extend/common-interface/logging.md +++ b/extend/common-interface/logging.md @@ -6,7 +6,7 @@ permalink: /extend/common-interface/logging/ * TOC {:toc} -There are two main, mutually exclusive, ways in which your component can display events Keboola end-users: +There are two main, mutually exclusive, ways in which your component can display events to Keboola end-users: 1. Using [standard output and standard error](https://en.wikipedia.org/wiki/Standard_streams) 2. Using [Graylog GELF](http://docs.graylog.org/en/3.1/pages/gelf.html) compatible logger @@ -30,7 +30,7 @@ of the component and forwards the STDOUT content live to [Storage API Events](ht (log level `info`). The content of STDERR is collected and added (if not empty) as the last event of the job with level `error`. The events are displayed in a [Job detail](https://help.keboola.com/management/jobs/). -The entire output from a component is filter for sensitive values. The [Job Queue](/extend/job-queue/) +The entire output from a component is filtered for sensitive values. The [Job Queue](/extend/job-queue/) keeps track of all encrypted values and if it encounters them in the component output, it replaces them by `[hidden]` placeholder. This prevents accidental leaking of sensitive information for example in exception traces. diff --git a/extend/common-interface/manifest-files/in-tables-manifests.md b/extend/common-interface/manifest-files/in-tables-manifests.md index c85e582d..8ff07cd4 100644 --- a/extend/common-interface/manifest-files/in-tables-manifests.md +++ b/extend/common-interface/manifest-files/in-tables-manifests.md @@ -20,7 +20,7 @@ contents: "created": "2015-01-25T01:35:14+0100", "last_change_date": "2015-01-25T01:35:14+0100", "last_import_date": "2015-01-25T01:35:14+0100", - "table_metadata": { + "metadata": { "KBC.createdBy.component.id": "keboola.python-transformation", "KBC.createdBy.configuration.id": "123456", }, @@ -32,7 +32,7 @@ contents: } {% endhighlight %} -The `name` node refers to the name of the component configuration. +The `name` node refers to the name of the table. The `metadata` and `column_metadata` fields contain Metadata for the table and its columns. The `metadata` field corresponds to the [Table Metadata API call](https://api.keboola.com/?service=storage#post-/v2/storage/branch/-branchId-/tables/-id-/metadata). diff --git a/extend/generic-writer/configuration/configuration.md b/extend/generic-writer/configuration/configuration.md index 456ca484..6494a2c1 100644 --- a/extend/generic-writer/configuration/configuration.md +++ b/extend/generic-writer/configuration/configuration.md @@ -136,7 +136,7 @@ components. ### Default Headers -Allows you to define default query parameters that are being sent with each req This is mostly useful for +Allows you to define default headers that are being sent with each request. This is mostly useful for creating Generic Writer templates and registered components. **NOTE** That you can reference parameters defined in `user_parameters` using the `{"attr":"SOME_KEY"}` syntax. @@ -198,7 +198,7 @@ See [example 024](https://bitbucket.org/kds_consulting_team/kds-team.wr-generic/ #### BearerToken Authorization using the `Bearer token` in the header. E.g. each request will be sent with -header: `"authorization": "Bearer XXXX""` +header: `"authorization": "Bearer XXXX"` **Example**: @@ -220,7 +220,7 @@ See [example 030](https://bitbucket.org/kds_consulting_team/kds-team.wr-generic/ ### SSL Verification -Allows turning of the SSL certificate verification. Use with caution. When set to false, the certificate verification is +Allows turning off the SSL certificate verification. Use with caution. When set to false, the certificate verification is turned off. ```json @@ -245,7 +245,7 @@ For more information, refer to [requests docs](https://requests.readthedocs.io/e ## User Parameters In this section you can defined user parameters to be used in various contexts, e.g. passwords. This is also -the place to use the [dynamic functions](). +the place to use the [dynamic functions](/extend/generic-writer/configuration/#dynamic-functions). It allows referencing another values from `user_parameters` referenced by `{"attr":"par"}` notation. @@ -309,7 +309,7 @@ A relative path of the endpoint. The final request URL is `base_url` and `endpoi e.g. when `base_url` is set to `https://example.com/api` and `endpoint_path` to `/customer` the resulting URL is `https://example.com/api/customer` -**NOTE** That it is possible to change the `enpoint_path` dynamically +**NOTE** That it is possible to change the `endpoint_path` dynamically using [iteration columns](/extend/generic-writer/configuration/#iterate-by-columns) e.g. `/orders/[[id]]` as seen in [example 005](https://bitbucket.org/kds_consulting_team/kds-team.wr-generic/src/master/docs/examples/005-json-iterations/) @@ -324,7 +324,7 @@ in [example 005](https://bitbucket.org/kds_consulting_team/kds-team.wr-generic/s ### Headers -Allows you to define default query parameters that are being sent with each request. +Allows you to define request headers that are being sent with each request. **NOTE** That you can reference parameters defined in `user_parameters` using the `{"attr":"SOME_KEY"}` syntax. diff --git a/extend/generic-writer/index.md b/extend/generic-writer/index.md index 6fb0d02c..2691d76a 100644 --- a/extend/generic-writer/index.md +++ b/extend/generic-writer/index.md @@ -35,7 +35,7 @@ Or sending data with different user parameters that are present in the input tab There are variety of use-cases for the generic writer. You may create, update or even delete objects via RESTful API or just trigger simple webhooks by sending GET requests to specified endpoints or send notifications to slack. The setup is quite straightforward and it -allows you to leverage secure [encripted parameters](overview/encryption/) and dynamic functions. +allows you to leverage secure [encrypted parameters](/overview/encryption/) and dynamic functions. **The typical use cases are:** diff --git a/extend/job-queue/index.md b/extend/job-queue/index.md index 7fdfc55c..09582182 100644 --- a/extend/job-queue/index.md +++ b/extend/job-queue/index.md @@ -49,7 +49,7 @@ The component is responsible for these processes: Job Queue is responsible for the following processes: - **Authentication:** Job Queue makes sure the component is run by authorized users/tokens. -It is not possible to run a component anonymously. The component does not have an access to the Keboola token +It is not possible to run a component anonymously. The component does not have access to the Keboola token itself, and it receives only limited information about the project and the end-user. - **Starting and stopping** the component: Job Queue will boot a Docker container which contains the component. This ensures the component runs in a precisely defined environment, which is guaranteed to