db_schema_migration 0.0.1

  • README.md
  • Installing
  • Versions
  • 0

Database schema migration #

A database schema migration tool, to execute the proper sequence of SQL commands that are required to get your DB to the desired state.

The sequence of operations is defined by the sorted order of versions. Versions are semver, and single numbers (1, 2) will be transformed accordingly (1.0.0, 2.0.0).

Usage #

A simple usage example:

import 'dart:async';

import 'package:db_schema_migration/db_schema_migration.dart';
import 'package:db_schema_migration/postgresql.dart';

import 'package:postgresql/postgresql.dart';

Future main() async {
  Connection connection = await _getConnection();
  var migrator = new PostgresqlSchemaMigrator();
  var migrations = new Migrations();
      'CREATE TABLE user(name VARCHAR(127) PRIMARY KEY, password_hash VARCHAR(127));');
  migrations.add(2, 'ALTER TABLE user ADD COLUMN address varchar(127);');
  await migrator.migrate(connection, 'user', migrations);
  // Now the DB has a user table with name, password_hash and address columns.

Some usage patterns #

How to group migrations:

  • per-table migration scripts
    • for each table, there is a separate sequence of migrations
    • foreign keys must be run as separate migrations after the regular tables are done
  • per-package migration scripts (recommended)
    • related tables, FKs and indexes are sharing a sequence of migrations

How to version migrations:

  • regular numbers: 1, 2, 3, ...
  • date + number: 20161204.1, 20161204.2, ...
  • date + package id + sequence: 20161204.134.1, 20161204.134.2, ...

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:

  db_schema_migration: ^0.0.1

2. Install it

You can install packages from the command line:

with pub:

$ pub get

Alternatively, your editor might support pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:

import 'package:db_schema_migration/db_schema_migration.dart';
Version Uploaded Documentation Archive
0.0.1 Dec 4, 2016 Go to the documentation of db_schema_migration 0.0.1 Download db_schema_migration 0.0.1 archive
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

The package version is not analyzed, because it does not support Dart 2. Until this is resolved, the package will receive a health and maintenance score of 0.

Analysis issues and suggestions

Support Dart 2 in pubspec.yaml.

The SDK constraint in pubspec.yaml doesn't allow the Dart 2.0.0 release. For information about upgrading it to be Dart 2 compatible, please see https://dart.dev/dart-2#migration.

Maintenance issues and suggestions

Make sure dartdoc successfully runs on your package's source files. (-10 points)

Dependencies were not resolved.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.0.0 <2.0.0