Skip to content

JDBCConnectorOptions

Source code in docs_src/capo_glue/types/jdbc_connector_options.py
class JDBCConnectorOptions(TypedDict, closed=True):
    filter_predicate: NotRequired[
        "capo_glue.types.enclosed_in_string_property.EnclosedInStringProperty"
    ]
    """<p>Extra condition clause to filter data from source. For example:</p> <p> <code>BillingCity='Mountain View'</code> </p> <p>When using a query instead of a table name, you should validate that the query works with the specified <code>filterPredicate</code>.</p>"""
    partition_column: NotRequired[
        "capo_glue.types.enclosed_in_string_property.EnclosedInStringProperty"
    ]
    """<p>The name of an integer column that is used for partitioning. This option works only when it's included with <code>lowerBound</code>, <code>upperBound</code>, and <code>numPartitions</code>. This option works the same way as in the Spark SQL JDBC reader.</p>"""
    lower_bound: NotRequired[
        "capo_glue.types.boxed_non_negative_long.BoxedNonNegativeLong"
    ]
    """<p>The minimum value of <code>partitionColumn</code> that is used to decide partition stride.</p>"""
    upper_bound: NotRequired[
        "capo_glue.types.boxed_non_negative_long.BoxedNonNegativeLong"
    ]
    """<p>The maximum value of <code>partitionColumn</code> that is used to decide partition stride.</p>"""
    num_partitions: NotRequired[
        "capo_glue.types.boxed_non_negative_long.BoxedNonNegativeLong"
    ]
    """<p>The number of partitions. This value, along with <code>lowerBound</code> (inclusive) and <code>upperBound</code> (exclusive), form partition strides for generated <code>WHERE</code> clause expressions that are used to split the <code>partitionColumn</code>.</p>"""
    job_bookmark_keys: NotRequired[
        "capo_glue.types.enclosed_in_string_properties.EnclosedInStringProperties"
    ]
    """<p>The name of the job bookmark keys on which to sort.</p>"""
    job_bookmark_keys_sort_order: NotRequired[
        "capo_glue.types.enclosed_in_string_property.EnclosedInStringProperty"
    ]
    """<p>Specifies an ascending or descending sort order.</p>"""
    data_type_mapping: NotRequired[
        "capo_glue.types.jdbc_data_type_mapping.JDBCDataTypeMapping"
    ]
    """<p>Custom data type mapping that builds a mapping from a JDBC data type to an Glue data type. For example, the option <code>"dataTypeMapping":{"FLOAT":"STRING"}</code> maps data fields of JDBC type <code>FLOAT</code> into the Java <code>String</code> type by calling the <code>ResultSet.getString()</code> method of the driver, and uses it to build the Glue record. The <code>ResultSet</code> 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.</p>"""

data_type_mapping instance-attribute

data_type_mapping: NotRequired[JDBCDataTypeMapping]

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.

filter_predicate instance-attribute

filter_predicate: NotRequired[EnclosedInStringProperty]

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.

job_bookmark_keys instance-attribute

job_bookmark_keys: NotRequired[EnclosedInStringProperties]

The name of the job bookmark keys on which to sort.

job_bookmark_keys_sort_order instance-attribute

job_bookmark_keys_sort_order: NotRequired[EnclosedInStringProperty]

Specifies an ascending or descending sort order.

lower_bound instance-attribute

lower_bound: NotRequired[BoxedNonNegativeLong]

The minimum value of partitionColumn that is used to decide partition stride.

num_partitions instance-attribute

num_partitions: NotRequired[BoxedNonNegativeLong]

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.

partition_column instance-attribute

partition_column: NotRequired[EnclosedInStringProperty]

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.

upper_bound instance-attribute

upper_bound: NotRequired[BoxedNonNegativeLong]

The maximum value of partitionColumn that is used to decide partition stride.