migrate

0.0.0-...-52c1edf Opens a new window with list of versions in this module.

Simple migrations for database/sql For more information about how to use this package see README

Latest version published 7 years ago

GitHub

Package Health Score

50 / 100

security
No known security issues
popularity
Recognized
maintenance
Inactive
community
Limited

Explore Similar Packages

Popularity

Recognized

Imported By: 113
GitHub Stars: 40
Forks: 2
Contributors: 1

Usage Popularity

Based on project statistics from the GitHub repository for the Golang package migrate, we found that it has been 40 times.

The popularity score for Golang modules is calculated based on the number of stars that the project has on GitHub as well as the number of imports by other modules.

Security

No known security issues

Security risks

Direct Vulnerabilities: 0
C
0
H
0
M
0
L

Indirect Vulnerabilities: Check with Snyk

Release Date

Jul 29, 2017

License

BSD-2-Clause

Security Policy

We found a way for you to contribute to the project! Looks like migrate is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 1
Open PR: 0
Last Release: 7 years ago
Last Commit: 7 years ago

Further analysis of the maintenance status of github.com/remind101/migrate based on released golang versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for github.com/remind101/migrate is that it hasn't seen any new versions released to golang in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 1
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like github.com/remind101/migrate is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your go.mod

Ensure all the packages you're using are healthy and well-maintained

Readme

Migrate

Migrate is a Go library for doing migrations. It's stupidly simple and gets out of your way.

Features

It's only dependency is database/sql.
It supports any type of migration you want to run (e.g. raw sql, or Go code).
It doesn't provide a command. It's designed to be embedded in projects and used exclusively as a library.

Usage

migrations := []migrate.Migration{
	{
		ID: 1,
		Up: func(tx *sql.Tx) error {
			_, err := tx.Exec("CREATE TABLE people (id int)")
			return err
		},
		Down: func(tx *sql.Tx) error {
			_, err := tx.Exec("DROP TABLE people")
			return err
		},
	},
	{
		ID: 2,
		// For simple sql migrations, you can use the migrate.Queries
		// helper.
		Up: migrate.Queries([]string{
			"ALTER TABLE people ADD COLUMN first_name text",
		}),
		Down: func(tx *sql.Tx) error {
			// It's not possible to remove a column with
			// sqlite.
			_, err := tx.Exec("SELECT 1 FROM people")
			return err
		},
	},
}

db, _ := sql.Open("sqlite3", ":memory:")
_ = migrate.Exec(db, migrate.Up, migrations...)

Locking

All migrations are run in a transaction, but if you attempt to run a single long running migration concurrently, you could run into a deadlock. For Postgres connections, migrate can use pg_advisory_lock to ensure that only 1 migration is run at a time.

To use this, simply instantiate a Migrator instance using migrate.NewPostgresMigrator:

migrator := NewPostgresMigrator(db)
_ = migrator.Exec(migrate.Up, migrations...)

FAQs

What is migrate?

Simple migrations for database/sql. Visit Snyk Advisor to see a full health score report for migrate, including popularity, security, maintenance & community analysis.

Is migrate popular?

The golang package migrate receives a total of ? weekly downloads. As such, migrate popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is migrate well maintained?

We found indications that migrate is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is migrate safe to use?

The golang package migrate was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 2 November-2024, at 09:56 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP