PaginateBySizePartitioner (mongo-spark-connector 10.2.3 API)

java.lang.Object
- com.mongodb.spark.sql.connector.read.partitioner.PaginateBySizePartitioner

All Implemented Interfaces:

Partitioner
```
@Internal
public final class PaginateBySizePartitioner
extends java.lang.Object
```
Paginate by size partitioner.
Paginates the collection using the average document size to split the collection into average sized chunks:
- "partition.field": The field to be used for partitioning. Must be a unique field. Defaults to: "_id".
- "partition.size": The average size per partition. Defaults to: 64.

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`ID_FIELD`
`static java.lang.String`	`PARTITION_FIELD_CONFIG`
`static java.lang.String`	`PARTITION_FIELD_DEFAULT`
`static java.lang.String`	`PARTITION_SIZE_MB_CONFIG`

Fields inherited from interface com.mongodb.spark.sql.connector.read.partitioner.Partitioner
LOGGER

Constructor Summary

Constructors
Constructor Description

PaginateBySizePartitioner()
Construct an instance

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.List<MongoInputPartition>`	`generatePartitions(ReadConfig readConfig)`	Generate the partitions for the collection based upon the read configuration

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PARTITION_SIZE_MB_CONFIG
```
public static final java.lang.String PARTITION_SIZE_MB_CONFIG
```
    See Also:
    
    Constant Field Values
  - ID_FIELD
```
public static final java.lang.String ID_FIELD
```
    See Also:
    
    Constant Field Values
  - PARTITION_FIELD_DEFAULT
```
public static final java.lang.String PARTITION_FIELD_DEFAULT
```
    See Also:
    
    Constant Field Values
  - PARTITION_FIELD_CONFIG
```
public static final java.lang.String PARTITION_FIELD_CONFIG
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PaginateBySizePartitioner
```
public PaginateBySizePartitioner()
```
    Construct an instance
- Method Detail
  - generatePartitions
```
public java.util.List<MongoInputPartition> generatePartitions(ReadConfig readConfig)
```
    Description copied from interface: Partitioner
    
    Generate the partitions for the collection based upon the read configuration
    
    Parameters:
    
    readConfig - the read configuration
    
    Returns:
    
    the partitions