| 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 |
Amazonka.RDSData
Description
Derived from API version 2018-08-01 of the AWS service descriptions, licensed under Apache 2.0.
Amazon RDS Data Service
Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless v1 DB cluster. To run these statements, you work with the Data Service API.
The Data Service API isn't supported on Amazon Aurora Serverless v2 DB clusters.
For more information about the Data Service API, see Using the Data API in the Amazon Aurora User Guide.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _BadRequestException :: AsError a => Fold a ServiceError
- _ForbiddenException :: AsError a => Fold a ServiceError
- _InternalServerErrorException :: AsError a => Fold a ServiceError
- _NotFoundException :: AsError a => Fold a ServiceError
- _ServiceUnavailableError :: AsError a => Fold a ServiceError
- _StatementTimeoutException :: AsError a => Fold a ServiceError
- data BatchExecuteStatement = BatchExecuteStatement' (Maybe Text) (Maybe [[SqlParameter]]) (Maybe Text) (Maybe Text) Text Text Text
- newBatchExecuteStatement :: Text -> Text -> Text -> BatchExecuteStatement
- data BatchExecuteStatementResponse = BatchExecuteStatementResponse' (Maybe [UpdateResult]) Int
- newBatchExecuteStatementResponse :: Int -> BatchExecuteStatementResponse
- data BeginTransaction = BeginTransaction' (Maybe Text) (Maybe Text) Text Text
- newBeginTransaction :: Text -> Text -> BeginTransaction
- data BeginTransactionResponse = BeginTransactionResponse' (Maybe Text) Int
- newBeginTransactionResponse :: Int -> BeginTransactionResponse
- data CommitTransaction = CommitTransaction' Text Text Text
- newCommitTransaction :: Text -> Text -> Text -> CommitTransaction
- data CommitTransactionResponse = CommitTransactionResponse' (Maybe Text) Int
- newCommitTransactionResponse :: Int -> CommitTransactionResponse
- data ExecuteStatement = ExecuteStatement' (Maybe Bool) (Maybe Text) (Maybe RecordsFormatType) (Maybe Bool) (Maybe [SqlParameter]) (Maybe ResultSetOptions) (Maybe Text) (Maybe Text) Text Text Text
- newExecuteStatement :: Text -> Text -> Text -> ExecuteStatement
- data ExecuteStatementResponse = ExecuteStatementResponse' (Maybe [ColumnMetadata]) (Maybe Text) (Maybe [Field]) (Maybe Integer) (Maybe [[Field]]) Int
- newExecuteStatementResponse :: Int -> ExecuteStatementResponse
- data RollbackTransaction = RollbackTransaction' Text Text Text
- newRollbackTransaction :: Text -> Text -> Text -> RollbackTransaction
- data RollbackTransactionResponse = RollbackTransactionResponse' (Maybe Text) Int
- newRollbackTransactionResponse :: Int -> RollbackTransactionResponse
- newtype DecimalReturnType where
- newtype LongReturnType where
- LongReturnType' { }
- pattern LongReturnType_LONG :: LongReturnType
- pattern LongReturnType_STRING :: LongReturnType
- newtype RecordsFormatType where
- RecordsFormatType' { }
- pattern RecordsFormatType_JSON :: RecordsFormatType
- pattern RecordsFormatType_NONE :: RecordsFormatType
- newtype TypeHint where
- TypeHint' {
- fromTypeHint :: Text
- pattern TypeHint_DATE :: TypeHint
- pattern TypeHint_DECIMAL :: TypeHint
- pattern TypeHint_JSON :: TypeHint
- pattern TypeHint_TIME :: TypeHint
- pattern TypeHint_TIMESTAMP :: TypeHint
- pattern TypeHint_UUID :: TypeHint
- TypeHint' {
- data ArrayValue = ArrayValue' (Maybe [ArrayValue]) (Maybe [Bool]) (Maybe [Double]) (Maybe [Integer]) (Maybe [Text])
- newArrayValue :: ArrayValue
- data ColumnMetadata = ColumnMetadata' (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text)
- newColumnMetadata :: ColumnMetadata
- data Field = Field' (Maybe ArrayValue) (Maybe Base64) (Maybe Bool) (Maybe Double) (Maybe Bool) (Maybe Integer) (Maybe Text)
- newField :: Field
- data ResultSetOptions = ResultSetOptions' (Maybe DecimalReturnType) (Maybe LongReturnType)
- newResultSetOptions :: ResultSetOptions
- data SqlParameter = SqlParameter' (Maybe Text) (Maybe TypeHint) (Maybe Field)
- newSqlParameter :: SqlParameter
- data UpdateResult = UpdateResult' (Maybe [Field])
- newUpdateResult :: UpdateResult
Service Configuration
defaultService :: Service Source #
API version 2018-08-01 of the Amazon RDS DataService SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by RDSData.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
BadRequestException
_BadRequestException :: AsError a => Fold a ServiceError Source #
There is an error in the call or in a SQL statement.
ForbiddenException
_ForbiddenException :: AsError a => Fold a ServiceError Source #
There are insufficient privileges to make the call.
InternalServerErrorException
_InternalServerErrorException :: AsError a => Fold a ServiceError Source #
An internal error occurred.
NotFoundException
_NotFoundException :: AsError a => Fold a ServiceError Source #
The resourceArn, secretArn, or transactionId value can't be
found.
ServiceUnavailableError
_ServiceUnavailableError :: AsError a => Fold a ServiceError Source #
The service specified by the resourceArn parameter is not available.
StatementTimeoutException
_StatementTimeoutException :: AsError a => Fold a ServiceError Source #
The execution of the SQL statement timed out.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
BatchExecuteStatement
data BatchExecuteStatement Source #
The request parameters represent the input of a SQL statement over an array of data.
See: newBatchExecuteStatement smart constructor.
Constructors
| BatchExecuteStatement' (Maybe Text) (Maybe [[SqlParameter]]) (Maybe Text) (Maybe Text) Text Text Text |
Instances
newBatchExecuteStatement Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> 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
ExecuteStatementoperation instead of theBatchExecuteStatementoperation.
Array parameters are not supported.
$sel:schema:BatchExecuteStatement', batchExecuteStatement_schema - The name of the database schema.
Currently, the schema parameter isn't 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:resourceArn:BatchExecuteStatement', batchExecuteStatement_resourceArn - The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
$sel:secretArn:BatchExecuteStatement', batchExecuteStatement_secretArn - 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.
$sel:sql:BatchExecuteStatement', batchExecuteStatement_sql - The SQL statement to run. Don't include a semicolon (;) at the end of
the SQL statement.
data BatchExecuteStatementResponse Source #
The response elements represent the output of a SQL statement over an array of data.
See: newBatchExecuteStatementResponse smart constructor.
Constructors
| BatchExecuteStatementResponse' (Maybe [UpdateResult]) Int |
Instances
newBatchExecuteStatementResponse Source #
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.
BeginTransaction
data BeginTransaction Source #
The request parameters represent the input of a request to start a SQL transaction.
See: newBeginTransaction smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> BeginTransaction |
Create a value of BeginTransaction 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:BeginTransaction', beginTransaction_database - The name of the database.
$sel:schema:BeginTransaction', beginTransaction_schema - The name of the database schema.
$sel:resourceArn:BeginTransaction', beginTransaction_resourceArn - The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
$sel:secretArn:BeginTransaction', beginTransaction_secretArn - The name or ARN of the secret that enables access to the DB cluster.
data BeginTransactionResponse Source #
The response elements represent the output of a request to start a SQL transaction.
See: newBeginTransactionResponse smart constructor.
Constructors
| BeginTransactionResponse' (Maybe Text) Int |
Instances
newBeginTransactionResponse Source #
Create a value of BeginTransactionResponse 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:transactionId:BeginTransactionResponse', beginTransactionResponse_transactionId - The transaction ID of the transaction started by the call.
$sel:httpStatus:BeginTransactionResponse', beginTransactionResponse_httpStatus - The response's http status code.
CommitTransaction
data CommitTransaction Source #
The request parameters represent the input of a commit transaction request.
See: newCommitTransaction smart constructor.
Constructors
| CommitTransaction' Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CommitTransaction |
Create a value of CommitTransaction 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:resourceArn:CommitTransaction', commitTransaction_resourceArn - The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
$sel:secretArn:CommitTransaction', commitTransaction_secretArn - The name or ARN of the secret that enables access to the DB cluster.
$sel:transactionId:CommitTransaction', commitTransaction_transactionId - The identifier of the transaction to end and commit.
data CommitTransactionResponse Source #
The response elements represent the output of a commit transaction request.
See: newCommitTransactionResponse smart constructor.
Constructors
| CommitTransactionResponse' (Maybe Text) Int |
Instances
newCommitTransactionResponse Source #
Create a value of CommitTransactionResponse 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:transactionStatus:CommitTransactionResponse', commitTransactionResponse_transactionStatus - The status of the commit operation.
$sel:httpStatus:CommitTransactionResponse', commitTransactionResponse_httpStatus - The response's http status code.
ExecuteStatement
data ExecuteStatement Source #
The request parameters represent the input of a request to run a SQL statement against a database.
See: newExecuteStatement smart constructor.
Constructors
| ExecuteStatement' (Maybe Bool) (Maybe Text) (Maybe RecordsFormatType) (Maybe Bool) (Maybe [SqlParameter]) (Maybe ResultSetOptions) (Maybe Text) (Maybe Text) Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ExecuteStatement |
Create a value of ExecuteStatement 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:continueAfterTimeout:ExecuteStatement', executeStatement_continueAfterTimeout - 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.
$sel:database:ExecuteStatement', executeStatement_database - The name of the database.
$sel:formatRecordsAs:ExecuteStatement', executeStatement_formatRecordsAs - 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.
$sel:includeResultMetadata:ExecuteStatement', executeStatement_includeResultMetadata - A value that indicates whether to include metadata in the results.
$sel:parameters:ExecuteStatement', executeStatement_parameters - The parameters for the SQL statement.
Array parameters are not supported.
$sel:resultSetOptions:ExecuteStatement', executeStatement_resultSetOptions - Options that control how the result set is returned.
$sel:schema:ExecuteStatement', executeStatement_schema - The name of the database schema.
Currently, the schema parameter isn't supported.
$sel:transactionId:ExecuteStatement', executeStatement_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:resourceArn:ExecuteStatement', executeStatement_resourceArn - The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
$sel:secretArn:ExecuteStatement', executeStatement_secretArn - 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.
$sel:sql:ExecuteStatement', executeStatement_sql - The SQL statement to run.
data ExecuteStatementResponse Source #
The response elements represent the output of a request to run a SQL statement against a database.
See: newExecuteStatementResponse smart constructor.
Constructors
| ExecuteStatementResponse' (Maybe [ColumnMetadata]) (Maybe Text) (Maybe [Field]) (Maybe Integer) (Maybe [[Field]]) Int |
Instances
newExecuteStatementResponse Source #
Create a value of ExecuteStatementResponse 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:columnMetadata:ExecuteStatementResponse', executeStatementResponse_columnMetadata - Metadata for the columns included in the results. This field is blank if
the formatRecordsAs parameter is set to JSON.
$sel:formattedRecords:ExecuteStatementResponse', executeStatementResponse_formattedRecords - 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, executeStatementResponse_generatedFields - 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>
$sel:numberOfRecordsUpdated:ExecuteStatementResponse', executeStatementResponse_numberOfRecordsUpdated - The number of records updated by the request.
$sel:records:ExecuteStatementResponse', executeStatementResponse_records - The records returned by the SQL statement. This field is blank if the
formatRecordsAs parameter is set to JSON.
$sel:httpStatus:ExecuteStatementResponse', executeStatementResponse_httpStatus - The response's http status code.
RollbackTransaction
data RollbackTransaction Source #
The request parameters represent the input of a request to perform a rollback of a transaction.
See: newRollbackTransaction smart constructor.
Constructors
| RollbackTransaction' Text Text Text |
Instances
newRollbackTransaction Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> RollbackTransaction |
Create a value of RollbackTransaction 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:resourceArn:RollbackTransaction', rollbackTransaction_resourceArn - The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
$sel:secretArn:RollbackTransaction', rollbackTransaction_secretArn - The name or ARN of the secret that enables access to the DB cluster.
$sel:transactionId:RollbackTransaction', rollbackTransaction_transactionId - The identifier of the transaction to roll back.
data RollbackTransactionResponse Source #
The response elements represent the output of a request to perform a rollback of a transaction.
See: newRollbackTransactionResponse smart constructor.
Constructors
| RollbackTransactionResponse' (Maybe Text) Int |
Instances
newRollbackTransactionResponse Source #
Create a value of RollbackTransactionResponse 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:transactionStatus:RollbackTransactionResponse', rollbackTransactionResponse_transactionStatus - The status of the rollback operation.
$sel:httpStatus:RollbackTransactionResponse', rollbackTransactionResponse_httpStatus - The response's http status code.
Types
DecimalReturnType
newtype DecimalReturnType Source #
Constructors
| DecimalReturnType' | |
Fields | |
Bundled Patterns
| pattern DecimalReturnType_DOUBLE_OR_LONG :: DecimalReturnType | |
| pattern DecimalReturnType_STRING :: DecimalReturnType |
Instances
LongReturnType
newtype LongReturnType Source #
Constructors
| LongReturnType' | |
Fields | |
Bundled Patterns
| pattern LongReturnType_LONG :: LongReturnType | |
| pattern LongReturnType_STRING :: LongReturnType |
Instances
RecordsFormatType
newtype RecordsFormatType Source #
Constructors
| RecordsFormatType' | |
Fields | |
Bundled Patterns
| pattern RecordsFormatType_JSON :: RecordsFormatType | |
| pattern RecordsFormatType_NONE :: RecordsFormatType |
Instances
TypeHint
Constructors
| TypeHint' | |
Fields
| |
Bundled Patterns
| pattern TypeHint_DATE :: TypeHint | |
| pattern TypeHint_DECIMAL :: TypeHint | |
| pattern TypeHint_JSON :: TypeHint | |
| pattern TypeHint_TIME :: TypeHint | |
| pattern TypeHint_TIMESTAMP :: TypeHint | |
| pattern TypeHint_UUID :: TypeHint |
Instances
ArrayValue
data ArrayValue Source #
Contains an array.
See: newArrayValue smart constructor.
Constructors
| ArrayValue' (Maybe [ArrayValue]) (Maybe [Bool]) (Maybe [Double]) (Maybe [Integer]) (Maybe [Text]) |
Instances
newArrayValue :: ArrayValue Source #
Create a value of ArrayValue 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:arrayValues:ArrayValue', arrayValue_arrayValues - An array of arrays.
$sel:booleanValues:ArrayValue', arrayValue_booleanValues - An array of Boolean values.
$sel:doubleValues:ArrayValue', arrayValue_doubleValues - An array of floating-point numbers.
$sel:longValues:ArrayValue', arrayValue_longValues - An array of integers.
$sel:stringValues:ArrayValue', arrayValue_stringValues - An array of strings.
ColumnMetadata
data ColumnMetadata Source #
Contains the metadata for a column.
See: newColumnMetadata smart constructor.
Constructors
| ColumnMetadata' (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) |
Instances
newColumnMetadata :: ColumnMetadata Source #
Create a value of ColumnMetadata 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:arrayBaseColumnType:ColumnMetadata', columnMetadata_arrayBaseColumnType - The type of the column.
$sel:isAutoIncrement:ColumnMetadata', columnMetadata_isAutoIncrement - A value that indicates whether the column increments automatically.
$sel:isCaseSensitive:ColumnMetadata', columnMetadata_isCaseSensitive - A value that indicates whether the column is case-sensitive.
$sel:isCurrency:ColumnMetadata', columnMetadata_isCurrency - A value that indicates whether the column contains currency values.
$sel:isSigned:ColumnMetadata', columnMetadata_isSigned - A value that indicates whether an integer column is signed.
$sel:label:ColumnMetadata', columnMetadata_label - The label for the column.
$sel:name:ColumnMetadata', columnMetadata_name - The name of the column.
$sel:nullable:ColumnMetadata', columnMetadata_nullable - A value that indicates whether the column is nullable.
$sel:precision:ColumnMetadata', columnMetadata_precision - The precision value of a decimal number column.
$sel:scale:ColumnMetadata', columnMetadata_scale - The scale value of a decimal number column.
$sel:schemaName:ColumnMetadata', columnMetadata_schemaName - The name of the schema that owns the table that includes the column.
$sel:tableName:ColumnMetadata', columnMetadata_tableName - The name of the table that includes the column.
$sel:type':ColumnMetadata', columnMetadata_type - The type of the column.
$sel:typeName:ColumnMetadata', columnMetadata_typeName - The database-specific data type of the column.
Field
Contains a value.
See: newField smart constructor.
Constructors
| Field' (Maybe ArrayValue) (Maybe Base64) (Maybe Bool) (Maybe Double) (Maybe Bool) (Maybe Integer) (Maybe Text) |
Instances
Create a value of Field 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:arrayValue:Field', field_arrayValue - An array of values.
$sel:blobValue:Field', field_blobValue - 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.
$sel:booleanValue:Field', field_booleanValue - A value of Boolean data type.
$sel:doubleValue:Field', field_doubleValue - A value of double data type.
$sel:isNull:Field', field_isNull - A NULL value.
$sel:longValue:Field', field_longValue - A value of long data type.
$sel:stringValue:Field', field_stringValue - A value of string data type.
ResultSetOptions
data ResultSetOptions Source #
Options that control how the result set is returned.
See: newResultSetOptions smart constructor.
Constructors
| ResultSetOptions' (Maybe DecimalReturnType) (Maybe LongReturnType) |
Instances
newResultSetOptions :: ResultSetOptions Source #
Create a value of ResultSetOptions 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:decimalReturnType:ResultSetOptions', resultSetOptions_decimalReturnType - 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.
$sel:longReturnType:ResultSetOptions', resultSetOptions_longReturnType - 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
data SqlParameter Source #
A parameter used in a SQL statement.
See: newSqlParameter smart constructor.
Instances
newSqlParameter :: SqlParameter Source #
Create a value of SqlParameter 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:name:SqlParameter', sqlParameter_name - The name of the parameter.
$sel:typeHint:SqlParameter', sqlParameter_typeHint - A hint that specifies the correct object type for data type mapping.
Possible values are as follows:
DATE- The correspondingStringparameter value is sent as an object ofDATEtype to the database. The accepted format isYYYY-MM-DD.DECIMAL- The correspondingStringparameter value is sent as an object ofDECIMALtype to the database.JSON- The correspondingStringparameter value is sent as an object ofJSONtype to the database.TIME- The correspondingStringparameter value is sent as an object ofTIMEtype to the database. The accepted format isHH:MM:SS[.FFF].TIMESTAMP- The correspondingStringparameter value is sent as an object ofTIMESTAMPtype to the database. The accepted format isYYYY-MM-DD HH:MM:SS[.FFF].UUID- The correspondingStringparameter value is sent as an object ofUUIDtype to the database.
$sel:value:SqlParameter', sqlParameter_value - The value of the parameter.
UpdateResult
data UpdateResult Source #
The response elements represent the results of an update.
See: newUpdateResult smart constructor.
Constructors
| UpdateResult' (Maybe [Field]) |
Instances
newUpdateResult :: UpdateResult Source #
Create a value of UpdateResult 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:generatedFields:UpdateResult', updateResult_generatedFields - Values for fields generated during the request.