Class: Aws::RDSDataService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::RDSDataService::Client
- Includes:
- ClientStubs
- Defined in:
- 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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
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.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
309 310 311 |
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 309 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
828 829 830 |
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 828 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
831 832 833 |
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 831 def errors_module Errors 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.
432 433 434 435 |
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 432 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>
474 475 476 477 |
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 474 def begin_transaction(params = {}, = {}) req = build_request(:begin_transaction, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
806 807 808 809 810 811 812 813 814 815 816 817 |
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 806 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-rdsdataservice' context[:gem_version] = '1.20.0' Seahorse::Client::Request.new(handlers, context) end |
#commit_transaction(params = {}) ⇒ Types::CommitTransactionResponse
Ends a SQL transaction started with the ‘BeginTransaction` operation and commits the changes.
511 512 513 514 |
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 511 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.
594 595 596 597 |
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 594 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.
760 761 762 763 |
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 760 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.
797 798 799 800 |
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 797 def rollback_transaction(params = {}, = {}) req = build_request(:rollback_transaction, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
821 822 823 |
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 821 def waiter_names [] end |