dolphinscheduler

README

Dolphinscheduler Golang SDK

注意，本 SDK 分 v2 和 v3 两个版本，其中 v2 适配 dolphinscheduler 2.* 版本，v3 适配 dolphinscheduler 3.* 版本。

接口列表

• 获取项目列表
• 资源中心获取文件列表
• 安全中心获取环境列表
• 安全中心获取告警组列表
• 安全中心获取租户列表
• 获取数据源列表
• 获取工作流定义列表
• 根据Code获取工作流定义
• 根据Name获取工作流定义
• 解析Json文件到工作流定义
• 从文件导入工作流定义
• 从Bytes导入工作流定义
• 修改工作流定义
• 修改工作流定义基本信息（定时信息）
• 工作流定义上线/下线
• 删除工作流定义
• 获取工作流定时列表
• 工作流定定时上线/下线
• 删除工作流定时

v2用法

1. 引入包

import (
	ds "github.com/hongyuxuan/dolphinscheduler-sdk-go"
)

1. 新建到 dolphinscheduler 连接

client := ds.NewClientV2(
  option.WithDebug(true),
  option.WithBaseUrl("http://<your_dolphinscheduler_host>/dolphinscheduler"),
  option.WithToken("<your_token>"))

1. 实例1：获取项目列表

res, err := client.Project(nil).List(
  context.Background(), 
  option.WithPageNo(1), 
  option.WithPageSize(10), 
  option.WithSearchVal("<your_search_key>"))
if err != nil {
  log.Fatal(err)
}
fmt.Println(res)

1. 实例2：从文件导入工作流定义

if err := client.Project(<projectCode>).
  ProcessDefinition(nil).
  ImportFile(context.Background(), "<path_to_your_file>"); err != nil {
  log.Fatal(err)
}

更多示例详见test。

Documentation

Index

• type ClientV2
  • func NewClientV2(opts ...option.ClientOptionFunc) *ClientV2
  • func (c *ClientV2) Datasource() *datasourcev2.Datasource
  • func (c *ClientV2) Environment() *securityv2.Environment
  • func (c *ClientV2) Project(projectCode *int64) *projectv2.Project
  • func (c *ClientV2) Resource() *resourcev2.Resource
  • func (c *ClientV2) Tenant() *securityv2.Tenant
  • func (c *ClientV2) WarningGroup() *securityv2.WarningGroup
• type ClientV3
  • func NewClientV3(opts ...option.ClientOptionFunc) *ClientV3
  • func (c *ClientV3) Datasource() *datasourcev3.Datasource
  • func (c *ClientV3) Environment() *securityv3.Environment
  • func (c *ClientV3) Project(projectCode *int64) *projectv3.Project
  • func (c *ClientV3) Resource() *resourcev3.Resource
  • func (c *ClientV3) Tenant() *securityv3.Tenant
  • func (c *ClientV3) WarningGroup() *securityv3.WarningGroup

Types

type ClientV2

type ClientV2 struct {
	Config *config.Config
}

func NewClientV2

func NewClientV2(opts ...option.ClientOptionFunc) *ClientV2

func (*ClientV2) Datasource

func (c *ClientV2) Datasource() *datasourcev2.Datasource

func (*ClientV2) Environment

func (c *ClientV2) Environment() *securityv2.Environment

func (*ClientV2) Project

func (c *ClientV2) Project(projectCode *int64) *projectv2.Project

func (*ClientV2) Resource

func (c *ClientV2) Resource() *resourcev2.Resource

func (*ClientV2) Tenant

func (c *ClientV2) Tenant() *securityv2.Tenant

func (*ClientV2) WarningGroup

func (c *ClientV2) WarningGroup() *securityv2.WarningGroup

type ClientV3

type ClientV3 struct {
	Config *config.Config
}

func NewClientV3

func NewClientV3(opts ...option.ClientOptionFunc) *ClientV3

func (*ClientV3) Datasource

func (c *ClientV3) Datasource() *datasourcev3.Datasource

func (*ClientV3) Environment

func (c *ClientV3) Environment() *securityv3.Environment

func (*ClientV3) Project

func (c *ClientV3) Project(projectCode *int64) *projectv3.Project

func (*ClientV3) Resource

func (c *ClientV3) Resource() *resourcev3.Resource

func (*ClientV3) Tenant

func (c *ClientV3) Tenant() *securityv3.Tenant

func (*ClientV3) WarningGroup

func (c *ClientV3) WarningGroup() *securityv3.WarningGroup