superset

README

superset

Usage

source:
  name: superset
  config:
    username: meteor_tester
    password: meteor_pass_1234
    host: http://localhost:3000
    provider: db

Inputs

Key	Value	Example	Description
username	string	meteor_tester	Username to access the superset	required
password	string	meteor_pass_1234	Password for the superset	required
host	string	http://localhost:4002	Host at which superset is running	required
provider	string	db	Provider for the superset	required

Outputs

Field	Sample Value
resource.urn	superset.dashboard_name
resource.name	dashboard_name
resource.service	superset
resource.url	dashboard_url

Chart

Field	Sample Value
name	chart_name
dashboard_source	superset
description	chart_description
url	chart_url
datasource	chart_datasource
dashboard_urn	dashboard:dashboard_id

Contributing

Refer to the contribution guidelines for information on contributing to this module.

Documentation

Index

• type Chart
• type Config
• type Dashboard
• type Extractor
  • func New(logger log.Logger) *Extractor
  • func (e *Extractor) Extract(_ context.Context, emit plugins.Emit) (err error)
  • func (e *Extractor) Init(ctx context.Context, config plugins.Config) (err error)
• type Owners
• type Roles

Types

type Chart

type Chart struct {
	CacheTimeout        int      `json:"cache_timeout"`
	ChangedOn           string   `json:"changed_on"`
	Datasource          string   `json:"datasource"`
	Description         string   `json:"description"`
	DescriptionMarkdown string   `json:"description_markeddown"`
	FormData            struct{} `json:"form_data"`
	Modified            string   `json:"modified"`
	SliceId             int      `json:"slice_id"`
	SliceName           string   `json:"slice_name"`
	SliceUrl            string   `json:"slice_url"`
}

type Config

type Config struct {
	Username string `mapstructure:"username" validate:"required"`
	Password string `mapstructure:"password" validate:"required"`
	Host     string `mapstructure:"host" validate:"required"`
	Provider string `mapstructure:"provider" validate:"required"`
}

Config holds the set of configuration for the superset extractor

type Dashboard

type Dashboard struct {
	ChangedByName  string   `json:"changed_by_name"`
	ChangedByUrl   string   `json:"changed_by_url"`
	DashboardTitle string   `json:"dashboard_title"`
	ID             int      `json:"id"`
	JsonMetadata   string   `json:"json_metadata"`
	PositionJson   string   `json:"position_json"`
	Published      bool     `json:"published"`
	Slug           string   `json:"slug"`
	TableNames     string   `json:"table_names"`
	ThumbnailUrl   string   `json:"thumbnail_url"`
	URL            string   `json:"url"`
	Owners         []Owners `json:"owners"`
	Roles          []Roles  `json:"roles"`
}

type Extractor

type Extractor struct {
	plugins.BaseExtractor
	// contains filtered or unexported fields
}

Extractor manages the extraction of data from the superset server

func New

func New(logger log.Logger) *Extractor

New returns a pointer to an initialized Extractor Object

func (*Extractor) Extract

func (e *Extractor) Extract(_ context.Context, emit plugins.Emit) (err error)

Extract collects metadata of each dashboard through emitter

func (*Extractor) Init

func (e *Extractor) Init(ctx context.Context, config plugins.Config) (err error)

Init initializes the extractor

type Owners

type Owners struct {
	FirstName string `json:"first_name"`
	ID        int    `json:"id"`
	LastName  string `json:"last_name"`
	Username  string `json:"username"`
}

type Roles

type Roles struct {
	ID   int    `json:"id"`
	Name string `json:"name"`
}