GO-2024-3070: SQL injection in github.com/stashapp/stash

database

package

v0.7.0 Latest Latest Go to latest Published: May 15, 2021 License: AGPL-3.0 Imports: 22 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/stashapp/stash

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func AppSchemaVersion() uint
func Backup(db *sqlx.DB, backupPath string) error
func DatabaseBackupPath() string
func DatabasePath() string
func Initialize(databasePath string) error
func NeedsMigration() bool
func Ready() error
func Reset(databasePath string) error
func RestoreFromBackup(backupPath string) error
func RunMigrations() error
func Version() uint
func WithInstance(instance *Packr2Source) (source.Driver, error)
func WithTxn(fn func(tx *sqlx.Tx) error) error
type Packr2Source

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrMigrationNeeded indicates that a database migration is needed
	// before the database can be initialized
	ErrMigrationNeeded = errors.New("database migration required")

	// ErrDatabaseNotInitialized indicates that the database is not
	// initialized, usually due to an incomplete configuration.
	ErrDatabaseNotInitialized = errors.New("database not initialized")
)

View Source

var DB *sqlx.DB

View Source

var WriteMu *sync.Mutex

Functions ¶

func AppSchemaVersion ¶ added in v0.2.0

func AppSchemaVersion() uint

func Backup ¶ added in v0.2.0

func Backup(db *sqlx.DB, backupPath string) error

Backup the database. If db is nil, then uses the existing database connection.

func DatabaseBackupPath ¶ added in v0.2.0

func DatabaseBackupPath() string

func DatabasePath ¶ added in v0.7.0

func DatabasePath() string

func Initialize ¶

func Initialize(databasePath string) error

Initialize initializes the database. If the database is new, then it performs a full migration to the latest schema version. Otherwise, any necessary migrations must be run separately using RunMigrations. Returns true if the database is new.

func NeedsMigration ¶ added in v0.2.0

func NeedsMigration() bool

Migrate the database

func Ready ¶ added in v0.7.0

func Ready() error

Ready returns an error if the database is not ready to begin transactions.

func Reset ¶

func Reset(databasePath string) error

func RestoreFromBackup ¶ added in v0.2.0

func RestoreFromBackup(backupPath string) error

func RunMigrations ¶ added in v0.2.0

func RunMigrations() error

Migrate the database

func Version ¶ added in v0.2.0

func Version() uint

func WithInstance ¶

func WithInstance(instance *Packr2Source) (source.Driver, error)

func WithTxn ¶ added in v0.4.0

func WithTxn(fn func(tx *sqlx.Tx) error) error

WithTxn executes the provided function within a transaction. It rolls back the transaction if the function returns an error, otherwise the transaction is committed.

Types ¶

type Packr2Source ¶

type Packr2Source struct {
	Box        *packr.Box
	Migrations *source.Migrations
}

func (*Packr2Source) Close ¶

func (s *Packr2Source) Close() error

func (*Packr2Source) First ¶

func (s *Packr2Source) First() (version uint, err error)

func (*Packr2Source) Next ¶

func (s *Packr2Source) Next(version uint) (nextVersion uint, err error)

func (*Packr2Source) Open ¶

func (s *Packr2Source) Open(url string) (source.Driver, error)

func (*Packr2Source) Prev ¶

func (s *Packr2Source) Prev(version uint) (prevVersion uint, err error)

func (*Packr2Source) ReadDown ¶

func (s *Packr2Source) ReadDown(version uint) (r io.ReadCloser, identifier string, err error)

func (*Packr2Source) ReadUp ¶

func (s *Packr2Source) ReadUp(version uint) (r io.ReadCloser, identifier string, err error)

Source Files ¶

View all Source files

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