Skip to content

Latest commit

 

History

History
83 lines (59 loc) · 2.3 KB

README_template.md

File metadata and controls

83 lines (59 loc) · 2.3 KB
Raw

KBC Component

Description

Table of contents:

[TOC]

Functionality notes

Prerequisites

Get the API token, register application, etc.

Features

Feature Note
Generic UI form Dynamic UI form
Row Based configuration Allows structuring the configuration in rows.
oAuth oAuth authentication enabled
Incremental loading Allows fetching data in new increments.
Backfill mode Support for seamless backfill setup.
Date range filter Specify date range.

Supported endpoints

If you need more endpoints, please submit your request to ideas.keboola.com

Configuration

Param 1

Param 2

Output

List of tables, foreign keys, schema.

Development

If required, change local data folder (the CUSTOM_FOLDER placeholder) path to your custom path in the docker-compose file:

    volumes:
      - ./:/code
      - ./CUSTOM_FOLDER:/data

Clone this repository, init the workspace and run the component with following command:

git clone repo_path my-new-component
cd my-new-component
docker-compose build
docker-compose run --rm dev

Run the test suite and lint check using this command:

docker-compose run --rm test

Integration

For information about deployment and integration with KBC, please refer to the deployment section of developers documentation