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 |
Synopsis
- defaultService :: Service
- _StatementTimeoutException :: AsError a => Getting (First ServiceError) a ServiceError
- _ForbiddenException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableError :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype DecimalReturnType where
- 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' {
- longValues :: Maybe [Integer]
- doubleValues :: Maybe [Double]
- stringValues :: Maybe [Text]
- arrayValues :: Maybe [ArrayValue]
- booleanValues :: Maybe [Bool]
- newArrayValue :: ArrayValue
- arrayValue_longValues :: Lens' ArrayValue (Maybe [Integer])
- arrayValue_doubleValues :: Lens' ArrayValue (Maybe [Double])
- arrayValue_stringValues :: Lens' ArrayValue (Maybe [Text])
- arrayValue_arrayValues :: Lens' ArrayValue (Maybe [ArrayValue])
- arrayValue_booleanValues :: Lens' ArrayValue (Maybe [Bool])
- data ColumnMetadata = ColumnMetadata' {
- typeName :: Maybe Text
- isCaseSensitive :: Maybe Bool
- isCurrency :: Maybe Bool
- scale :: Maybe Int
- precision :: Maybe Int
- schemaName :: Maybe Text
- isAutoIncrement :: Maybe Bool
- name :: Maybe Text
- arrayBaseColumnType :: Maybe Int
- type' :: Maybe Int
- isSigned :: Maybe Bool
- label :: Maybe Text
- nullable :: Maybe Int
- tableName :: Maybe Text
- newColumnMetadata :: ColumnMetadata
- columnMetadata_typeName :: Lens' ColumnMetadata (Maybe Text)
- columnMetadata_isCaseSensitive :: Lens' ColumnMetadata (Maybe Bool)
- columnMetadata_isCurrency :: Lens' ColumnMetadata (Maybe Bool)
- columnMetadata_scale :: Lens' ColumnMetadata (Maybe Int)
- columnMetadata_precision :: Lens' ColumnMetadata (Maybe Int)
- columnMetadata_schemaName :: Lens' ColumnMetadata (Maybe Text)
- columnMetadata_isAutoIncrement :: Lens' ColumnMetadata (Maybe Bool)
- columnMetadata_name :: Lens' ColumnMetadata (Maybe Text)
- columnMetadata_arrayBaseColumnType :: Lens' ColumnMetadata (Maybe Int)
- columnMetadata_type :: Lens' ColumnMetadata (Maybe Int)
- columnMetadata_isSigned :: Lens' ColumnMetadata (Maybe Bool)
- columnMetadata_label :: Lens' ColumnMetadata (Maybe Text)
- columnMetadata_nullable :: Lens' ColumnMetadata (Maybe Int)
- columnMetadata_tableName :: Lens' ColumnMetadata (Maybe Text)
- data Field = Field' {}
- newField :: Field
- field_doubleValue :: Lens' Field (Maybe Double)
- field_stringValue :: Lens' Field (Maybe Text)
- field_longValue :: Lens' Field (Maybe Integer)
- field_booleanValue :: Lens' Field (Maybe Bool)
- field_arrayValue :: Lens' Field (Maybe ArrayValue)
- field_blobValue :: Lens' Field (Maybe ByteString)
- field_isNull :: Lens' Field (Maybe Bool)
- data ResultSetOptions = ResultSetOptions' {}
- newResultSetOptions :: ResultSetOptions
- resultSetOptions_decimalReturnType :: Lens' ResultSetOptions (Maybe DecimalReturnType)
- data SqlParameter = SqlParameter' {}
- newSqlParameter :: SqlParameter
- sqlParameter_value :: Lens' SqlParameter (Maybe Field)
- sqlParameter_name :: Lens' SqlParameter (Maybe Text)
- sqlParameter_typeHint :: Lens' SqlParameter (Maybe TypeHint)
- 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
_StatementTimeoutException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The execution of the SQL statement timed out.
_ForbiddenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There are insufficient privileges to make the call.
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resourceArn
, secretArn
, or transactionId
value can't be
found.
_ServiceUnavailableError :: AsError a => Getting (First ServiceError) a ServiceError Source #
The service specified by the resourceArn
parameter is not available.
_InternalServerErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An internal error occurred.
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There is an error in the call or in a SQL statement.
DecimalReturnType
newtype DecimalReturnType Source #
pattern DecimalReturnType_DOUBLE_OR_LONG :: DecimalReturnType | |
pattern DecimalReturnType_STRING :: DecimalReturnType |
Instances
TypeHint
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.
ArrayValue' | |
|
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:longValues:ArrayValue'
, arrayValue_longValues
- An array of floating point numbers.
$sel:doubleValues:ArrayValue'
, arrayValue_doubleValues
- An array of integers.
$sel:stringValues:ArrayValue'
, arrayValue_stringValues
- An array of strings.
$sel:arrayValues:ArrayValue'
, arrayValue_arrayValues
- An array of arrays.
$sel:booleanValues:ArrayValue'
, arrayValue_booleanValues
- An array of Boolean values.
arrayValue_longValues :: Lens' ArrayValue (Maybe [Integer]) Source #
An array of floating point numbers.
arrayValue_doubleValues :: Lens' ArrayValue (Maybe [Double]) Source #
An array of integers.
arrayValue_stringValues :: Lens' ArrayValue (Maybe [Text]) Source #
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.
ColumnMetadata
data ColumnMetadata Source #
Contains the metadata for a column.
See: newColumnMetadata
smart constructor.
ColumnMetadata' | |
|
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:typeName:ColumnMetadata'
, columnMetadata_typeName
- The database-specific data type of the column.
$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:scale:ColumnMetadata'
, columnMetadata_scale
- The scale value of a decimal number column.
$sel:precision:ColumnMetadata'
, columnMetadata_precision
- The precision 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:isAutoIncrement:ColumnMetadata'
, columnMetadata_isAutoIncrement
- A value that indicates whether the column increments automatically.
$sel:name:ColumnMetadata'
, columnMetadata_name
- The name of the column.
$sel:arrayBaseColumnType:ColumnMetadata'
, columnMetadata_arrayBaseColumnType
- The type of the column.
$sel:type':ColumnMetadata'
, columnMetadata_type
- The type of the column.
$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:nullable:ColumnMetadata'
, columnMetadata_nullable
- A value that indicates whether the column is nullable.
$sel:tableName:ColumnMetadata'
, columnMetadata_tableName
- The name of the table that includes the column.
columnMetadata_typeName :: Lens' ColumnMetadata (Maybe Text) Source #
The database-specific data type of the column.
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_scale :: Lens' ColumnMetadata (Maybe Int) Source #
The scale value of a decimal number column.
columnMetadata_precision :: Lens' ColumnMetadata (Maybe Int) Source #
The precision 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_isAutoIncrement :: Lens' ColumnMetadata (Maybe Bool) Source #
A value that indicates whether the column increments automatically.
columnMetadata_name :: Lens' ColumnMetadata (Maybe Text) Source #
The name of the column.
columnMetadata_arrayBaseColumnType :: Lens' ColumnMetadata (Maybe Int) Source #
The type of the column.
columnMetadata_type :: Lens' ColumnMetadata (Maybe Int) Source #
The type of the column.
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_nullable :: Lens' ColumnMetadata (Maybe Int) Source #
A value that indicates whether the column is nullable.
columnMetadata_tableName :: Lens' ColumnMetadata (Maybe Text) Source #
The name of the table that includes the column.
Field
Contains a value.
See: newField
smart constructor.
Field' | |
|
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:doubleValue:Field'
, field_doubleValue
- A value of double data type.
$sel:stringValue:Field'
, field_stringValue
- A value of string data type.
$sel:longValue:Field'
, field_longValue
- A value of long data type.
$sel:booleanValue:Field'
, field_booleanValue
- A value of Boolean data type.
$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:isNull:Field'
, field_isNull
- A NULL value.
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.
ResultSetOptions' | |
|
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.
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.
SqlParameter
data SqlParameter Source #
A parameter used in a SQL statement.
See: newSqlParameter
smart constructor.
SqlParameter' | |
|
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:value:SqlParameter'
, sqlParameter_value
- The value of the parameter.
$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 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.
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.
UpdateResult
data UpdateResult Source #
The response elements represent the results of an update.
See: newUpdateResult
smart constructor.
UpdateResult' | |
|
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.