File tree Expand file tree Collapse file tree
libs/executors/garf/executors Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -12,6 +12,9 @@ Configs are defined in YAML files. The core structure consists of a two elements
1212source in ` sources ` .
1313
1414``` yaml
15+ name : config_name
16+ metadata :
17+ version : ' 0.0.0'
1518sources :
1619 source-alias :
1720 writer : bq
@@ -27,6 +30,8 @@ global_parameters:
2730
2831where:
2932
33+ * ** name** : Optional config name.
34+ * ** metadata** : Optional metadata on config (version, description).
3035* ** source-alias** : The source of data. Check [ available fetchers] ( ../fetchers/overview.md ) .
3136* ** fetcher_parameters** : Key value pairs used to fine-tune fetching process.
3237* ** writer** : Where the data should be saved. Check [ available writers] ( writers.md ) .
Original file line number Diff line number Diff line change @@ -13,9 +13,16 @@ where each step interacts with a specific data source (fetcher) and writes to a
1313Workflows are defined in YAML files. The core structure consists of a list of
1414` steps ` , where each step defines what data to fetch and where to save it.
1515
16- ### Workflow Step Structure
16+ ### Workflow Structure
1717
1818``` yaml
19+ name : test_workflow
20+ metadata :
21+ description : Test workflow description
22+ version : ' 0.0.0'
23+ required_garf_version : " "
24+ required_fetchers :
25+ garf-google-ads : " 1.0.0"
1926steps :
2027 - alias : step_name
2128 fetcher : source_name
@@ -40,6 +47,12 @@ steps:
4047
4148### Components
4249
50+ * **name**: Optional name of the workflow
51+ * **metadata**: Optional metadata for the workflow.
52+ * **description**: Short description of the workflow.
53+ * **version**: Version of the workflow.
54+ * **required_garf_version**: Minimal required version of garf-executors library.
55+ * **required_fetchers**: Required fetchers and their version.
4356* **fetcher**: The source of data. Check [available fetchers](../fetchers/overview.md).
4457* **fetcher_parameters**: Key value pairs used to fine-tune fetching process.
4558* **alias**: A unique identifier for the step. Useful for logging and [selective execution](#selective-execution).
Original file line number Diff line number Diff line change 2121 'ApiQueryExecutor' ,
2222]
2323
24- __version__ = '1.4.2 '
24+ __version__ = '1.4.3 '
You can’t perform that action at this time.
0 commit comments