filesystem

Documentation

Index

• Constants
• func CachedDataDirPath() string
• func ConfigDirPath() string
• func CopyFile(src, dst string) error
• func EnsureCachedDataDir() error
• func EnsureConfigDir() error
• func EnsureExecutableDir(workspacePath, subPath string) error
• func EnsureLogsDir() error
• func EnsureWorkspaceConfig(workspaceName, workspacePath string) error
• func EnsureWorkspaceDir(workspacePath string) error
• func InitConfig() error
• func InitWorkspaceConfig(name, path string) error
• func LoadConfig() (*config.Config, error)
• func LoadFlowFile(cfgFile string) (*executable.FlowFile, error)
• func LoadFlowFileTemplate(flowfileName, templatePath string) (*executable.Template, error)
• func LoadFlowFileTemplates(templatePaths map[string]string) (executable.TemplateList, error)
• func LoadWorkspaceConfig(workspaceName, workspacePath string) (*workspace.Workspace, error)
• func LoadWorkspaceFlowFiles(workspaceCfg *workspace.Workspace) (executable.FlowFileList, error)
• func LogsDir() string
• func StateDirPath() string
• func UserConfigFilePath() string
• func WorkspaceConfigExists(workspacePath string) bool
• func WriteConfig(config *config.Config) error
• func WriteFlowFile(cfgFile string, cfg *executable.FlowFile) error
• func WriteWorkspaceConfig(workspacePath string, config *workspace.Workspace) error

Constants

const FlowCacheDirEnvVar = "FLOW_CACHE_DIR"

const FlowConfigDirEnvVar = "FLOW_CONFIG_DIR"

const FlowStateDirEnvVar = "FLOW_STATE_DIR"

const WorkspaceConfigFileName = "flow.yaml"

Functions

func CachedDataDirPath

func CachedDataDirPath() string

func ConfigDirPath

func ConfigDirPath() string

func CopyFile

func CopyFile(src, dst string) error

func EnsureCachedDataDir

func EnsureCachedDataDir() error

func EnsureConfigDir

func EnsureConfigDir() error

func EnsureExecutableDir

func EnsureExecutableDir(workspacePath, subPath string) error

func EnsureLogsDir

func EnsureLogsDir() error

func EnsureWorkspaceConfig

func EnsureWorkspaceConfig(workspaceName, workspacePath string) error

func EnsureWorkspaceDir

func EnsureWorkspaceDir(workspacePath string) error

func InitConfig

func InitConfig() error

func InitWorkspaceConfig

func InitWorkspaceConfig(name, path string) error

func LoadConfig

func LoadConfig() (*config.Config, error)

func LoadFlowFile

func LoadFlowFile(cfgFile string) (*executable.FlowFile, error)

func LoadFlowFileTemplate

func LoadFlowFileTemplate(flowfileName, templatePath string) (*executable.Template, error)

func LoadFlowFileTemplates

func LoadFlowFileTemplates(templatePaths map[string]string) (executable.TemplateList, error)

func LoadWorkspaceConfig

func LoadWorkspaceConfig(workspaceName, workspacePath string) (*workspace.Workspace, error)

func LoadWorkspaceFlowFiles

func LoadWorkspaceFlowFiles(
	workspaceCfg *workspace.Workspace,
) (executable.FlowFileList, error)

func LogsDir

func LogsDir() string

func StateDirPath

func StateDirPath() string

StateDirPath returns the platform-appropriate directory for persistent state data (logs, history) that is not configuration and should not be treated as disposable cache.

Platform defaults:

• macOS: ~/Library/Logs/flow
• Linux: $XDG_STATE_HOME/flow (defaults to ~/.local/state/flow)
• Windows: %LOCALAPPDATA%\flow

func UserConfigFilePath

func UserConfigFilePath() string

func WorkspaceConfigExists

func WorkspaceConfigExists(workspacePath string) bool

func WriteConfig

func WriteConfig(config *config.Config) error

func WriteFlowFile

func WriteFlowFile(cfgFile string, cfg *executable.FlowFile) error

func WriteWorkspaceConfig

func WriteWorkspaceConfig(workspacePath string, config *workspace.Workspace) error