Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- batchExecuteStatement_database :: Lens' BatchExecuteStatement (Maybe Text)
- batchExecuteStatement_parameterSets :: Lens' BatchExecuteStatement (Maybe [[SqlParameter]])
- batchExecuteStatement_schema :: Lens' BatchExecuteStatement (Maybe Text)
- batchExecuteStatement_transactionId :: Lens' BatchExecuteStatement (Maybe Text)
- batchExecuteStatement_resourceArn :: Lens' BatchExecuteStatement Text
- batchExecuteStatement_secretArn :: Lens' BatchExecuteStatement Text
- batchExecuteStatement_sql :: Lens' BatchExecuteStatement Text
- batchExecuteStatementResponse_updateResults :: Lens' BatchExecuteStatementResponse (Maybe [UpdateResult])
- batchExecuteStatementResponse_httpStatus :: Lens' BatchExecuteStatementResponse Int
- beginTransaction_database :: Lens' BeginTransaction (Maybe Text)
- beginTransaction_schema :: Lens' BeginTransaction (Maybe Text)
- beginTransaction_resourceArn :: Lens' BeginTransaction Text
- beginTransaction_secretArn :: Lens' BeginTransaction Text
- beginTransactionResponse_transactionId :: Lens' BeginTransactionResponse (Maybe Text)
- beginTransactionResponse_httpStatus :: Lens' BeginTransactionResponse Int
- commitTransaction_resourceArn :: Lens' CommitTransaction Text
- commitTransaction_secretArn :: Lens' CommitTransaction Text
- commitTransaction_transactionId :: Lens' CommitTransaction Text
- commitTransactionResponse_transactionStatus :: Lens' CommitTransactionResponse (Maybe Text)
- commitTransactionResponse_httpStatus :: Lens' CommitTransactionResponse Int
- executeStatement_continueAfterTimeout :: Lens' ExecuteStatement (Maybe Bool)
- executeStatement_database :: Lens' ExecuteStatement (Maybe Text)
- executeStatement_formatRecordsAs :: Lens' ExecuteStatement (Maybe RecordsFormatType)
- executeStatement_includeResultMetadata :: Lens' ExecuteStatement (Maybe Bool)
- executeStatement_parameters :: Lens' ExecuteStatement (Maybe [SqlParameter])
- executeStatement_resultSetOptions :: Lens' ExecuteStatement (Maybe ResultSetOptions)
- executeStatement_schema :: Lens' ExecuteStatement (Maybe Text)
- executeStatement_transactionId :: Lens' ExecuteStatement (Maybe Text)
- executeStatement_resourceArn :: Lens' ExecuteStatement Text
- executeStatement_secretArn :: Lens' ExecuteStatement Text
- executeStatement_sql :: Lens' ExecuteStatement Text
- executeStatementResponse_columnMetadata :: Lens' ExecuteStatementResponse (Maybe [ColumnMetadata])
- executeStatementResponse_formattedRecords :: Lens' ExecuteStatementResponse (Maybe Text)
- executeStatementResponse_generatedFields :: Lens' ExecuteStatementResponse (Maybe [Field])
- executeStatementResponse_numberOfRecordsUpdated :: Lens' ExecuteStatementResponse (Maybe Integer)
- executeStatementResponse_records :: Lens' ExecuteStatementResponse (Maybe [[Field]])
- executeStatementResponse_httpStatus :: Lens' ExecuteStatementResponse Int
- rollbackTransaction_resourceArn :: Lens' RollbackTransaction Text
- rollbackTransaction_secretArn :: Lens' RollbackTransaction Text
- rollbackTransaction_transactionId :: Lens' RollbackTransaction Text
- rollbackTransactionResponse_transactionStatus :: Lens' RollbackTransactionResponse (Maybe Text)
- rollbackTransactionResponse_httpStatus :: Lens' RollbackTransactionResponse Int
- arrayValue_arrayValues :: Lens' ArrayValue (Maybe [ArrayValue])
- arrayValue_booleanValues :: Lens' ArrayValue (Maybe [Bool])
- arrayValue_doubleValues :: Lens' ArrayValue (Maybe [Double])
- arrayValue_longValues :: Lens' ArrayValue (Maybe [Integer])
- arrayValue_stringValues :: Lens' ArrayValue (Maybe [Text])
- columnMetadata_arrayBaseColumnType :: Lens' ColumnMetadata (Maybe Int)
- columnMetadata_isAutoIncrement :: Lens' ColumnMetadata (Maybe Bool)
- columnMetadata_isCaseSensitive :: Lens' ColumnMetadata (Maybe Bool)
- columnMetadata_isCurrency :: Lens' ColumnMetadata (Maybe Bool)
- columnMetadata_isSigned :: Lens' ColumnMetadata (Maybe Bool)
- columnMetadata_label :: Lens' ColumnMetadata (Maybe Text)
- columnMetadata_name :: Lens' ColumnMetadata (Maybe Text)
- columnMetadata_nullable :: Lens' ColumnMetadata (Maybe Int)
- columnMetadata_precision :: Lens' ColumnMetadata (Maybe Int)
- columnMetadata_scale :: Lens' ColumnMetadata (Maybe Int)
- columnMetadata_schemaName :: Lens' ColumnMetadata (Maybe Text)
- columnMetadata_tableName :: Lens' ColumnMetadata (Maybe Text)
- columnMetadata_type :: Lens' ColumnMetadata (Maybe Int)
- columnMetadata_typeName :: Lens' ColumnMetadata (Maybe Text)
- field_arrayValue :: Lens' Field (Maybe ArrayValue)
- field_blobValue :: Lens' Field (Maybe ByteString)
- field_booleanValue :: Lens' Field (Maybe Bool)
- field_doubleValue :: Lens' Field (Maybe Double)
- field_isNull :: Lens' Field (Maybe Bool)
- field_longValue :: Lens' Field (Maybe Integer)
- field_stringValue :: Lens' Field (Maybe Text)
- resultSetOptions_decimalReturnType :: Lens' ResultSetOptions (Maybe DecimalReturnType)
- resultSetOptions_longReturnType :: Lens' ResultSetOptions (Maybe LongReturnType)
- sqlParameter_name :: Lens' SqlParameter (Maybe Text)
- sqlParameter_typeHint :: Lens' SqlParameter (Maybe TypeHint)
- sqlParameter_value :: Lens' SqlParameter (Maybe Field)
- updateResult_generatedFields :: Lens' UpdateResult (Maybe [Field])
Operations
BatchExecuteStatement
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 theBatchExecuteStatement
operation.
Array parameters are not supported.
batchExecuteStatement_schema :: Lens' BatchExecuteStatement (Maybe Text) Source #
The name of the database schema.
Currently, the schema
parameter isn't 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_resourceArn :: Lens' BatchExecuteStatement Text Source #
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
batchExecuteStatement_secretArn :: Lens' BatchExecuteStatement Text Source #
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.
batchExecuteStatement_sql :: Lens' BatchExecuteStatement Text Source #
The SQL statement to run. Don't include a semicolon (;) at the end of the SQL statement.
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.
BeginTransaction
beginTransaction_database :: Lens' BeginTransaction (Maybe Text) Source #
The name of the database.
beginTransaction_schema :: Lens' BeginTransaction (Maybe Text) Source #
The name of the database schema.
beginTransaction_resourceArn :: Lens' BeginTransaction Text Source #
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
beginTransaction_secretArn :: Lens' BeginTransaction Text Source #
The name or ARN of the secret that enables access to the DB cluster.
beginTransactionResponse_transactionId :: Lens' BeginTransactionResponse (Maybe Text) Source #
The transaction ID of the transaction started by the call.
beginTransactionResponse_httpStatus :: Lens' BeginTransactionResponse Int Source #
The response's http status code.
CommitTransaction
commitTransaction_resourceArn :: Lens' CommitTransaction Text Source #
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
commitTransaction_secretArn :: Lens' CommitTransaction Text Source #
The name or ARN of the secret that enables access to the DB cluster.
commitTransaction_transactionId :: Lens' CommitTransaction Text Source #
The identifier of the transaction to end and commit.
commitTransactionResponse_transactionStatus :: Lens' CommitTransactionResponse (Maybe Text) Source #
The status of the commit operation.
commitTransactionResponse_httpStatus :: Lens' CommitTransactionResponse Int Source #
The response's http status code.
ExecuteStatement
executeStatement_continueAfterTimeout :: Lens' ExecuteStatement (Maybe Bool) Source #
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.
executeStatement_database :: Lens' ExecuteStatement (Maybe Text) Source #
The name of the database.
executeStatement_formatRecordsAs :: Lens' ExecuteStatement (Maybe RecordsFormatType) Source #
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 in the Amazon Aurora User Guide.
executeStatement_includeResultMetadata :: Lens' ExecuteStatement (Maybe Bool) Source #
A value that indicates whether to include metadata in the results.
executeStatement_parameters :: Lens' ExecuteStatement (Maybe [SqlParameter]) Source #
The parameters for the SQL statement.
Array parameters are not supported.
executeStatement_resultSetOptions :: Lens' ExecuteStatement (Maybe ResultSetOptions) Source #
Options that control how the result set is returned.
executeStatement_schema :: Lens' ExecuteStatement (Maybe Text) Source #
The name of the database schema.
Currently, the schema
parameter isn't supported.
executeStatement_transactionId :: Lens' ExecuteStatement (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.
executeStatement_resourceArn :: Lens' ExecuteStatement Text Source #
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
executeStatement_secretArn :: Lens' ExecuteStatement Text Source #
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.
executeStatement_sql :: Lens' ExecuteStatement Text Source #
The SQL statement to run.
executeStatementResponse_columnMetadata :: Lens' ExecuteStatementResponse (Maybe [ColumnMetadata]) Source #
Metadata for the columns included in the results. This field is blank if
the formatRecordsAs
parameter is set to JSON
.
executeStatementResponse_formattedRecords :: Lens' ExecuteStatementResponse (Maybe Text) Source #
A string value that represents the result set of a SELECT
statement in
JSON format. This value is only present when the formatRecordsAs
parameter is set to JSON
.
The size limit for this field is currently 10 MB. If the JSON-formatted string representing the result set requires more than 10 MB, the call returns an error.
executeStatementResponse_generatedFields :: Lens' ExecuteStatementResponse (Maybe [Field]) Source #
Values for fields generated during a DML request.
<note> <p>The <code>generatedFields</code> data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the <code>RETURNING</code> clause. For more information, see <a href="https://www.postgresql.org/docs/10/dml-returning.html">Returning Data From Modified Rows</a> in the PostgreSQL documentation.</p> </note>
executeStatementResponse_numberOfRecordsUpdated :: Lens' ExecuteStatementResponse (Maybe Integer) Source #
The number of records updated by the request.
executeStatementResponse_records :: Lens' ExecuteStatementResponse (Maybe [[Field]]) Source #
The records returned by the SQL statement. This field is blank if the
formatRecordsAs
parameter is set to JSON
.
executeStatementResponse_httpStatus :: Lens' ExecuteStatementResponse Int Source #
The response's http status code.
RollbackTransaction
rollbackTransaction_resourceArn :: Lens' RollbackTransaction Text Source #
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
rollbackTransaction_secretArn :: Lens' RollbackTransaction Text Source #
The name or ARN of the secret that enables access to the DB cluster.
rollbackTransaction_transactionId :: Lens' RollbackTransaction Text Source #
The identifier of the transaction to roll back.
rollbackTransactionResponse_transactionStatus :: Lens' RollbackTransactionResponse (Maybe Text) Source #
The status of the rollback operation.
rollbackTransactionResponse_httpStatus :: Lens' RollbackTransactionResponse Int Source #
The response's http status code.
Types
ArrayValue
arrayValue_arrayValues :: Lens' ArrayValue (Maybe [ArrayValue]) Source #
An array of arrays.
arrayValue_booleanValues :: Lens' ArrayValue (Maybe [Bool]) Source #
An array of Boolean values.
arrayValue_doubleValues :: Lens' ArrayValue (Maybe [Double]) Source #
An array of floating-point numbers.
arrayValue_longValues :: Lens' ArrayValue (Maybe [Integer]) Source #
An array of integers.
arrayValue_stringValues :: Lens' ArrayValue (Maybe [Text]) Source #
An array of strings.
ColumnMetadata
columnMetadata_arrayBaseColumnType :: Lens' ColumnMetadata (Maybe Int) Source #
The type of the column.
columnMetadata_isAutoIncrement :: Lens' ColumnMetadata (Maybe Bool) Source #
A value that indicates whether the column increments automatically.
columnMetadata_isCaseSensitive :: Lens' ColumnMetadata (Maybe Bool) Source #
A value that indicates whether the column is case-sensitive.
columnMetadata_isCurrency :: Lens' ColumnMetadata (Maybe Bool) Source #
A value that indicates whether the column contains currency values.
columnMetadata_isSigned :: Lens' ColumnMetadata (Maybe Bool) Source #
A value that indicates whether an integer column is signed.
columnMetadata_label :: Lens' ColumnMetadata (Maybe Text) Source #
The label for the column.
columnMetadata_name :: Lens' ColumnMetadata (Maybe Text) Source #
The name of the column.
columnMetadata_nullable :: Lens' ColumnMetadata (Maybe Int) Source #
A value that indicates whether the column is nullable.
columnMetadata_precision :: Lens' ColumnMetadata (Maybe Int) Source #
The precision value of a decimal number column.
columnMetadata_scale :: Lens' ColumnMetadata (Maybe Int) Source #
The scale value of a decimal number column.
columnMetadata_schemaName :: Lens' ColumnMetadata (Maybe Text) Source #
The name of the schema that owns the table that includes the column.
columnMetadata_tableName :: Lens' ColumnMetadata (Maybe Text) Source #
The name of the table that includes the column.
columnMetadata_type :: Lens' ColumnMetadata (Maybe Int) Source #
The type of the column.
columnMetadata_typeName :: Lens' ColumnMetadata (Maybe Text) Source #
The database-specific data type of the column.
Field
field_arrayValue :: Lens' Field (Maybe ArrayValue) Source #
An array of values.
field_blobValue :: Lens' Field (Maybe ByteString) Source #
A value of BLOB data type.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
ResultSetOptions
resultSetOptions_decimalReturnType :: Lens' ResultSetOptions (Maybe DecimalReturnType) Source #
A value that indicates how a field of DECIMAL
type is represented in
the response. The value of STRING
, the default, specifies that it is
converted to a String value. The value of DOUBLE_OR_LONG
specifies
that it is converted to a Long value if its scale is 0, or to a Double
value otherwise.
Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend converting to String, especially when working with currency values.
resultSetOptions_longReturnType :: Lens' ResultSetOptions (Maybe LongReturnType) Source #
A value that indicates how a field of LONG
type is represented.
Allowed values are LONG
and STRING
. The default is LONG
. Specify
STRING
if the length or precision of numeric values might cause
truncation or rounding errors.
SqlParameter
sqlParameter_name :: Lens' SqlParameter (Maybe Text) Source #
The name of the parameter.
sqlParameter_typeHint :: Lens' SqlParameter (Maybe TypeHint) Source #
A hint that specifies the correct object type for data type mapping. Possible values are as follows:
DATE
- The correspondingString
parameter value is sent as an object ofDATE
type to the database. The accepted format isYYYY-MM-DD
.DECIMAL
- The correspondingString
parameter value is sent as an object ofDECIMAL
type to the database.JSON
- The correspondingString
parameter value is sent as an object ofJSON
type to the database.TIME
- The correspondingString
parameter value is sent as an object ofTIME
type to the database. The accepted format isHH:MM:SS[.FFF]
.TIMESTAMP
- The correspondingString
parameter value is sent as an object ofTIMESTAMP
type to the database. The accepted format isYYYY-MM-DD HH:MM:SS[.FFF]
.UUID
- The correspondingString
parameter value is sent as an object ofUUID
type to the database.
sqlParameter_value :: Lens' SqlParameter (Maybe Field) Source #
The value of the parameter.
UpdateResult
updateResult_generatedFields :: Lens' UpdateResult (Maybe [Field]) Source #
Values for fields generated during the request.