filepaths

package
v2.3.5 Latest Latest
Warning

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

Go to latest
Published: Feb 6, 2026 License: AGPL-3.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source
const (
	WorkspaceConfigFileName = "workspace.spc"
)

Variables

This section is empty.

Functions

func AvailableVersionsFilePath

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

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

func DatabaseInstanceDir() string

func DatabaseVersionFilePath

func DatabaseVersionFilePath() string

DatabaseVersionFilePath returns the plugin version file path

func EnsureBackupsDir

func EnsureBackupsDir() string

EnsureBackupsDir returns the path to the backups 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 EnsureTemplateDir

func EnsureTemplateDir() string

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

func GetDBSignatureLocation

func GetDBSignatureLocation() string

func GetDataLocation

func GetDataLocation() string

func GetDatabaseLibPath

func GetDatabaseLibPath() string

func GetDatabaseLocation

func GetDatabaseLocation() string

func GetFDWBinaryDir

func GetFDWBinaryDir() string

func GetFDWBinaryLocation

func GetFDWBinaryLocation() string

func GetFDWSQLAndControlDir

func GetFDWSQLAndControlDir() string

func GetFDWSQLAndControlLocation

func GetFDWSQLAndControlLocation() (string, string)

func GetInitDbBinaryExecutablePath

func GetInitDbBinaryExecutablePath() string

func GetLegacyPasswordFileLocation

func GetLegacyPasswordFileLocation() string

func GetPasswordFileLocation

func GetPasswordFileLocation() string

func GetPgHbaConfLocation

func GetPgHbaConfLocation() string

func GetPostgresBinaryExecutablePath

func GetPostgresBinaryExecutablePath() string

func GetPostgresqlConfDLocation

func GetPostgresqlConfDLocation() string

func GetPostgresqlConfLocation

func GetPostgresqlConfLocation() string

func GetPostmasterPidLocation

func GetPostmasterPidLocation() string

func GetRootCertKeyLocation

func GetRootCertKeyLocation() string

func GetRootCertLocation

func GetRootCertLocation() string

func GetServerCertKeyLocation

func GetServerCertKeyLocation() string

func GetServerCertLocation

func GetServerCertLocation() string

func GetSteampipeConfLocation

func GetSteampipeConfLocation() string

func LegacyDashboardAssetsDir

func LegacyDashboardAssetsDir() string

LegacyDashboardAssetsDir returns the path to the legacy report assets folder

func LegacyNotificationsFilePath

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 PgDumpBinaryExecutablePath

func PgDumpBinaryExecutablePath() string

func PgRestoreBinaryExecutablePath

func PgRestoreBinaryExecutablePath() string

func PluginManagerStateFilePath

func PluginManagerStateFilePath() string

func ReportAssetsVersionFilePath

func ReportAssetsVersionFilePath() string

ReportAssetsVersionFilePath returns the report assets version file path

func RunningInfoFilePath

func RunningInfoFilePath() string

func ServiceExecutableRelativeLocation

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 WorkspaceProfileDir

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.

Jump to

Keyboard shortcuts

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