« blib/lib/Paws/RDSData/ExecuteSqlResponse.pm
↑ Summary
blib/lib/Paws/RDSData/ExecuteStatementResponse.pm »
| 1 | |||
| 2 | package Paws::RDSData::ExecuteStatement; | ||
| 3 | use Moose; | ||
| 4 | has ContinueAfterTimeout => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'continueAfterTimeout'); | ||
| 5 | has Database => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'database'); | ||
| 6 | has IncludeResultMetadata => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'includeResultMetadata'); | ||
| 7 | has Parameters => (is => 'ro', isa => 'ArrayRef[Paws::RDSData::SqlParameter]', traits => ['NameInRequest'], request_name => 'parameters'); | ||
| 8 | has ResourceArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'resourceArn', required => 1); | ||
| 9 | has ResultSetOptions => (is => 'ro', isa => 'Paws::RDSData::ResultSetOptions', traits => ['NameInRequest'], request_name => 'resultSetOptions'); | ||
| 10 | has Schema => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'schema'); | ||
| 11 | has SecretArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'secretArn', required => 1); | ||
| 12 | has Sql => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'sql', required => 1); | ||
| 13 | has TransactionId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'transactionId'); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ExecuteStatement'); | ||
| 18 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/Execute'); | ||
| 19 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 20 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDSData::ExecuteStatementResponse'); | ||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::RDSData::ExecuteStatement - Arguments for method ExecuteStatement on L<Paws::RDSData> | ||
| 28 | |||
| 29 | =head1 DESCRIPTION | ||
| 30 | |||
| 31 | This class represents the parameters used for calling the method ExecuteStatement on the | ||
| 32 | L<AWS RDS DataService|Paws::RDSData> service. Use the attributes of this class | ||
| 33 | as arguments to method ExecuteStatement. | ||
| 34 | |||
| 35 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ExecuteStatement. | ||
| 36 | |||
| 37 | =head1 SYNOPSIS | ||
| 38 | |||
| 39 | my $rds-data = Paws->service('RDSData'); | ||
| 40 | my $ExecuteStatementResponse = $rds -data->ExecuteStatement( | ||
| 41 | ResourceArn => 'MyArn', | ||
| 42 | SecretArn => 'MyArn', | ||
| 43 | Sql => 'MySqlStatement', | ||
| 44 | ContinueAfterTimeout => 1, # OPTIONAL | ||
| 45 | Database => 'MyDbName', # OPTIONAL | ||
| 46 | IncludeResultMetadata => 1, # OPTIONAL | ||
| 47 | Parameters => [ | ||
| 48 | { | ||
| 49 | Name => 'MyParameterName', # OPTIONAL | ||
| 50 | TypeHint => 'JSON' | ||
| 51 | , # values: JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL; OPTIONAL | ||
| 52 | Value => { | ||
| 53 | ArrayValue => { | ||
| 54 | ArrayValues => [ <ArrayValue>, ... ], # OPTIONAL | ||
| 55 | BooleanValues => [ 1, ... ], # OPTIONAL | ||
| 56 | DoubleValues => [ 1, ... ], # OPTIONAL | ||
| 57 | LongValues => [ 1, ... ], # OPTIONAL | ||
| 58 | StringValues => [ 'MyString', ... ], # OPTIONAL | ||
| 59 | }, # OPTIONAL | ||
| 60 | BlobValue => 'BlobBlob', # OPTIONAL | ||
| 61 | BooleanValue => 1, | ||
| 62 | DoubleValue => 1, | ||
| 63 | IsNull => 1, | ||
| 64 | LongValue => 1, | ||
| 65 | StringValue => 'MyString', | ||
| 66 | }, # OPTIONAL | ||
| 67 | }, | ||
| 68 | ... | ||
| 69 | ], # OPTIONAL | ||
| 70 | ResultSetOptions => { | ||
| 71 | DecimalReturnType => | ||
| 72 | 'STRING', # values: STRING, DOUBLE_OR_LONG; OPTIONAL | ||
| 73 | }, # OPTIONAL | ||
| 74 | Schema => 'MyDbName', # OPTIONAL | ||
| 75 | TransactionId => 'MyId', # OPTIONAL | ||
| 76 | ); | ||
| 77 | |||
| 78 | # Results: | ||
| 79 | my $ColumnMetadata = $ExecuteStatementResponse->ColumnMetadata; | ||
| 80 | my $GeneratedFields = $ExecuteStatementResponse->GeneratedFields; | ||
| 81 | my $NumberOfRecordsUpdated = | ||
| 82 | $ExecuteStatementResponse->NumberOfRecordsUpdated; | ||
| 83 | my $Records = $ExecuteStatementResponse->Records; | ||
| 84 | |||
| 85 | # Returns a L<Paws::RDSData::ExecuteStatementResponse> object. | ||
| 86 | |||
| 87 | 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. | ||
| 88 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds-data/ExecuteStatement> | ||
| 89 | |||
| 90 | =head1 ATTRIBUTES | ||
| 91 | |||
| 92 | |||
| 93 | =head2 ContinueAfterTimeout => Bool | ||
| 94 | |||
| 95 | A value that indicates whether to continue running the statement after | ||
| 96 | the call times out. By default, the statement stops running when the | ||
| 97 | call times out. | ||
| 98 | |||
| 99 | For DDL statements, we recommend continuing to run the statement after | ||
| 100 | the call times out. When a DDL statement terminates before it is | ||
| 101 | finished running, it can result in errors and possibly corrupted data | ||
| 102 | structures. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 Database => Str | ||
| 107 | |||
| 108 | The name of the database. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 IncludeResultMetadata => Bool | ||
| 113 | |||
| 114 | A value that indicates whether to include metadata in the results. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 Parameters => ArrayRef[L<Paws::RDSData::SqlParameter>] | ||
| 119 | |||
| 120 | The parameters for the SQL statement. | ||
| 121 | |||
| 122 | Array parameters are not supported. | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head2 B<REQUIRED> ResourceArn => Str | ||
| 127 | |||
| 128 | The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster. | ||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | =head2 ResultSetOptions => L<Paws::RDSData::ResultSetOptions> | ||
| 133 | |||
| 134 | Options that control how the result set is returned. | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head2 Schema => Str | ||
| 139 | |||
| 140 | The name of the database schema. | ||
| 141 | |||
| 142 | Currently, the C<schema> parameter isn't supported. | ||
| 143 | |||
| 144 | |||
| 145 | |||
| 146 | =head2 B<REQUIRED> SecretArn => Str | ||
| 147 | |||
| 148 | The name or ARN of the secret that enables access to the DB cluster. | ||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head2 B<REQUIRED> Sql => Str | ||
| 153 | |||
| 154 | The SQL statement to run. | ||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | =head2 TransactionId => Str | ||
| 159 | |||
| 160 | The identifier of a transaction that was started by using the | ||
| 161 | C<BeginTransaction> operation. Specify the transaction ID of the | ||
| 162 | transaction that you want to include the SQL statement in. | ||
| 163 | |||
| 164 | If the SQL statement is not part of a transaction, don't set this | ||
| 165 | parameter. | ||
| 166 | |||
| 167 | |||
| 168 | |||
| 169 | |||
| 170 | =head1 SEE ALSO | ||
| 171 | |||
| 172 | This class forms part of L<Paws>, documenting arguments for method ExecuteStatement in L<Paws::RDSData> | ||
| 173 | |||
| 174 | =head1 BUGS and CONTRIBUTIONS | ||
| 175 | |||
| 176 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 177 | |||
| 178 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 179 | |||
| 180 | =cut | ||
| 181 |