Class: Aws::RDSDataService::Types::ExecuteStatementRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb

Overview

Note:

When making an API call, you may pass ExecuteStatementRequest data as a hash:

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

The request parameters represent the input of a request to run a SQL statement against a database.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#continue_after_timeoutBoolean

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.

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.

Returns:

  • (Boolean)


547
548
549
550
551
552
553
554
555
556
557
558
559
560
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 547

class ExecuteStatementRequest < Struct.new(
  :continue_after_timeout,
  :database,
  :include_result_metadata,
  :parameters,
  :resource_arn,
  :result_set_options,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#databaseString

The name of the database.

Returns:

  • (String)


547
548
549
550
551
552
553
554
555
556
557
558
559
560
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 547

class ExecuteStatementRequest < Struct.new(
  :continue_after_timeout,
  :database,
  :include_result_metadata,
  :parameters,
  :resource_arn,
  :result_set_options,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#include_result_metadataBoolean

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

Returns:

  • (Boolean)


547
548
549
550
551
552
553
554
555
556
557
558
559
560
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 547

class ExecuteStatementRequest < Struct.new(
  :continue_after_timeout,
  :database,
  :include_result_metadata,
  :parameters,
  :resource_arn,
  :result_set_options,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#parametersArray<Types::SqlParameter>

The parameters for the SQL statement.

Array parameters are not supported.

Returns:



547
548
549
550
551
552
553
554
555
556
557
558
559
560
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 547

class ExecuteStatementRequest < Struct.new(
  :continue_after_timeout,
  :database,
  :include_result_metadata,
  :parameters,
  :resource_arn,
  :result_set_options,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arnString

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

Returns:

  • (String)


547
548
549
550
551
552
553
554
555
556
557
558
559
560
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 547

class ExecuteStatementRequest < Struct.new(
  :continue_after_timeout,
  :database,
  :include_result_metadata,
  :parameters,
  :resource_arn,
  :result_set_options,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#result_set_optionsTypes::ResultSetOptions

Options that control how the result set is returned.



547
548
549
550
551
552
553
554
555
556
557
558
559
560
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 547

class ExecuteStatementRequest < Struct.new(
  :continue_after_timeout,
  :database,
  :include_result_metadata,
  :parameters,
  :resource_arn,
  :result_set_options,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#schemaString

The name of the database schema.

Currently, the schema parameter isn't supported.

Returns:

  • (String)


547
548
549
550
551
552
553
554
555
556
557
558
559
560
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 547

class ExecuteStatementRequest < Struct.new(
  :continue_after_timeout,
  :database,
  :include_result_metadata,
  :parameters,
  :resource_arn,
  :result_set_options,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arnString

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

Returns:

  • (String)


547
548
549
550
551
552
553
554
555
556
557
558
559
560
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 547

class ExecuteStatementRequest < Struct.new(
  :continue_after_timeout,
  :database,
  :include_result_metadata,
  :parameters,
  :resource_arn,
  :result_set_options,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#sqlString

The SQL statement to run.

Returns:

  • (String)


547
548
549
550
551
552
553
554
555
556
557
558
559
560
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 547

class ExecuteStatementRequest < Struct.new(
  :continue_after_timeout,
  :database,
  :include_result_metadata,
  :parameters,
  :resource_arn,
  :result_set_options,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end

#transaction_idString

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:

  • (String)


547
548
549
550
551
552
553
554
555
556
557
558
559
560
# File 'gems/aws-sdk-rdsdataservice/lib/aws-sdk-rdsdataservice/types.rb', line 547

class ExecuteStatementRequest < Struct.new(
  :continue_after_timeout,
  :database,
  :include_result_metadata,
  :parameters,
  :resource_arn,
  :result_set_options,
  :schema,
  :secret_arn,
  :sql,
  :transaction_id)
  SENSITIVE = []
  include Aws::Structure
end