Blyx

Bittern

Workflow framework · 0.1.0

Plan the next migration only after history, fingerprints and dirty state agree.

Decide whether the next database migration can run

The two applied versions form an exact prefix with matching fingerprints. Version 5 is ready to apply.

Run the native CLI

Extract the workflow collection for your platform. Run .\bin\bittern.exe --help in PowerShell or ./bin/bittern --help on Linux and macOS. Running the command with no arguments prints the worked example.

Build from source

With Blyx 0.2.1, Rust and a host linker installed, run these commands to edit and rebuild the example.

git clone --depth 1 --branch v0.1.0 https://github.com/Rahulchaube1/blyx-bittern.git
cd blyx-bittern
blyxc native-run project.blyx -- "1,2,5" "1,2" "10,20" "10,20" 0

Why this framework exists

A version number can match even when a previous migration changed. Check the applied prefix and recorded fingerprints before planning the next step. Flyway, schema history table

Install Bittern in your editor

Extension RahulChaube.blyx-bittern · 0.1.0

The extension includes a runnable Blyx example, function completions and the framework source. For the modular project, extract the starter, open its folder and run blyxc native-run main.blyx with the native toolchain installed.

Create an empty .blyx file, type blyx-bittern-demo and accept the completion. Choose Blyx: Run File to run the example.

For an offline installation, choose Extensions: Install from VSIX for Blyx Language first, then for Bittern.

Download the companion Blyx Language VSIX

Libraries in this framework

Install with Conda

Create an environment containing Bittern 0.1.0, its Blyx source and a runnable example. Run the second command with Blyx 0.2.1, Rust and a host linker installed.

conda create -y --prefix ./blyx-env --override-channels -c https://rahulchaube1.github.io/blyx-packages blyx-bittern=0.1.0=0
blyxc native-run ./blyx-env/share/blyx/bittern/main.blyx

To use this package in your application, copy share/blyx/bittern/vendor/bittern from the environment into your project's vendor directory.

Install the full collection with Homebrew or Scoop

Import into a Blyx project

Install Blyx 0.2.1, Rust 1.85 or newer and a host linker. From the directory containing your entry file, clone this tagged release.

git clone --depth 1 --branch v0.1.0 https://github.com/Rahulchaube1/blyx-bittern.git vendor/bittern

You can also download Bittern as a ZIP. Extract its contents into vendor/bittern.

Save this as main.blyx beside vendor and run blyxc native-run main.blyx.

use vendor::bittern::bittern;

fn main() {
    let available = [1, 2, 5];
    let applied = [1, 2];
    let expected = [10, 20];
    let actual = [10, 20];
    let dirty = 0.0;
    let result = bittern_preflight(available, applied, expected, actual, dirty);
    if len(result) == 0 { println!("invalid"); return; }
    let mut i = 0;
    while i < len(result) {
        println!(at(result, i));
        i += 1;
    }
}

Expected output

1
5
1
0

API and input requirements

Returns [can apply next, next available version, pending count, changed fingerprints]. This preflight consumes an exported history and executes no SQL. Invalid arguments and nonfinite results return an empty vector.

APIUse
bittern_preflight(available, applied, expected, actual, dirty)Returns [can apply next, next available version, pending count, changed fingerprints]. This preflight consumes an exported history and executes no SQL.

Develop and contribute

Open the tagged source to read the implementation and examples. Include the smallest reproducible Blyx program, compiler version and expected result when reporting an issue.