NAME

Paws::RDSData::ExecuteStatement - Arguments for method ExecuteStatement on Paws::RDSData

DESCRIPTION

This class represents the parameters used for calling the method ExecuteStatement on the AWS RDS DataService service. Use the attributes of this class as arguments to method ExecuteStatement.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ExecuteStatement.

SYNOPSIS

    my $rds-data = Paws->service('RDSData');
    my $ExecuteStatementResponse = $rds -data->ExecuteStatement(
      ResourceArn           => 'MyArn',
      SecretArn             => 'MyArn',
      Sql                   => 'MySqlStatement',
      ContinueAfterTimeout  => 1,                  # OPTIONAL
      Database              => 'MyDbName',         # OPTIONAL
      IncludeResultMetadata => 1,                  # OPTIONAL
      Parameters            => [
        {
          Name     => 'MyParameterName',    # OPTIONAL
          TypeHint => 'JSON'
          ,    # values: JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL; OPTIONAL
          Value => {
            ArrayValue => {
              ArrayValues   => [ <ArrayValue>, ... ],    # OPTIONAL
              BooleanValues => [ 1,            ... ],    # OPTIONAL
              DoubleValues  => [ 1,            ... ],    # OPTIONAL
              LongValues    => [ 1,            ... ],    # OPTIONAL
              StringValues  => [ 'MyString',   ... ],    # OPTIONAL
            },    # OPTIONAL
            BlobValue    => 'BlobBlob',    # OPTIONAL
            BooleanValue => 1,
            DoubleValue  => 1,
            IsNull       => 1,
            LongValue    => 1,
            StringValue  => 'MyString',
          },    # OPTIONAL
        },
        ...
      ],    # OPTIONAL
      ResultSetOptions => {
        DecimalReturnType =>
          'STRING',    # values: STRING, DOUBLE_OR_LONG; OPTIONAL
      },    # OPTIONAL
      Schema        => 'MyDbName',    # OPTIONAL
      TransactionId => 'MyId',        # OPTIONAL
    );

    # Results:
    my $ColumnMetadata  = $ExecuteStatementResponse->ColumnMetadata;
    my $GeneratedFields = $ExecuteStatementResponse->GeneratedFields;
    my $NumberOfRecordsUpdated =
      $ExecuteStatementResponse->NumberOfRecordsUpdated;
    my $Records = $ExecuteStatementResponse->Records;

    # Returns a L<Paws::RDSData::ExecuteStatementResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/rds-data/ExecuteStatement

ATTRIBUTES

ContinueAfterTimeout => Bool

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.

Database => Str

The name of the database.

IncludeResultMetadata => Bool

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

Parameters => ArrayRef[Paws::RDSData::SqlParameter]

The parameters for the SQL statement.

Array parameters are not supported.

REQUIRED ResourceArn => Str

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

ResultSetOptions => Paws::RDSData::ResultSetOptions

Options that control how the result set is returned.

Schema => Str

The name of the database schema.

Currently, the schema parameter isn't supported.

REQUIRED SecretArn => Str

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

REQUIRED Sql => Str

The SQL statement to run.

TransactionId => Str

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method ExecuteStatement in Paws::RDSData

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

cpanm Paws

perl -MCPAN -e shell
install Paws