MongoStreamPartitionReader (mongo-spark-connector 10.0.1 API)

java.lang.Object
- com.mongodb.spark.sql.connector.read.MongoStreamPartitionReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, PartitionReader<org.apache.spark.sql.catalyst.InternalRow>, ContinuousPartitionReader<org.apache.spark.sql.catalyst.InternalRow>
```
public class MongoStreamPartitionReader
extends java.lang.Object
implements ContinuousPartitionReader<org.apache.spark.sql.catalyst.InternalRow>
```
A partition reader returned by MongoStreamPartitionReaderFactory.createReader(org.apache.spark.sql.connector.read.InputPartition).
Utilizes MongoDBs change stream functionality, the continuous stream will consist of change events.

Constructor Summary

Constructors
Constructor	Description
`MongoStreamPartitionReader(MongoInputPartition partition, BsonDocumentToRowConverter bsonDocumentToRowConverter, ReadConfig readConfig)`	Construct a new instance

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`
`org.apache.spark.sql.catalyst.InternalRow`	`get()`
`PartitionOffset`	`getOffset()`
`boolean`	`next()`

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

- Constructor Detail
  - MongoStreamPartitionReader
```
public MongoStreamPartitionReader(MongoInputPartition partition,
                                  BsonDocumentToRowConverter bsonDocumentToRowConverter,
                                  ReadConfig readConfig)
```
    Construct a new instance
    
    Parameters:
    
    partition - the partition
    
    bsonDocumentToRowConverter - the converter from BsonDocument to InternalRow
    
    readConfig - the read configuration for reading from the partition
- Method Detail
  - getOffset
```
public PartitionOffset getOffset()
```
    Specified by:
    
    getOffset in interface ContinuousPartitionReader<org.apache.spark.sql.catalyst.InternalRow>
  - next
```
public boolean next()
```
    Specified by:
    
    next in interface PartitionReader<org.apache.spark.sql.catalyst.InternalRow>
  - get
```
public org.apache.spark.sql.catalyst.InternalRow get()
```
    Specified by:
    
    get in interface PartitionReader<org.apache.spark.sql.catalyst.InternalRow>
  - close
```
public void close()
```
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.io.Closeable