| 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.Types
Description
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
- 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' {
- arrayValues :: Maybe [ArrayValue]
- booleanValues :: Maybe [Bool]
- doubleValues :: Maybe [Double]
- longValues :: Maybe [Integer]
- stringValues :: Maybe [Text]
- newArrayValue :: ArrayValue
- 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])
- data ColumnMetadata = ColumnMetadata' {
- arrayBaseColumnType :: Maybe Int
- isAutoIncrement :: Maybe Bool
- isCaseSensitive :: Maybe Bool
- isCurrency :: Maybe Bool
- isSigned :: Maybe Bool
- label :: Maybe Text
- name :: Maybe Text
- nullable :: Maybe Int
- precision :: Maybe Int
- scale :: Maybe Int
- schemaName :: Maybe Text
- tableName :: Maybe Text
- type' :: Maybe Int
- typeName :: Maybe Text
- newColumnMetadata :: ColumnMetadata
- 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)
- data Field = Field' {}
- newField :: Field
- 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)
- data ResultSetOptions = ResultSetOptions' {}
- newResultSetOptions :: ResultSetOptions
- resultSetOptions_decimalReturnType :: Lens' ResultSetOptions (Maybe DecimalReturnType)
- resultSetOptions_longReturnType :: Lens' ResultSetOptions (Maybe LongReturnType)
- data SqlParameter = SqlParameter' {}
- newSqlParameter :: SqlParameter
- sqlParameter_name :: Lens' SqlParameter (Maybe Text)
- sqlParameter_typeHint :: Lens' SqlParameter (Maybe TypeHint)
- sqlParameter_value :: Lens' SqlParameter (Maybe Field)
- data UpdateResult = UpdateResult' {
- generatedFields :: Maybe [Field]
- newUpdateResult :: UpdateResult
- updateResult_generatedFields :: Lens' UpdateResult (Maybe [Field])
Service Configuration
defaultService :: Service Source #
API version 2018-08-01 of the Amazon RDS DataService SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
_BadRequestException :: AsError a => Fold a ServiceError Source #
There is an error in the call or in a SQL statement.
_ForbiddenException :: AsError a => Fold a ServiceError Source #
There are insufficient privileges to make the call.
_InternalServerErrorException :: AsError a => Fold a ServiceError Source #
An internal error occurred.
_NotFoundException :: AsError a => Fold a ServiceError Source #
The resourceArn, secretArn, or transactionId value can't be
found.
_ServiceUnavailableError :: AsError a => Fold a ServiceError Source #
The service specified by the resourceArn parameter is not available.
_StatementTimeoutException :: AsError a => Fold a ServiceError Source #
The execution of the SQL statement timed out.
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' | |
Fields
| |
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.
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
data ColumnMetadata Source #
Contains the metadata for a column.
See: newColumnMetadata smart constructor.
Constructors
| ColumnMetadata' | |
Fields
| |
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.
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
Contains a value.
See: newField smart constructor.
Constructors
| Field' | |
Fields
| |
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.
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
data ResultSetOptions Source #
Options that control how the result set is returned.
See: newResultSetOptions smart constructor.
Constructors
| ResultSetOptions' | |
Fields
| |
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.
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
data SqlParameter Source #
A parameter used in a SQL statement.
See: newSqlParameter smart constructor.
Constructors
| SqlParameter' | |
Fields
| |
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.
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 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.
sqlParameter_value :: Lens' SqlParameter (Maybe Field) Source #
The value of the parameter.
UpdateResult
data UpdateResult Source #
The response elements represent the results of an update.
See: newUpdateResult smart constructor.
Constructors
| UpdateResult' | |
Fields
| |
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.
updateResult_generatedFields :: Lens' UpdateResult (Maybe [Field]) Source #
Values for fields generated during the request.