Class: Aws::RDSDataService::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
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

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements ‘Aws::CredentialProvider`, or instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting `ENV` to `true`.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: ‘sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV` or in shared config as `auth_scheme_preference`, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and `adaptive` retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When ‘true`, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at ‘HOME/.aws/credentials`. When not specified, ’default’ is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - A retry mode that includes all the functionality of `standard` mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements ‘Aws::TokenProvider`, or instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::RDSDataService::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::RDSDataService::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



471
472
473
 
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 471

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. 



1080
1081
1082
 
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 1080

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. 



1083
1084
1085
 
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 1083

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.

<note markdown=“1”> 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.

There isn't a fixed upper limit on the number of parameter sets.

However, the maximum size of the HTTP request submitted through the Data API is 4 MiB. If the request exceeds this limit, the Data API returns an error and doesn’t process the request. This 4-MiB limit includes the size of the HTTP headers and the JSON notation in the request. Thus, the number of parameter sets that you can include depends on a combination of factors, such as the size of the SQL statement and the size of each parameter set.

The response size limit is 1 MiB. If the call returns more than 1 MiB

of response data, the call is terminated.

</note>

Examples:

Request syntax with placeholder values


resp = client.batch_execute_statement({
  resource_arn: "Arn", # required
  secret_arn: "Arn", # required
  sql: "SqlStatement", # required
  database: "DbName",
  schema: "DbName",
  parameter_sets: [
    [
      {
        name: "ParameterName",
        value: {
          is_null: false,
          boolean_value: false,
          long_value: 1,
          double_value: 1.0,
          string_value: "String",
          blob_value: "data",
          array_value: {
            boolean_values: [false],
            long_values: [1],
            double_values: [1.0],
            string_values: ["String"],
            array_values: [
              {
                # recursive ArrayValue
              },
            ],
          },
        },
        type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
      },
    ],
  ],
  transaction_id: "Id",
})

Response structure


resp.update_results #=> Array
resp.update_results[0].generated_fields #=> Array
resp.update_results[0].generated_fields[0].is_null #=> Boolean
resp.update_results[0].generated_fields[0].boolean_value #=> Boolean
resp.update_results[0].generated_fields[0].long_value #=> Integer
resp.update_results[0].generated_fields[0].double_value #=> Float
resp.update_results[0].generated_fields[0].string_value #=> String
resp.update_results[0].generated_fields[0].blob_value #=> String
resp.update_results[0].generated_fields[0].array_value.boolean_values #=> Array
resp.update_results[0].generated_fields[0].array_value.boolean_values[0] #=> Boolean
resp.update_results[0].generated_fields[0].array_value.long_values #=> Array
resp.update_results[0].generated_fields[0].array_value.long_values[0] #=> Integer
resp.update_results[0].generated_fields[0].array_value.double_values #=> Array
resp.update_results[0].generated_fields[0].array_value.double_values[0] #=> Float
resp.update_results[0].generated_fields[0].array_value.string_values #=> Array
resp.update_results[0].generated_fields[0].array_value.string_values[0] #=> String
resp.update_results[0].generated_fields[0].array_value.array_values #=> Array
resp.update_results[0].generated_fields[0].array_value.array_values[0] #=> Types::ArrayValue

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

  • :secret_arn (required, String) —

    The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.

    For information about creating the secret, see [Create a database secret].

    [1]: docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html

  • :sql (required, String) —

    The SQL statement to run. Don’t include a semicolon (;) at the end of the SQL statement.

  • :database (String) —

    The name of the database.

  • :schema (String) —

    The name of the database schema.

    <note markdown=“1”> Currently, the ‘schema` parameter isn’t supported.

    </note>
  • :parameter_sets (Array<Array>) —

    The parameter set for the batch operation.

    The SQL statement is executed as many times as the number of parameter sets provided. To execute a SQL statement with no parameters, use one of the following options:

    • Specify one or more empty parameter sets.

    • Use the ‘ExecuteStatement` operation instead of the `BatchExecuteStatement` operation.

    <note markdown=“1”> Array parameters are not supported.

    </note>
  • :transaction_id (String) —

    The identifier of a transaction that was started by using the ‘BeginTransaction` operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.

    If the SQL statement is not part of a transaction, don’t set this parameter.

Returns:

See Also:



621
622
623
624
 
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 621

def batch_execute_statement(params = {}, options = {})
  req = build_request(:batch_execute_statement, params)
  req.send_request(options)
end

#begin_transaction(params = {}) ⇒ Types::BeginTransactionResponse

Starts a SQL transaction.

<note markdown=“1”> A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours.

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.

For Aurora MySQL, DDL statements inside a transaction cause an

implicit commit. We recommend that you run each MySQL DDL statement in a separate ‘ExecuteStatement` call with `continueAfterTimeout` enabled.

</note>

Examples:

Request syntax with placeholder values


resp = client.begin_transaction({
  resource_arn: "Arn", # required
  secret_arn: "Arn", # required
  database: "DbName",
  schema: "DbName",
})

Response structure


resp.transaction_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

  • :secret_arn (required, String) —

    The name or ARN of the secret that enables access to the DB cluster.

  • :database (String) —

    The name of the database.

  • :schema (String) —

    The name of the database schema.

Returns:

See Also:



675
676
677
678
 
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 675

def begin_transaction(params = {}, options = {})
  req = build_request(:begin_transaction, params)
  req.send_request(options)
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.

Parameters:

  • params ({}) (defaults to: {}) 


1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
 
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 1053

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::RDSDataService')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-rdsdataservice'
  context[:gem_version] = '1.87.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.

Examples:

Request syntax with placeholder values


resp = client.commit_transaction({
  resource_arn: "Arn", # required
  secret_arn: "Arn", # required
  transaction_id: "Id", # required
})

Response structure


resp.transaction_status #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

  • :secret_arn (required, String) —

    The name or ARN of the secret that enables access to the DB cluster.

  • :transaction_id (required, String) —

    The identifier of the transaction to end and commit.

Returns:

See Also:



712
713
714
715
 
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 712

def commit_transaction(params = {}, options = {})
  req = build_request(:commit_transaction, params)
  req.send_request(options)
end

#execute_sql(params = {}) ⇒ Types::ExecuteSqlResponse

Runs one or more SQL statements.

<note markdown=“1”> This operation isn’t supported for Aurora Serverless v2 and provisioned DB clusters. For Aurora Serverless v1 DB clusters, the operation is deprecated. Use the ‘BatchExecuteStatement` or `ExecuteStatement` operation.

</note>

Examples:

Request syntax with placeholder values


resp = client.execute_sql({
  db_cluster_or_instance_arn: "Arn", # required
  aws_secret_store_arn: "Arn", # required
  sql_statements: "SqlStatement", # required
  database: "DbName",
  schema: "DbName",
})

Response structure


resp.sql_statement_results #=> Array
resp.sql_statement_results[0].result_frame.result_set_metadata.column_count #=> Integer
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata #=> Array
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].name #=> String
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].type #=> Integer
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].type_name #=> String
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].label #=> String
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].schema_name #=> String
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].table_name #=> String
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_auto_increment #=> Boolean
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_signed #=> Boolean
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_currency #=> Boolean
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_case_sensitive #=> Boolean
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].nullable #=> Integer
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].precision #=> Integer
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].scale #=> Integer
resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].array_base_column_type #=> Integer
resp.sql_statement_results[0].result_frame.records #=> Array
resp.sql_statement_results[0].result_frame.records[0].values #=> Array
resp.sql_statement_results[0].result_frame.records[0].values[0].is_null #=> Boolean
resp.sql_statement_results[0].result_frame.records[0].values[0].bit_value #=> Boolean
resp.sql_statement_results[0].result_frame.records[0].values[0].big_int_value #=> Integer
resp.sql_statement_results[0].result_frame.records[0].values[0].int_value #=> Integer
resp.sql_statement_results[0].result_frame.records[0].values[0].double_value #=> Float
resp.sql_statement_results[0].result_frame.records[0].values[0].real_value #=> Float
resp.sql_statement_results[0].result_frame.records[0].values[0].string_value #=> String
resp.sql_statement_results[0].result_frame.records[0].values[0].blob_value #=> String
resp.sql_statement_results[0].result_frame.records[0].values[0].array_values #=> Array
resp.sql_statement_results[0].result_frame.records[0].values[0].array_values[0] #=> Types::Value
resp.sql_statement_results[0].result_frame.records[0].values[0].struct_value.attributes #=> Array
resp.sql_statement_results[0].result_frame.records[0].values[0].struct_value.attributes[0] #=> Types::Value
resp.sql_statement_results[0].number_of_records_updated #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :db_cluster_or_instance_arn (required, String) —

    The ARN of the Aurora Serverless DB cluster.

  • :aws_secret_store_arn (required, String) —

    The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.

    For information about creating the secret, see [Create a database secret].

    [1]: docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html

  • :sql_statements (required, String) —

    One or more SQL statements to run on the DB cluster.

    You can separate SQL statements from each other with a semicolon (;). Any valid SQL statement is permitted, including data definition, data manipulation, and commit statements.

  • :database (String) —

    The name of the database.

  • :schema (String) —

    The name of the database schema.

Returns:

See Also:



807
808
809
810
 
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 807

def execute_sql(params = {}, options = {})
  req = build_request(:execute_sql, params)
  req.send_request(options)
end

#execute_statement(params = {}) ⇒ Types::ExecuteStatementResponse

Runs a SQL statement against a database.

<note markdown=“1”> 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.

If the binary response data from the database is more than 1 MB, the

call is terminated.

</note>

Examples:

Request syntax with placeholder values


resp = client.execute_statement({
  resource_arn: "Arn", # required
  secret_arn: "Arn", # required
  sql: "SqlStatement", # required
  database: "DbName",
  schema: "DbName",
  parameters: [
    {
      name: "ParameterName",
      value: {
        is_null: false,
        boolean_value: false,
        long_value: 1,
        double_value: 1.0,
        string_value: "String",
        blob_value: "data",
        array_value: {
          boolean_values: [false],
          long_values: [1],
          double_values: [1.0],
          string_values: ["String"],
          array_values: [
            {
              # recursive ArrayValue
            },
          ],
        },
      },
      type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
    },
  ],
  transaction_id: "Id",
  include_result_metadata: false,
  continue_after_timeout: false,
  result_set_options: {
    decimal_return_type: "STRING", # accepts STRING, DOUBLE_OR_LONG
    long_return_type: "STRING", # accepts STRING, LONG
  },
  format_records_as: "NONE", # accepts NONE, JSON
})

Response structure


resp.records #=> Array
resp.records[0] #=> Array
resp.records[0][0].is_null #=> Boolean
resp.records[0][0].boolean_value #=> Boolean
resp.records[0][0].long_value #=> Integer
resp.records[0][0].double_value #=> Float
resp.records[0][0].string_value #=> String
resp.records[0][0].blob_value #=> String
resp.records[0][0].array_value.boolean_values #=> Array
resp.records[0][0].array_value.boolean_values[0] #=> Boolean
resp.records[0][0].array_value.long_values #=> Array
resp.records[0][0].array_value.long_values[0] #=> Integer
resp.records[0][0].array_value.double_values #=> Array
resp.records[0][0].array_value.double_values[0] #=> Float
resp.records[0][0].array_value.string_values #=> Array
resp.records[0][0].array_value.string_values[0] #=> String
resp.records[0][0].array_value.array_values #=> Array
resp.records[0][0].array_value.array_values[0] #=> Types::ArrayValue
resp.column_metadata #=> Array
resp.column_metadata[0].name #=> String
resp.column_metadata[0].type #=> Integer
resp.column_metadata[0].type_name #=> String
resp.column_metadata[0].label #=> String
resp.column_metadata[0].schema_name #=> String
resp.column_metadata[0].table_name #=> String
resp.column_metadata[0].is_auto_increment #=> Boolean
resp.column_metadata[0].is_signed #=> Boolean
resp.column_metadata[0].is_currency #=> Boolean
resp.column_metadata[0].is_case_sensitive #=> Boolean
resp.column_metadata[0].nullable #=> Integer
resp.column_metadata[0].precision #=> Integer
resp.column_metadata[0].scale #=> Integer
resp.column_metadata[0].array_base_column_type #=> Integer
resp.number_of_records_updated #=> Integer
resp.generated_fields #=> Array
resp.generated_fields[0].is_null #=> Boolean
resp.generated_fields[0].boolean_value #=> Boolean
resp.generated_fields[0].long_value #=> Integer
resp.generated_fields[0].double_value #=> Float
resp.generated_fields[0].string_value #=> String
resp.generated_fields[0].blob_value #=> String
resp.generated_fields[0].array_value.boolean_values #=> Array
resp.generated_fields[0].array_value.boolean_values[0] #=> Boolean
resp.generated_fields[0].array_value.long_values #=> Array
resp.generated_fields[0].array_value.long_values[0] #=> Integer
resp.generated_fields[0].array_value.double_values #=> Array
resp.generated_fields[0].array_value.double_values[0] #=> Float
resp.generated_fields[0].array_value.string_values #=> Array
resp.generated_fields[0].array_value.string_values[0] #=> String
resp.generated_fields[0].array_value.array_values #=> Array
resp.generated_fields[0].array_value.array_values[0] #=> Types::ArrayValue
resp.formatted_records #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

  • :secret_arn (required, String) —

    The ARN of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.

    For information about creating the secret, see [Create a database secret].

    [1]: docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html

  • :sql (required, String) —

    The SQL statement to run.

  • :database (String) —

    The name of the database.

  • :schema (String) —

    The name of the database schema.

    <note markdown=“1”> Currently, the ‘schema` parameter isn’t supported.

    </note>
  • :parameters (Array<Types::SqlParameter>) —

    The parameters for the SQL statement.

    <note markdown=“1”> Array parameters are not supported.

    </note>
  • :transaction_id (String) —

    The identifier of a transaction that was started by using the ‘BeginTransaction` operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.

    If the SQL statement is not part of a transaction, don’t set this parameter.

  • :include_result_metadata (Boolean) —

    A value that indicates whether to include metadata in the results.

  • :continue_after_timeout (Boolean) —

    A value that indicates whether to continue running the statement after the call times out. By default, the statement stops running when the call times out.

    <note markdown=“1”> For DDL statements, we recommend continuing to run the statement after the call times out. When a DDL statement terminates before it is finished running, it can result in errors and possibly corrupted data structures.

    </note>
  • :result_set_options (Types::ResultSetOptions) —

    Options that control how the result set is returned.

  • :format_records_as (String) —

    A value that indicates whether to format the result set as a single JSON string. This parameter only applies to ‘SELECT` statements and is ignored for other types of statements. Allowed values are `NONE` and `JSON`. The default value is `NONE`. The result is returned in the `formattedRecords` field.

    For usage information about the JSON format for result sets, see

    Using the Data API][1

    in the *Amazon Aurora User Guide*.

    [1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html

Returns:

See Also:



1007
1008
1009
1010
 
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 1007

def execute_statement(params = {}, options = {})
  req = build_request(:execute_statement, params)
  req.send_request(options)
end

#rollback_transaction(params = {}) ⇒ Types::RollbackTransactionResponse

Performs a rollback of a transaction. Rolling back a transaction cancels its changes.

Examples:

Request syntax with placeholder values


resp = client.rollback_transaction({
  resource_arn: "Arn", # required
  secret_arn: "Arn", # required
  transaction_id: "Id", # required
})

Response structure


resp.transaction_status #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

  • :secret_arn (required, String) —

    The name or ARN of the secret that enables access to the DB cluster.

  • :transaction_id (required, String) —

    The identifier of the transaction to roll back.

Returns:

See Also:



1044
1045
1046
1047
 
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 1044

def rollback_transaction(params = {}, options = {})
  req = build_request(:rollback_transaction, params)
  req.send_request(options)
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.

Deprecated. 


1073
1074
1075
 
# File 'lib/aws-sdk-rdsdataservice/client.rb', line 1073

def waiter_names
  []
end