filepaths

package
v0.24.2 Latest Latest
Warning

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

 Go to latest Published: Sep 13, 2024 License: AGPL-3.0 Imports: 14 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	DefaultInstallDir      = "~/.steampipe"
	DefaultPipesInstallDir = "~/.pipes"
)

Constants for Config

View Source 
const (
	WorkspaceDataDir            = ".steampipe"
	WorkspaceModDir             = "mods"
	WorkspaceModShadowDirPrefix = ".mods."
	WorkspaceConfigFileName     = "workspace.spc"
	WorkspaceIgnoreFile         = ".steampipeignore"
	DefaultVarsFileName         = "steampipe.spvars"
	WorkspaceLockFileName       = ".mod.cache.json"
)

mod related constants

Variables

View Source 
var ModFileNames = []string{"mod.sp"}
View Source 
var PipesInstallDir = ""

PipesInstallDir is the location of config files commen between pipelings this must be set by the application at startup

View Source 
var SteampipeDir string

Functions

func AvailableVersionsFilePath added in v0.19.0 

func AvailableVersionsFilePath() string

AvailableVersionsFilePath returns the path of the json file used to store cache available versions of installed plugins and the CLI

func BackupsDir 

func BackupsDir() string

BackupsDir returns the path to the backups directory

func ConnectionStatePath 

func ConnectionStatePath() string

ConnectionStatePath returns the path of the connections state file

func DashboardServiceStateFilePath 

func DashboardServiceStateFilePath() string

func DatabaseBackupFilePath added in v0.21.0 

func DatabaseBackupFilePath() string

tar file where the dump file will be stored, so that it can be later restored after connections refresh in a new installation

func DatabaseInstanceDir added in v0.21.0 

func DatabaseInstanceDir() string

func DatabaseVersionFilePath 

func DatabaseVersionFilePath() string

DatabaseVersionFilePath returns the plugin version file path

func DefaultModFilePath added in v0.21.5 

func DefaultModFilePath(modFolder string) string

func DefaultVarsFilePath 

func DefaultVarsFilePath(workspacePath string) string

func EnsureBackupsDir 

func EnsureBackupsDir() string

EnsureBackupsDir returns the path to the backups directory (creates if missing)

func EnsureConfigDir 

func EnsureConfigDir() string

EnsureConfigDir returns the path to the config directory (creates if missing)

func EnsureDashboardAssetsDir 

func EnsureDashboardAssetsDir() string

func EnsureDatabaseDir 

func EnsureDatabaseDir() string

EnsureDatabaseDir returns the path to the db directory (creates if missing)

func EnsureInternalDir 

func EnsureInternalDir() string

EnsureInternalDir returns the path to the internal directory (creates if missing)

func EnsureLogDir 

func EnsureLogDir() string

EnsureLogDir returns the path to the db log directory (creates if missing)

func EnsurePipesInternalDir added in v0.22.0 

func EnsurePipesInternalDir() string

EnsurePipesInternalDir returns the path to the pipes internal directory (creates if missing)

func EnsurePluginDir 

func EnsurePluginDir() string

EnsurePluginDir returns the path to the plugins directory (creates if missing)

func EnsurePluginInstallDir added in v0.22.2 

func EnsurePluginInstallDir(pluginImageDisplayRef string) string

func EnsureTemplateDir 

func EnsureTemplateDir() string

EnsureTemplateDir returns the path to the templates directory (creates if missing)

func FindPluginFolder added in v0.19.0 

func FindPluginFolder(remoteSchema string) (string, error)

FindPluginFolder searches for a folder which when hashed would match the schema

func GetDBSignatureLocation added in v0.21.0 

func GetDBSignatureLocation() string

func GetDataLocation added in v0.21.0 

func GetDataLocation() string

func GetDatabaseLocation added in v0.21.0 

func GetDatabaseLocation() string

func GetFDWBinaryDir added in v0.21.0 

func GetFDWBinaryDir() string

func GetFDWBinaryLocation added in v0.21.0 

func GetFDWBinaryLocation() string

func GetFDWSQLAndControlDir added in v0.21.0 

func GetFDWSQLAndControlDir() string

func GetFDWSQLAndControlLocation added in v0.21.0 

func GetFDWSQLAndControlLocation() (string, string)

func GetInitDbBinaryExecutablePath added in v0.21.0 

func GetInitDbBinaryExecutablePath() string

func GetLegacyPasswordFileLocation added in v0.21.0 

func GetLegacyPasswordFileLocation() string

func GetPasswordFileLocation added in v0.21.0 

func GetPasswordFileLocation() string

func GetPgHbaConfLocation added in v0.21.0 

func GetPgHbaConfLocation() string

func GetPluginPath added in v0.19.0 

func GetPluginPath(pluginImageRef, pluginAlias string) (string, error)

func GetPostgresBinaryExecutablePath added in v0.21.0 

func GetPostgresBinaryExecutablePath() string

func GetPostgresqlConfDLocation added in v0.21.0 

func GetPostgresqlConfDLocation() string

func GetPostgresqlConfLocation added in v0.21.0 

func GetPostgresqlConfLocation() string

func GetPostmasterPidLocation added in v0.21.0 

func GetPostmasterPidLocation() string

func GetRootCertKeyLocation added in v0.21.0 

func GetRootCertKeyLocation() string

func GetRootCertLocation added in v0.21.0 

func GetRootCertLocation() string

func GetServerCertKeyLocation added in v0.21.0 

func GetServerCertKeyLocation() string

func GetServerCertLocation added in v0.21.0 

func GetServerCertLocation() string

func GetSteampipeConfLocation added in v0.21.0 

func GetSteampipeConfLocation() string

func IsModInstallShadowPath added in v0.20.0 

func IsModInstallShadowPath(dirName string) bool

func LegacyDashboardAssetsDir 

func LegacyDashboardAssetsDir() string

LegacyDashboardAssetsDir returns the path to the legacy report assets folder

func LegacyNotificationsFilePath added in v0.19.0 

func LegacyNotificationsFilePath() string

LegacyNotificationsFilePath returns the path of the (legacy) notifications.json file used to store update notifications

func LegacyStateFilePath 

func LegacyStateFilePath() string

LegacyStateFilePath returns the path of the legacy update-check.json state file

func LegacyVersionFilePath 

func LegacyVersionFilePath() string

LegacyVersionFilePath returns the legacy version file path

func LocalPluginPath added in v0.22.2 

func LocalPluginPath() string

LocalPluginPath returns the path to locally installed plugins

func ModFilePaths added in v0.21.5 

func ModFilePaths(modFolder string) []string

func PgDumpBinaryExecutablePath added in v0.21.0 

func PgDumpBinaryExecutablePath() string

func PgRestoreBinaryExecutablePath added in v0.21.0 

func PgRestoreBinaryExecutablePath() string

func PluginAliasToLongName added in v0.22.2 

func PluginAliasToLongName(pluginName string) string

func PluginAliasToShortName added in v0.22.2 

func PluginAliasToShortName(pluginName string) string

func PluginBinaryPath added in v0.22.2 

func PluginBinaryPath(pluginImageDisplayRef, pluginAlias string) string

func PluginInstallDir added in v0.22.2 

func PluginInstallDir(pluginImageDisplayRef string) string

func PluginManagerStateFilePath 

func PluginManagerStateFilePath() string

func PluginVersionFilePath 

func PluginVersionFilePath() string

PluginVersionFilePath returns the plugin version file path

func ReportAssetsVersionFilePath 

func ReportAssetsVersionFilePath() string

ReportAssetsVersionFilePath returns the report assets version file path

func RunningInfoFilePath 

func RunningInfoFilePath() string

func ServiceExecutableRelativeLocation added in v0.21.0 

func ServiceExecutableRelativeLocation() string

func StateFileName 

func StateFileName() string

func StateFilePath 

func StateFilePath() string

StateFilePath returns the path of the update_check.json state file

func WorkspaceLockPath 

func WorkspaceLockPath(workspacePath string) string

func WorkspaceModPath 

func WorkspaceModPath(workspacePath string) string

func WorkspaceModShadowPath added in v0.20.0 

func WorkspaceModShadowPath(workspacePath string) string

func WorkspaceProfileDir added in v0.17.0 

func WorkspaceProfileDir(installDir string) (string, error)

WorkspaceProfileDir returns the path to the workspace profiles directory if STEAMPIPE_WORKSPACE_PROFILES_LOCATION is set use that otherwise look in the config folder NOTE: unlike other path functions this accepts the install-dir as arg this is because of the slightly complex bootstrapping process required because the install-dir may be set in the workspace profile

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.