factset

Documentation

Index

• type FSFile
• type Package
• type PackageMetadata
• type PackageVersion
• type Service
  • func (s *Service) Download(file FSFile, product string) (*os.File, error)
  • func (s *Service) GetLatestFile(pkg Package, isFull bool) (FSFile, error)
  • func (s *Service) GetSchemaInfo(pkg Package) (*PackageVersion, error)
• type Servicer
  • func NewService(sftpUser, sftpKey, sftpAddress string, sftpPort int, workspace string) (Servicer, error)

Types

type FSFile

type FSFile struct {
	Name    string
	Path    string
	Version PackageVersion
	IsFull  bool
}

FSFile - representation of a file on the Factset server

type Package

type Package struct {
	Dataset     string
	FSPackage   string
	Product     string
	Bundle      string
	FeedVersion int
}

Package - represents a package from Factset

type PackageMetadata

type PackageMetadata struct {
	Package
	SchemaVersion     PackageVersion
	SchemaLoadedDate  time.Time
	PackageVersion    PackageVersion
	PackageLoadedDate time.Time
}

PackageMetadata - extended package including versioning information

type PackageVersion

type PackageVersion struct {
	FeedVersion int
	Sequence    int
}

PackageVersion - Factset package versioning is two parts

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service - Factset service

func (*Service) Download

func (s *Service) Download(file FSFile, product string) (*os.File, error)

Download - downloads the file from Factset and provides a local file object

func (*Service) GetLatestFile

func (s *Service) GetLatestFile(pkg Package, isFull bool) (FSFile, error)

GetLatestFile - Get latest file for a package

func (*Service) GetSchemaInfo

func (s *Service) GetSchemaInfo(pkg Package) (*PackageVersion, error)

GetSchemaInfo - Get the latest schema info from Factset

type Servicer

type Servicer interface {
	GetSchemaInfo(pkg Package) (*PackageVersion, error)
	GetLatestFile(pkg Package, isFull bool) (FSFile, error)
	Download(file FSFile, product string) (*os.File, error)
}

Servicer - service interface to be able to mock for testing

func NewService

func NewService(sftpUser, sftpKey, sftpAddress string, sftpPort int, workspace string) (Servicer, error)

NewService - create a new Service(r)