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:
Name | Type | Required | Description |
---|---|---|---|
region | string | Yes | The AWS Region where this table exists |
resourceArn | string | Yes | ARN of the Aruora RDS cluster |
secretArn | string | Yes | ARN of the secret manager secret to use for database credentials |
databaseSchema | string | No | The database schema to connect to by default |
Example
const CloudFormationProcessor = ; moduleexports = defaultStage: "prod" migrationDirectory: "migrations" stages: prod: defaultParams: region: "us-east-1" stack: "some-stack-name" drivers: auroraDriver: driver: 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
Name | Description |
---|---|
query | The query string to be executed |
parameters | An array of AWS.RDSDataService.SqlParameter s that will be used in the query |
options | A QueryOptions object |
Example
; ;