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
- data JDBCConnectorOptions = JDBCConnectorOptions' {}
- newJDBCConnectorOptions :: JDBCConnectorOptions
- jDBCConnectorOptions_dataTypeMapping :: Lens' JDBCConnectorOptions (Maybe (HashMap JDBCDataType GlueRecordType))
- jDBCConnectorOptions_filterPredicate :: Lens' JDBCConnectorOptions (Maybe Text)
- jDBCConnectorOptions_jobBookmarkKeys :: Lens' JDBCConnectorOptions (Maybe [Text])
- jDBCConnectorOptions_jobBookmarkKeysSortOrder :: Lens' JDBCConnectorOptions (Maybe Text)
- jDBCConnectorOptions_lowerBound :: Lens' JDBCConnectorOptions (Maybe Natural)
- jDBCConnectorOptions_numPartitions :: Lens' JDBCConnectorOptions (Maybe Natural)
- jDBCConnectorOptions_partitionColumn :: Lens' JDBCConnectorOptions (Maybe Text)
- jDBCConnectorOptions_upperBound :: Lens' JDBCConnectorOptions (Maybe Natural)
Documentation
data JDBCConnectorOptions Source #
Additional connection options for the connector.
See: newJDBCConnectorOptions
smart constructor.
JDBCConnectorOptions' | |
|
Instances
newJDBCConnectorOptions :: JDBCConnectorOptions Source #
Create a value of JDBCConnectorOptions
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:dataTypeMapping:JDBCConnectorOptions'
, jDBCConnectorOptions_dataTypeMapping
- Custom data type mapping that builds a mapping from a JDBC data type to
an Glue data type. For example, the option
"dataTypeMapping":{"FLOAT":"STRING"}
maps data fields of JDBC
type FLOAT
into the Java String
type by calling the
ResultSet.getString()
method of the driver, and uses it to build the
Glue record. The ResultSet
object is implemented by each driver, so
the behavior is specific to the driver you use. Refer to the
documentation for your JDBC driver to understand how the driver performs
the conversions.
$sel:filterPredicate:JDBCConnectorOptions'
, jDBCConnectorOptions_filterPredicate
- Extra condition clause to filter data from source. For example:
BillingCity='Mountain View'
When using a query instead of a table name, you should validate that the
query works with the specified filterPredicate
.
$sel:jobBookmarkKeys:JDBCConnectorOptions'
, jDBCConnectorOptions_jobBookmarkKeys
- The name of the job bookmark keys on which to sort.
$sel:jobBookmarkKeysSortOrder:JDBCConnectorOptions'
, jDBCConnectorOptions_jobBookmarkKeysSortOrder
- Specifies an ascending or descending sort order.
$sel:lowerBound:JDBCConnectorOptions'
, jDBCConnectorOptions_lowerBound
- The minimum value of partitionColumn
that is used to decide partition
stride.
$sel:numPartitions:JDBCConnectorOptions'
, jDBCConnectorOptions_numPartitions
- The number of partitions. This value, along with lowerBound
(inclusive) and upperBound
(exclusive), form partition strides for
generated WHERE
clause expressions that are used to split the
partitionColumn
.
$sel:partitionColumn:JDBCConnectorOptions'
, jDBCConnectorOptions_partitionColumn
- The name of an integer column that is used for partitioning. This option
works only when it's included with lowerBound
, upperBound
, and
numPartitions
. This option works the same way as in the Spark SQL JDBC
reader.
$sel:upperBound:JDBCConnectorOptions'
, jDBCConnectorOptions_upperBound
- The maximum value of partitionColumn
that is used to decide partition
stride.
jDBCConnectorOptions_dataTypeMapping :: Lens' JDBCConnectorOptions (Maybe (HashMap JDBCDataType GlueRecordType)) Source #
Custom data type mapping that builds a mapping from a JDBC data type to
an Glue data type. For example, the option
"dataTypeMapping":{"FLOAT":"STRING"}
maps data fields of JDBC
type FLOAT
into the Java String
type by calling the
ResultSet.getString()
method of the driver, and uses it to build the
Glue record. The ResultSet
object is implemented by each driver, so
the behavior is specific to the driver you use. Refer to the
documentation for your JDBC driver to understand how the driver performs
the conversions.
jDBCConnectorOptions_filterPredicate :: Lens' JDBCConnectorOptions (Maybe Text) Source #
Extra condition clause to filter data from source. For example:
BillingCity='Mountain View'
When using a query instead of a table name, you should validate that the
query works with the specified filterPredicate
.
jDBCConnectorOptions_jobBookmarkKeys :: Lens' JDBCConnectorOptions (Maybe [Text]) Source #
The name of the job bookmark keys on which to sort.
jDBCConnectorOptions_jobBookmarkKeysSortOrder :: Lens' JDBCConnectorOptions (Maybe Text) Source #
Specifies an ascending or descending sort order.
jDBCConnectorOptions_lowerBound :: Lens' JDBCConnectorOptions (Maybe Natural) Source #
The minimum value of partitionColumn
that is used to decide partition
stride.
jDBCConnectorOptions_numPartitions :: Lens' JDBCConnectorOptions (Maybe Natural) Source #
The number of partitions. This value, along with lowerBound
(inclusive) and upperBound
(exclusive), form partition strides for
generated WHERE
clause expressions that are used to split the
partitionColumn
.
jDBCConnectorOptions_partitionColumn :: Lens' JDBCConnectorOptions (Maybe Text) Source #
The name of an integer column that is used for partitioning. This option
works only when it's included with lowerBound
, upperBound
, and
numPartitions
. This option works the same way as in the Spark SQL JDBC
reader.
jDBCConnectorOptions_upperBound :: Lens' JDBCConnectorOptions (Maybe Natural) Source #
The maximum value of partitionColumn
that is used to decide partition
stride.