dm-aurora-rds v1.4.12

Welcome to dm-aurora-rds 👋

A Data Migration driver to run queries on an Aurora RDS instance.

Configuration

Parameters

The Aurora RDS driver accepts the following parameters as part of its configuration:

Example

const CloudFormationProcessor = require("dm-processor-cf");

module.exports = {
  defaultStage: "prod",
  migrationDirectory: "migrations",
  stages: {
    prod: {
      defaultParams: {
        region: "us-east-1",
        stack: "some-stack-name",
      },
      drivers: {
        auroraDriver: {
          driver: require("dm-aurora-rds"),
          params: {
            databaseSchema: "some-schema",
            resourceArn: {
              processor: CloudFormationProcessor,
              params: {
                output: "AuroraArn",
              },
            },
            secretArn: {
              processor: CloudFormationProcessor,
              params: {
                output: "AuroraSecretArn",
              },
            },
          },
        },
      },
    },
  },
};

Methods

query

Executes a query against the database, returning a rxjs Observable

Arguments

Example

import { toArray } from "rxjs/operators";

export default {
  async up(context: ScriptContext, log: Logger) {
    const aurora = await context.getDriver<RdsDriver>("auroraDriver");
    const someTableResults = await aurora
      .query<SomeDataType>(`SELECT * FROM some_table`)
      .pipe(toArray())
      .toPromise();
  },
};