@aws-sdk/client-rds-data
Advanced tools
AWS SDK for JavaScript Rds Data Client for Node.js, Browser and React Native
@aws-sdk/client-rds-data is an AWS SDK for JavaScript package that allows you to interact with Amazon RDS Data Service. This service enables you to run SQL statements on Amazon Aurora Serverless clusters through a secure HTTP endpoint without managing database connections.
Execute SQL Statements
This feature allows you to execute SQL statements on your Amazon Aurora Serverless cluster. The code sample demonstrates how to set up the client, define the parameters, and execute a SQL statement to retrieve data from a table.
const { RDSDataClient, ExecuteStatementCommand } = require('@aws-sdk/client-rds-data');
const client = new RDSDataClient({ region: 'us-west-2' });
const params = {
resourceArn: 'arn:aws:rds:us-west-2:123456789012:cluster:my-aurora-cluster',
secretArn: 'arn:aws:secretsmanager:us-west-2:123456789012:secret:my-secret',
sql: 'SELECT * FROM my_table',
database: 'my_database'
};
const run = async () => {
try {
const data = await client.send(new ExecuteStatementCommand(params));
console.log(data);
} catch (err) {
console.error(err);
}
};
run();Batch Execute SQL Statements
This feature allows you to execute a batch of SQL statements in a single request. The code sample demonstrates how to set up the client, define the parameters, and execute multiple SQL insert statements in a batch.
const { RDSDataClient, BatchExecuteStatementCommand } = require('@aws-sdk/client-rds-data');
const client = new RDSDataClient({ region: 'us-west-2' });
const params = {
resourceArn: 'arn:aws:rds:us-west-2:123456789012:cluster:my-aurora-cluster',
secretArn: 'arn:aws:secretsmanager:us-west-2:123456789012:secret:my-secret',
sql: 'INSERT INTO my_table (id, name) VALUES (:id, :name)',
database: 'my_database',
parameterSets: [
[
{ name: 'id', value: { longValue: 1 } },
{ name: 'name', value: { stringValue: 'John' } }
],
[
{ name: 'id', value: { longValue: 2 } },
{ name: 'name', value: { stringValue: 'Jane' } }
]
]
};
const run = async () => {
try {
const data = await client.send(new BatchExecuteStatementCommand(params));
console.log(data);
} catch (err) {
console.error(err);
}
};
run();Begin Transaction
This feature allows you to begin a new transaction. The code sample demonstrates how to set up the client, define the parameters, and begin a transaction on your Amazon Aurora Serverless cluster.
const { RDSDataClient, BeginTransactionCommand } = require('@aws-sdk/client-rds-data');
const client = new RDSDataClient({ region: 'us-west-2' });
const params = {
resourceArn: 'arn:aws:rds:us-west-2:123456789012:cluster:my-aurora-cluster',
secretArn: 'arn:aws:secretsmanager:us-west-2:123456789012:secret:my-secret',
database: 'my_database'
};
const run = async () => {
try {
const data = await client.send(new BeginTransactionCommand(params));
console.log(data);
} catch (err) {
console.error(err);
}
};
run();Commit Transaction
This feature allows you to commit a transaction. The code sample demonstrates how to set up the client, define the parameters, and commit a transaction on your Amazon Aurora Serverless cluster.
const { RDSDataClient, CommitTransactionCommand } = require('@aws-sdk/client-rds-data');
const client = new RDSDataClient({ region: 'us-west-2' });
const params = {
resourceArn: 'arn:aws:rds:us-west-2:123456789012:cluster:my-aurora-cluster',
secretArn: 'arn:aws:secretsmanager:us-west-2:123456789012:secret:my-secret',
transactionId: 'your-transaction-id'
};
const run = async () => {
try {
const data = await client.send(new CommitTransactionCommand(params));
console.log(data);
} catch (err) {
console.error(err);
}
};
run();Rollback Transaction
This feature allows you to roll back a transaction. The code sample demonstrates how to set up the client, define the parameters, and roll back a transaction on your Amazon Aurora Serverless cluster.
const { RDSDataClient, RollbackTransactionCommand } = require('@aws-sdk/client-rds-data');
const client = new RDSDataClient({ region: 'us-west-2' });
const params = {
resourceArn: 'arn:aws:rds:us-west-2:123456789012:cluster:my-aurora-cluster',
secretArn: 'arn:aws:secretsmanager:us-west-2:123456789012:secret:my-secret',
transactionId: 'your-transaction-id'
};
const run = async () => {
try {
const data = await client.send(new RollbackTransactionCommand(params));
console.log(data);
} catch (err) {
console.error(err);
}
};
run();The 'mysql' package is a popular Node.js client for MySQL databases. It allows you to connect to a MySQL database, execute queries, and manage transactions. Unlike @aws-sdk/client-rds-data, it requires you to manage database connections and is not specific to AWS services.
The 'pg' package is a PostgreSQL client for Node.js. It provides a way to connect to PostgreSQL databases, execute SQL queries, and handle transactions. Similar to the 'mysql' package, it requires manual connection management and is not tailored for AWS services.
Sequelize is a promise-based Node.js ORM for various SQL databases, including MySQL, PostgreSQL, and SQLite. It provides a higher-level abstraction for database operations, including model definitions and query building. Unlike @aws-sdk/client-rds-data, it is not specific to AWS and offers more advanced ORM features.
Knex.js is a SQL query builder for Node.js that supports multiple database types, including MySQL, PostgreSQL, and SQLite. It provides a flexible and powerful way to build and execute SQL queries. Unlike @aws-sdk/client-rds-data, it is not specific to AWS and requires manual connection management.
AWS SDK for JavaScript RDSData Client for Node.js, Browser and React Native.
RDS Data API
Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora DB cluster. To run these statements, you use the RDS Data API (Data API).
Data API is available with the following types of Aurora databases:
Aurora PostgreSQL - Serverless v2, provisioned, and Serverless v1
Aurora MySQL - Serverless v2, provisioned, and Serverless v1
For more information about the Data API, see Using RDS Data API in the Amazon Aurora User Guide.
To install this package, simply type add or install @aws-sdk/client-rds-data using your favorite package manager:
npm install @aws-sdk/client-rds-datayarn add @aws-sdk/client-rds-datapnpm add @aws-sdk/client-rds-dataThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the RDSDataClient and
the commands you need, for example BeginTransactionCommand:
// ES5 example
const { RDSDataClient, BeginTransactionCommand } = require("@aws-sdk/client-rds-data");
// ES6+ example
import { RDSDataClient, BeginTransactionCommand } from "@aws-sdk/client-rds-data";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new RDSDataClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new BeginTransactionCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-rds-data";
const client = new AWS.RDSData({ region: "REGION" });
// async/await.
try {
const data = await client.beginTransaction(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.beginTransaction(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.beginTransaction(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-rds-data package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
FAQs
AWS SDK for JavaScript Rds Data Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-rds-data receives a total of 190,067 weekly downloads. As such, @aws-sdk/client-rds-data popularity was classified as popular.
We found that @aws-sdk/client-rds-data demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.