filestore

package
v2.0.7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 4, 2021 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source
const AppExt = ".json"

AppExt is the the file extension searched for in the directory for layout files

View Source
const DashExt = ".dashboard"

DashExt is the the file extension searched for in the directory for dashboard files

View Source
const KapExt = ".kap"

KapExt is the the file extension searched for in the directory for kapacitor files

View Source
const OrgExt = ".org"

OrgExt is the the file extension searched for in the directory for org files

View Source
const SrcExt = ".src"

SrcExt is the the file extension searched for in the directory for source files

Variables

This section is empty.

Functions

func NewApps

func NewApps(dir string, ids chronograf.ID, logger chronograf.Logger) chronograf.LayoutsStore

NewApps constructs a layout store wrapping a file system directory

func NewDashboards

func NewDashboards(dir string, ids chronograf.ID, logger chronograf.Logger) chronograf.DashboardsStore

NewDashboards constructs a dashboard store wrapping a file system directory

func NewKapacitors

func NewKapacitors(dir string, ids chronograf.ID, logger chronograf.Logger) chronograf.ServersStore

NewKapacitors constructs a kapacitor store wrapping a file system directory

func NewOrganizations

func NewOrganizations(dir string, logger chronograf.Logger) chronograf.OrganizationsStore

NewOrganizations constructs a org store wrapping a file system directory

func NewSources

func NewSources(dir string, ids chronograf.ID, logger chronograf.Logger) chronograf.SourcesStore

NewSources constructs a source store wrapping a file system directory

Types

type Apps

type Apps struct {
	Dir      string                                      // Dir is the directory contained the pre-canned applications.
	Load     func(string) (chronograf.Layout, error)     // Load loads string name and return a Layout
	Filename func(string, chronograf.Layout) string      // Filename takes dir and layout and returns loadable file
	Create   func(string, chronograf.Layout) error       // Create will write layout to file.
	ReadDir  func(dirname string) ([]os.FileInfo, error) // ReadDir reads the directory named by dirname and returns a list of directory entries sorted by filename.
	Remove   func(name string) error                     // Remove file
	IDs      chronograf.ID                               // IDs generate unique ids for new application layouts
	Logger   chronograf.Logger
}

Apps are canned JSON layouts. Implements LayoutsStore.

func (*Apps) Add

func (a *Apps) Add(ctx context.Context, layout chronograf.Layout) (chronograf.Layout, error)

Add creates a new layout within the directory

func (*Apps) All

func (a *Apps) All(ctx context.Context) ([]chronograf.Layout, error)

All returns all layouts from the directory

func (*Apps) Delete

func (a *Apps) Delete(ctx context.Context, layout chronograf.Layout) error

Delete removes a layout file from the directory

func (*Apps) Get

func (a *Apps) Get(ctx context.Context, ID string) (chronograf.Layout, error)

Get returns an app file from the layout directory

func (*Apps) Update

func (a *Apps) Update(ctx context.Context, layout chronograf.Layout) error

Update replaces a layout from the file system directory

type Dashboards

type Dashboards struct {
	Dir     string                                      // Dir is the directory containing the dashboards.
	Load    func(string, interface{}) error             // Load loads string name and dashboard passed in as interface
	Create  func(string, interface{}) error             // Create will write dashboard to file.
	ReadDir func(dirname string) ([]os.FileInfo, error) // ReadDir reads the directory named by dirname and returns a list of directory entries sorted by filename.
	Remove  func(name string) error                     // Remove file
	IDs     chronograf.ID                               // IDs generate unique ids for new dashboards
	Logger  chronograf.Logger
}

Dashboards are JSON dashboards stored in the filesystem

func (*Dashboards) Add

Add creates a new dashboard within the directory

func (*Dashboards) All

All returns all dashboards from the directory

func (*Dashboards) Delete

func (d *Dashboards) Delete(ctx context.Context, dashboard chronograf.Dashboard) error

Delete removes a dashboard file from the directory

func (*Dashboards) Get

Get returns a dashboard file from the dashboard directory

func (*Dashboards) Update

func (d *Dashboards) Update(ctx context.Context, dashboard chronograf.Dashboard) error

Update replaces a dashboard from the file system directory

type Kapacitors

type Kapacitors struct {
	Dir     string                                      // Dir is the directory containing the kapacitors.
	Load    func(string, interface{}) error             // Load loads string name and dashboard passed in as interface
	Create  func(string, interface{}) error             // Create will write kapacitor to file.
	ReadDir func(dirname string) ([]os.FileInfo, error) // ReadDir reads the directory named by dirname and returns a list of directory entries sorted by filename.
	Remove  func(name string) error                     // Remove file
	IDs     chronograf.ID                               // IDs generate unique ids for new kapacitors
	Logger  chronograf.Logger
}

Kapacitors are JSON kapacitors stored in the filesystem

func (*Kapacitors) Add

func (d *Kapacitors) Add(ctx context.Context, kapacitor chronograf.Server) (chronograf.Server, error)

Add creates a new kapacitor within the directory

func (*Kapacitors) All

func (d *Kapacitors) All(ctx context.Context) ([]chronograf.Server, error)

All returns all kapacitors from the directory

func (*Kapacitors) Delete

func (d *Kapacitors) Delete(ctx context.Context, kapacitor chronograf.Server) error

Delete removes a kapacitor file from the directory

func (*Kapacitors) Get

func (d *Kapacitors) Get(ctx context.Context, id int) (chronograf.Server, error)

Get returns a kapacitor file from the kapacitor directory

func (*Kapacitors) Update

func (d *Kapacitors) Update(ctx context.Context, kapacitor chronograf.Server) error

Update replaces a kapacitor from the file system directory

type Organizations

type Organizations struct {
	Dir     string                                      // Dir is the directory containing the orgs.
	Load    func(string, interface{}) error             // Load loads string name and org passed in as interface
	ReadDir func(dirname string) ([]os.FileInfo, error) // ReadDir reads the directory named by dirname and returns a list of directory entries sorted by filename.
	Logger  chronograf.Logger
}

Organizations are JSON orgs stored in the filesystem

func (*Organizations) Add

Add is not allowed for the filesystem organization store

func (*Organizations) All

All returns all orgs from the directory

func (*Organizations) CreateDefault

func (o *Organizations) CreateDefault(ctx context.Context) error

CreateDefault is not allowed for the filesystem organization store

func (*Organizations) DefaultOrganization

func (o *Organizations) DefaultOrganization(ctx context.Context) (*chronograf.Organization, error)

DefaultOrganization is not allowed for the filesystem organization store

func (*Organizations) Delete

Delete is not allowed for the filesystem organization store

func (*Organizations) Get

Get returns a org file from the org directory

func (*Organizations) Update

Update is not allowed for the filesystem organization store

type Sources

type Sources struct {
	Dir     string                                      // Dir is the directory containing the sources.
	Load    func(string, interface{}) error             // Load loads string name and dashboard passed in as interface
	Create  func(string, interface{}) error             // Create will write source to file.
	ReadDir func(dirname string) ([]os.FileInfo, error) // ReadDir reads the directory named by dirname and returns a list of directory entries sorted by filename.
	Remove  func(name string) error                     // Remove file
	IDs     chronograf.ID                               // IDs generate unique ids for new sources
	Logger  chronograf.Logger
}

Sources are JSON sources stored in the filesystem

func (*Sources) Add

func (d *Sources) Add(ctx context.Context, source chronograf.Source) (chronograf.Source, error)

Add creates a new source within the directory

func (*Sources) All

func (d *Sources) All(ctx context.Context) ([]chronograf.Source, error)

All returns all sources from the directory

func (*Sources) Delete

func (d *Sources) Delete(ctx context.Context, source chronograf.Source) error

Delete removes a source file from the directory

func (*Sources) Get

func (d *Sources) Get(ctx context.Context, id int) (chronograf.Source, error)

Get returns a source file from the source directory

func (*Sources) Update

func (d *Sources) Update(ctx context.Context, source chronograf.Source) error

Update replaces a source from the file system directory

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL