Registry / devops / dm-tracker-dynamodb

dm-tracker-dynamodb

library1.5.14jsnpmunverified

A DynamoDB-backed tracker for the data-migration library, version 1.5.14. It integrates with data-migration to record which migration scripts have been executed in a DynamoDB table. Release cadence is irregular, primarily maintenance updates. Differentiator: leverages AWS DynamoDB for scalability and existing AWS credentials, supporting custom partition/sort keys and prefixes.

devops database

npm install dm-tracker-dynamodb

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · DM-TRACKER-DYNAMOD

dm-tracker-dynamodb

devopsjavascriptv1.5.14

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.

DynamoDbTracker

✓ import { DynamoDbTracker } from 'dm-tracker-dynamodb'

✗ const DynamoDbTracker = require('dm-tracker-dynamodb').default

ESM-only package; named export, no default export.

DynamoDbTrackerConfig

✓ import { DynamoDbTrackerConfig } from 'dm-tracker-dynamodb'

TypeScript users can import this interface for type-safe config.

DynamoDbTracker

✓ const { DynamoDbTracker } = require('dm-tracker-dynamodb')

✗ const DynamoDbTracker = require('dm-tracker-dynamodb')

CommonJS destructuring works; direct require returns module with named exports.

Shows how to import and instantiate DynamoDbTracker with minimum required config, then pass it to DataMigration.

import { DynamoDbTracker } from 'dm-tracker-dynamodb'; const tracker = new DynamoDbTracker({ region: 'us-east-1', TableName: 'migrations', partitionKeyName: 'type', sortKeyName: 'id', prefix: 'migration', accessKeyId: process.env.AWS_ACCESS_KEY_ID ?? '', secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY ?? '', }); // Use with data-migration import { DataMigration } from 'data-migration'; const migration = new DataMigration({ tracker }); await migration.run('./migrations');

Debug

Known issues

gotchaMissing required config properties (region, TableName, partitionKeyName, sortKeyName) will throw an error at runtime.

fix

Ensure all required parameters are provided in the constructor config object.

affects: >=1.0.0

gotchapackage is ESM-only; using require() without destructuring returns the entire module.exports object, causing 'DynamoDbTracker is not a constructor'.

fix

Use destructuring: const { DynamoDbTracker } = require('dm-tracker-dynamodb')

affects: >=1.0.0

deprecatedThe 'profile' config option is deprecated and will be removed in a future major version.

fix

Use accessKeyId and secretAccessKey or rely on default AWS credential chain instead.

affects: >=1.2.0

gotchaIf region is not provided and not in AWS config, the AWS SDK defaults to us-east-1 may cause unexpected behavior.

fix

Always specify region explicitly in config.

affects: >=1.0.0

Errors

Common errors & fixes

TypeError: DynamoDbTracker is not a constructor

CommonJS require used without destructuring, getting the module's exports object instead of the class.

fix

Use const { DynamoDbTracker } = require('dm-tracker-dynamodb');

ValidationError: Missing required parameter: TableName

Constructor called without TableName config property.

fix

Include TableName in the config object: new DynamoDbTracker({ TableName: 'my-table', ... })

CredentialsError: Missing credentials in config

No AWS credentials provided and default credential chain fails (e.g., no env vars, no ~/.aws/credentials).

fix

Provide accessKeyId and secretAccessKey in config, or configure AWS credentials via environment variables.

Upgrade

Version history

1.5.14latest on npm

Audit

Dependencies

data-migrationrequiredCore library; tracker plugin for data-migration framework.

Agent activity

27 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/theBenForce/data-migration ↗

packagedm-tracker-dynamodb ↗

homepagehttps://data-migration.js.org/plugins/trackers/dynamo ↗