@a-mehrabi/aranode-scheduler 中文文档教程
Scheduler Module
aranode 流引擎的调度程序实现。
Table of Contents
Installation
要在您的 aranode 项目中安装此模块， 你只需要使用以下命令添加包：
$ yarn add @a-mehrabi/aranode-scheduler
之后，当你想使用它时， 您必须将其包含在如下自定义模块中：
path: .env
ARANODE_CUSTOM_MODULES=@a-mehrabi/aranode-scheduler
Usage
要使用 Scheduler，您需要三个清单：
） ">nonperiodicScheduler)
periodic Scheduler
要安排周期性作业，您必须创建一个适配器清单。
流程示例：
version: 1
kind: flow
name: flow-name
flow:
start:
nextNode: scheduled
scheduled:
transform:
path: 'dist/input-transformer.js'
terminal: true
配置示例：
path: adapter.yml
version: 1
kind: adapter
name: adapter-name
adapter:
periodicScheduler:
minute:
- 57
path: bind.yml
version: 1
kind: bind
name: bind-name
bind:
flow-name:
- type: inbound
port: inbound-port-name
adapter: adapter-name
nonperiodic Scheduler
以安排非周期性作业您必须创建适配器清单的特定日期。
流程示例：
version: 1
kind: flow
name: flow-name
flow:
start:
nextNode: scheduled
scheduled:
transform:
path: 'dist/input-transformer.js'
terminal: true
配置示例：
path: adapter.yml
version: 1
kind: adapter
name: adapter-name
adapter:
nonperiodicScheduler:
year: 2021
month: 12
day: 14
hour: 12
mnute: 28
second: 10
path: bind.yml
version: 1
kind: bind
name: bind-name
bind:
flow-name:
- type: inbound
port: inbound-port-name
adapter: adapter-name
API
periodicScheduler
类型：适配器清单
选项：
日期 (number[])，可选
(1-31)。
dayOfWeek (number[])，可选
(0-6) 从星期日开始。
小时 (number[])，可选
(0-23)。
分钟 (number[])，可选
(0-59)。
月 (number[])，可选
(0-11)。
秒数 (number[])，可选
(0-59)。
年（数字[]），可选
nonperiodicScheduler
类型：适配器清单
选项：
年（数字），必需
月（数字），必需
（0- 11).
天（数字），需要
小时（数字），需要
（0-23）。
分钟（数字），必需
(0-59)。
秒（数字），必需
(0-59)。
Scheduler Module
Scheduler implementation for aranode flow engine.
Table of Contents
Installation
To install this module in your aranode project, you just need to add the package using following command:
$ yarn add @a-mehrabi/aranode-scheduler
After that, when you want to use it, you must include it in custom modules like the following:
path: .env
ARANODE_CUSTOM_MODULES=@a-mehrabi/aranode-scheduler
Usage
For using Scheduler, you need three manifests:
Periodic scheduler adapter manifest (periodicScheduler)
Nonperiodic scheduler adapter manifest (nonperiodicScheduler)
periodic Scheduler
to schedule periodic jobs you have to create a adapter manifest.
flow example:
version: 1
kind: flow
name: flow-name
flow:
start:
nextNode: scheduled
scheduled:
transform:
path: 'dist/input-transformer.js'
terminal: true
Configs example:
path: adapter.yml
version: 1
kind: adapter
name: adapter-name
adapter:
periodicScheduler:
minute:
- 57
path: bind.yml
version: 1
kind: bind
name: bind-name
bind:
flow-name:
- type: inbound
port: inbound-port-name
adapter: adapter-name
nonperiodic Scheduler
to schedule nonperiodic jobs in a specific date you have to create a adapter manifest.
flow example:
version: 1
kind: flow
name: flow-name
flow:
start:
nextNode: scheduled
scheduled:
transform:
path: 'dist/input-transformer.js'
terminal: true
Configs example:
path: adapter.yml
version: 1
kind: adapter
name: adapter-name
adapter:
nonperiodicScheduler:
year: 2021
month: 12
day: 14
hour: 12
mnute: 28
second: 10
path: bind.yml
version: 1
kind: bind
name: bind-name
bind:
flow-name:
- type: inbound
port: inbound-port-name
adapter: adapter-name
API
periodicScheduler
Type: adapter manifest
Options:
date (number[]), optional
(1-31).
dayOfWeek (number[]), optional
(0-6) Starting with Sunday.
hour (number[]), optional
(0-23).
minute (number[]), optional
(0-59).
month (number[]), optional
(0-11).
scond (number[]), optional
(0-59).
year (number[]), optional
nonperiodicScheduler
Type: adapter manifest
Options:
year (number), required
month (number), required
(0-11).
day (number), required
hour (number), required
(0-23).
minute (number), required
(0-59).
scond (number), required
(0-59).
