Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.RDSData.BatchExecuteStatement

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

data BatchExecuteStatement = BatchExecuteStatement' {
- database :: Maybe Text
- parameterSets :: Maybe [[SqlParameter]]
- transactionId :: Maybe Text
- schema :: Maybe Text
- resourceArn :: Text
- secretArn :: Text
- sql :: Text
}
newBatchExecuteStatement :: Text -> Text -> Text -> BatchExecuteStatement
batchExecuteStatement_database :: Lens' BatchExecuteStatement (Maybe Text)
batchExecuteStatement_parameterSets :: Lens' BatchExecuteStatement (Maybe [[SqlParameter]])
batchExecuteStatement_transactionId :: Lens' BatchExecuteStatement (Maybe Text)
batchExecuteStatement_schema :: Lens' BatchExecuteStatement (Maybe Text)
batchExecuteStatement_resourceArn :: Lens' BatchExecuteStatement Text
batchExecuteStatement_secretArn :: Lens' BatchExecuteStatement Text
batchExecuteStatement_sql :: Lens' BatchExecuteStatement Text
data BatchExecuteStatementResponse = BatchExecuteStatementResponse' {
- updateResults :: Maybe [UpdateResult]
- httpStatus :: Int
}
newBatchExecuteStatementResponse :: Int -> BatchExecuteStatementResponse
batchExecuteStatementResponse_updateResults :: Lens' BatchExecuteStatementResponse (Maybe [UpdateResult])
batchExecuteStatementResponse_httpStatus :: Lens' BatchExecuteStatementResponse Int

Creating a Request

data BatchExecuteStatement Source #

The request parameters represent the input of a SQL statement over an array of data.

See: newBatchExecuteStatement smart constructor.

Constructors

BatchExecuteStatement'

Fields

database :: Maybe Text
The name of the database.
parameterSets :: Maybe [[SqlParameter]]
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.
Array parameters are not supported.
transactionId :: Maybe Text
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.
schema :: Maybe Text
The name of the database schema.
resourceArn :: Text
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
secretArn :: Text
The name or ARN of the secret that enables access to the DB cluster.
sql :: Text
The SQL statement to run.

Instances

Instances details

Eq BatchExecuteStatement Source #
Instance details Defined in Amazonka.RDSData.BatchExecuteStatement Methods (==) :: BatchExecuteStatement -> BatchExecuteStatement -> Bool # (/=) :: BatchExecuteStatement -> BatchExecuteStatement -> Bool #
Read BatchExecuteStatement Source #
Instance details Defined in Amazonka.RDSData.BatchExecuteStatement Methods readsPrec :: Int -> ReadS BatchExecuteStatement # readList :: ReadS [BatchExecuteStatement] # readPrec :: ReadPrec BatchExecuteStatement # readListPrec :: ReadPrec [BatchExecuteStatement] #
Show BatchExecuteStatement Source #
Instance details Defined in Amazonka.RDSData.BatchExecuteStatement Methods showsPrec :: Int -> BatchExecuteStatement -> ShowS # show :: BatchExecuteStatement -> String # showList :: [BatchExecuteStatement] -> ShowS #
Generic BatchExecuteStatement Source #
Instance details Defined in Amazonka.RDSData.BatchExecuteStatement Associated Types type Rep BatchExecuteStatement :: Type -> Type # Methods from :: BatchExecuteStatement -> Rep BatchExecuteStatement x # to :: Rep BatchExecuteStatement x -> BatchExecuteStatement #
NFData BatchExecuteStatement Source #
Instance details Defined in Amazonka.RDSData.BatchExecuteStatement Methods rnf :: BatchExecuteStatement -> () #
Hashable BatchExecuteStatement Source #
Instance details Defined in Amazonka.RDSData.BatchExecuteStatement Methods hashWithSalt :: Int -> BatchExecuteStatement -> Int # hash :: BatchExecuteStatement -> Int #
ToJSON BatchExecuteStatement Source #
Instance details Defined in Amazonka.RDSData.BatchExecuteStatement Methods toJSON :: BatchExecuteStatement -> Value # toEncoding :: BatchExecuteStatement -> Encoding # toJSONList :: [BatchExecuteStatement] -> Value # toEncodingList :: [BatchExecuteStatement] -> Encoding #
AWSRequest BatchExecuteStatement Source #
Instance details Defined in Amazonka.RDSData.BatchExecuteStatement Associated Types type AWSResponse BatchExecuteStatement # Methods request :: BatchExecuteStatement -> Request BatchExecuteStatement # response :: MonadResource m => Logger -> Service -> Proxy BatchExecuteStatement -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse BatchExecuteStatement))) #
ToHeaders BatchExecuteStatement Source #
Instance details Defined in Amazonka.RDSData.BatchExecuteStatement Methods toHeaders :: BatchExecuteStatement -> [Header] #
ToPath BatchExecuteStatement Source #
Instance details Defined in Amazonka.RDSData.BatchExecuteStatement Methods toPath :: BatchExecuteStatement -> ByteString #
ToQuery BatchExecuteStatement Source #
Instance details Defined in Amazonka.RDSData.BatchExecuteStatement Methods toQuery :: BatchExecuteStatement -> QueryString #
type Rep BatchExecuteStatement Source #
Instance details Defined in Amazonka.RDSData.BatchExecuteStatement type Rep BatchExecuteStatement = D1 ('MetaData "BatchExecuteStatement" "Amazonka.RDSData.BatchExecuteStatement" "libZSservicesZSamazonka-rds-dataZSamazonka-rds-data" 'False) (C1 ('MetaCons "BatchExecuteStatement'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "database") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "parameterSets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [[SqlParameter]])) :: S1 ('MetaSel ('Just "transactionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "sql") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse BatchExecuteStatement Source #
Instance details Defined in Amazonka.RDSData.BatchExecuteStatement type AWSResponse BatchExecuteStatement = BatchExecuteStatementResponse

newBatchExecuteStatement Source #

Arguments

:: Text	`$sel:resourceArn:BatchExecuteStatement'`
-> Text	`$sel:secretArn:BatchExecuteStatement'`
-> Text	`$sel:sql:BatchExecuteStatement'`
-> BatchExecuteStatement

Create a value of BatchExecuteStatement with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:database:BatchExecuteStatement', batchExecuteStatement_database - The name of the database.

$sel:parameterSets:BatchExecuteStatement', batchExecuteStatement_parameterSets - 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.

Array parameters are not supported.

$sel:transactionId:BatchExecuteStatement', batchExecuteStatement_transactionId - 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.

$sel:schema:BatchExecuteStatement', batchExecuteStatement_schema - The name of the database schema.

$sel:resourceArn:BatchExecuteStatement', batchExecuteStatement_resourceArn - The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

$sel:secretArn:BatchExecuteStatement', batchExecuteStatement_secretArn - The name or ARN of the secret that enables access to the DB cluster.

$sel:sql:BatchExecuteStatement', batchExecuteStatement_sql - The SQL statement to run.

Request Lenses

batchExecuteStatement_database :: Lens' BatchExecuteStatement (Maybe Text) Source #

The name of the database.

batchExecuteStatement_parameterSets :: Lens' BatchExecuteStatement (Maybe [[SqlParameter]]) Source #

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.

Array parameters are not supported.

batchExecuteStatement_transactionId :: Lens' BatchExecuteStatement (Maybe Text) Source #

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.

batchExecuteStatement_schema :: Lens' BatchExecuteStatement (Maybe Text) Source #

The name of the database schema.

batchExecuteStatement_resourceArn :: Lens' BatchExecuteStatement Text Source #

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

batchExecuteStatement_secretArn :: Lens' BatchExecuteStatement Text Source #

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

batchExecuteStatement_sql :: Lens' BatchExecuteStatement Text Source #

The SQL statement to run.

Destructuring the Response

data BatchExecuteStatementResponse Source #

The response elements represent the output of a SQL statement over an array of data.

See: newBatchExecuteStatementResponse smart constructor.

Constructors

BatchExecuteStatementResponse'
Fields updateResults :: Maybe [UpdateResult] The execution results of each batch entry. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq BatchExecuteStatementResponse Source #
Instance details Defined in Amazonka.RDSData.BatchExecuteStatement Methods (==) :: BatchExecuteStatementResponse -> BatchExecuteStatementResponse -> Bool # (/=) :: BatchExecuteStatementResponse -> BatchExecuteStatementResponse -> Bool #
Read BatchExecuteStatementResponse Source #
Instance details Defined in Amazonka.RDSData.BatchExecuteStatement Methods readsPrec :: Int -> ReadS BatchExecuteStatementResponse # readList :: ReadS [BatchExecuteStatementResponse] # readPrec :: ReadPrec BatchExecuteStatementResponse # readListPrec :: ReadPrec [BatchExecuteStatementResponse] #
Show BatchExecuteStatementResponse Source #
Instance details Defined in Amazonka.RDSData.BatchExecuteStatement Methods showsPrec :: Int -> BatchExecuteStatementResponse -> ShowS # show :: BatchExecuteStatementResponse -> String # showList :: [BatchExecuteStatementResponse] -> ShowS #
Generic BatchExecuteStatementResponse Source #
Instance details Defined in Amazonka.RDSData.BatchExecuteStatement Associated Types type Rep BatchExecuteStatementResponse :: Type -> Type # Methods from :: BatchExecuteStatementResponse -> Rep BatchExecuteStatementResponse x # to :: Rep BatchExecuteStatementResponse x -> BatchExecuteStatementResponse #
NFData BatchExecuteStatementResponse Source #
Instance details Defined in Amazonka.RDSData.BatchExecuteStatement Methods rnf :: BatchExecuteStatementResponse -> () #
type Rep BatchExecuteStatementResponse Source #
Instance details Defined in Amazonka.RDSData.BatchExecuteStatement type Rep BatchExecuteStatementResponse = D1 ('MetaData "BatchExecuteStatementResponse" "Amazonka.RDSData.BatchExecuteStatement" "libZSservicesZSamazonka-rds-dataZSamazonka-rds-data" 'False) (C1 ('MetaCons "BatchExecuteStatementResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "updateResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UpdateResult])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newBatchExecuteStatementResponse Source #

Arguments

:: Int	`$sel:httpStatus:BatchExecuteStatementResponse'`
-> BatchExecuteStatementResponse

Create a value of BatchExecuteStatementResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:updateResults:BatchExecuteStatementResponse', batchExecuteStatementResponse_updateResults - The execution results of each batch entry.

$sel:httpStatus:BatchExecuteStatementResponse', batchExecuteStatementResponse_httpStatus - The response's http status code.

Response Lenses

batchExecuteStatementResponse_updateResults :: Lens' BatchExecuteStatementResponse (Maybe [UpdateResult]) Source #

The execution results of each batch entry.

batchExecuteStatementResponse_httpStatus :: Lens' BatchExecuteStatementResponse Int Source #

The response's http status code.