amazonka-rds-data-2.0: Amazon RDS DataService SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RDSData.Lens

Description

 
Synopsis

Operations

BatchExecuteStatement

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_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.

BeginTransaction

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.

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.

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_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.

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_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.

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.

Types

ArrayValue

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.

ColumnMetadata

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_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_typeName :: Lens' ColumnMetadata (Maybe Text) Source #

The database-specific data type of the column.

Field

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.

field_booleanValue :: Lens' Field (Maybe Bool) Source #

A value of Boolean data type.

field_doubleValue :: Lens' Field (Maybe Double) Source #

A value of double data type.

field_longValue :: Lens' Field (Maybe Integer) Source #

A value of long data type.

field_stringValue :: Lens' Field (Maybe Text) Source #

A value of string data type.

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 corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD.
  • DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database.
  • JSON - The corresponding String parameter value is sent as an object of JSON type to the database.
  • TIME - The corresponding String parameter value is sent as an object of TIME type to the database. The accepted format is HH:MM:SS[.FFF].
  • TIMESTAMP - The corresponding String parameter value is sent as an object of TIMESTAMP type to the database. The accepted format is YYYY-MM-DD HH:MM:SS[.FFF].
  • UUID - The corresponding String parameter value is sent as an object of UUID 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.