Interface JDBCConnectorOptions.Builder

All Superinterfaces:
Buildable, CopyableBuilder<JDBCConnectorOptions.Builder,JDBCConnectorOptions>, SdkBuilder<JDBCConnectorOptions.Builder,JDBCConnectorOptions>, SdkPojo
Enclosing class:
JDBCConnectorOptions

public static interface JDBCConnectorOptions.Builder extends SdkPojo, CopyableBuilder<JDBCConnectorOptions.Builder,JDBCConnectorOptions>
  • Method Details

    • filterPredicate

      JDBCConnectorOptions.Builder filterPredicate(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • partitionColumn

      JDBCConnectorOptions.Builder partitionColumn(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • lowerBound

      JDBCConnectorOptions.Builder lowerBound(Long lowerBound)

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

      Parameters:
      lowerBound - The minimum value of partitionColumn that is used to decide partition stride.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • upperBound

      JDBCConnectorOptions.Builder upperBound(Long upperBound)

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

      Parameters:
      upperBound - The maximum value of partitionColumn that is used to decide partition stride.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • numPartitions

      JDBCConnectorOptions.Builder numPartitions(Long 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • jobBookmarkKeys

      JDBCConnectorOptions.Builder jobBookmarkKeys(Collection<String> jobBookmarkKeys)

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

      Parameters:
      jobBookmarkKeys - The name of the job bookmark keys on which to sort.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • jobBookmarkKeys

      JDBCConnectorOptions.Builder jobBookmarkKeys(String... jobBookmarkKeys)

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

      Parameters:
      jobBookmarkKeys - The name of the job bookmark keys on which to sort.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • jobBookmarkKeysSortOrder

      JDBCConnectorOptions.Builder jobBookmarkKeysSortOrder(String jobBookmarkKeysSortOrder)

      Specifies an ascending or descending sort order.

      Parameters:
      jobBookmarkKeysSortOrder - Specifies an ascending or descending sort order.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • dataTypeMappingWithStrings

      JDBCConnectorOptions.Builder dataTypeMappingWithStrings(Map<String,String> 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • dataTypeMapping

      JDBCConnectorOptions.Builder dataTypeMapping(Map<JDBCDataType,GlueRecordType> 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.