valkurm

library1.2.7jsnpmunverified

MySQL/MariaDB migration tool for node. Version 1.2.7 provides a simple, file-based migration system for managing database schema changes. It supports up and down migrations using raw SQL files, with a tracking table to ensure idempotent runs. Compared to alternatives, it focuses on minimal configuration and direct SQL control. Released under MIT license, with sporadic updates.

database

npm install valkurm

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · VALKURM

valkurm

databasejavascriptv1.2.7

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Valkurm

✓ import Valkurm from 'valkurm'

✗ const Valkurm = require('valkurm')

ESM default export; CJS require returns the default export as the module.exports object.

Valkurm

✓ import { Valkurm } from 'valkurm'

✗ import Valkurm from 'valkurm'

If using named import, note that this package has a default export; the named export 'Valkurm' is not available. The correct named import is not defined. Use default import instead.

Shows how to create a connection, instantiate Valkurm with options, and run pending migrations from a directory.

import Valkurm from 'valkurm'; import mysql from 'mysql2/promise'; async function migrate() { const connection = await mysql.createConnection({ host: 'localhost', user: 'root', password: process.env.DB_PASSWORD }); const migrator = new Valkurm(connection, { directory: './migrations', tableName: 'migrations' }); await migrator.run(); console.log('Migrations complete!'); await connection.end(); } migrate();

Debug

Known issues

gotchaPackage uses mysql2 internally, not mysql. If you have mysql installed, Valkurm will still use its own mysql2 dependency.

fix

No action needed, but be aware that potential mysql version mismatches may affect connection pooling.

affects: >=1.0.0

deprecatedOption 'tableName' may be deprecated in future versions in favor of 'migrationsTable'

fix

Check latest documentation and migrate to 'migrationsTable' if available.

affects: >=1.0.0

gotchaMigrations must be .sql files with both 'up' and 'down' queries separated by '-- down' comment line.

fix

Ensure your migration files follow the required format.

affects: >=1.0.0

Errors

Common errors & fixes

Cannot find module 'valkurm'

Package not installed or import path incorrect.

fix

Run `npm install valkurm` and ensure you are importing correctly (use default import).

ER_NOT_SUPPORTED_AUTH_MODE: Client does not support authentication protocol requested by server

MySQL 8+ uses caching_sha2_password by default, not supported by mysql2.

fix

Alter user to use mysql_native_password: ALTER USER 'user'@'localhost' IDENTIFIED WITH mysql_native_password BY 'password';

Upgrade

Version history

1.2.7latest on npm

Audit

Dependencies

mysql2requiredrequired for MySQL database connections

Agent activity

24 hits · last 30 days

node