Class: Aws::RDSDataService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::RDSDataService::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/client.rb
Overview
An API client for RDSDataService. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::RDSDataService::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_execute_statement(params = {}) ⇒ Types::BatchExecuteStatementResponse
Runs a batch SQL statement over an array of data.
-
#begin_transaction(params = {}) ⇒ Types::BeginTransactionResponse
Starts a SQL transaction.
-
#commit_transaction(params = {}) ⇒ Types::CommitTransactionResponse
Ends a SQL transaction started with the
BeginTransaction
operation and commits the changes. -
#execute_sql(params = {}) ⇒ Types::ExecuteSqlResponse
Runs one or more SQL statements.
-
#execute_statement(params = {}) ⇒ Types::ExecuteStatementResponse
Runs a SQL statement against a database.
-
#rollback_transaction(params = {}) ⇒ Types::RollbackTransactionResponse
Performs a rollback of a transaction.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
324 325 326 |
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/client.rb', line 324 def initialize(*args) super end |
Instance Method Details
#batch_execute_statement(params = {}) ⇒ Types::BatchExecuteStatementResponse
Runs a batch SQL statement over an array of data.
You can run bulk update and insert operations for multiple records using a DML statement with different parameter sets. Bulk operations can provide a significant performance improvement over individual insert and update operations.
If a call isn't part of a transaction because it doesn't include the
transactionID
parameter, changes that result from the call are
committed automatically.
447 448 449 450 |
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/client.rb', line 447 def batch_execute_statement(params = {}, = {}) req = build_request(:batch_execute_statement, params) req.send_request() end |
#begin_transaction(params = {}) ⇒ Types::BeginTransactionResponse
Starts a SQL transaction.
<important> <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours.</p> <p>A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's committed, it's rolled back automatically.</p> <p>DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate <code>ExecuteStatement</code> call with <code>continueAfterTimeout</code> enabled.</p> </important>
489 490 491 492 |
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/client.rb', line 489 def begin_transaction(params = {}, = {}) req = build_request(:begin_transaction, params) req.send_request() end |
#commit_transaction(params = {}) ⇒ Types::CommitTransactionResponse
Ends a SQL transaction started with the BeginTransaction
operation
and commits the changes.
526 527 528 529 |
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/client.rb', line 526 def commit_transaction(params = {}, = {}) req = build_request(:commit_transaction, params) req.send_request() end |
#execute_sql(params = {}) ⇒ Types::ExecuteSqlResponse
Runs one or more SQL statements.
This operation is deprecated. Use the BatchExecuteStatement
or
ExecuteStatement
operation.
609 610 611 612 |
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/client.rb', line 609 def execute_sql(params = {}, = {}) req = build_request(:execute_sql, params) req.send_request() end |
#execute_statement(params = {}) ⇒ Types::ExecuteStatementResponse
Runs a SQL statement against a database.
If a call isn't part of a transaction because it doesn't include the
transactionID
parameter, changes that result from the call are
committed automatically.
The response size limit is 1 MB. If the call returns more than 1 MB of response data, the call is terminated.
775 776 777 778 |
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/client.rb', line 775 def execute_statement(params = {}, = {}) req = build_request(:execute_statement, params) req.send_request() end |
#rollback_transaction(params = {}) ⇒ Types::RollbackTransactionResponse
Performs a rollback of a transaction. Rolling back a transaction cancels its changes.
812 813 814 815 |
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/client.rb', line 812 def rollback_transaction(params = {}, = {}) req = build_request(:rollback_transaction, params) req.send_request() end |