com.hazelcast.jet.mongodb

Class MongoSourceBuilder.Stream<T>

java.lang.Object

com.hazelcast.jet.mongodb.MongoSourceBuilder.Stream<T>

Type Parameters:

T - type of the queried documents

Enclosing class:

MongoSourceBuilder

public static final class MongoSourceBuilder.Stream<T>
extends Object

See MongoSourceBuilder.stream(String, SupplierEx).

Method Summary

Modifier and Type	Method and Description
StreamSource<T>	build() Creates and returns the MongoDB StreamSource which watches the given collection.
MongoSourceBuilder.Stream<org.bson.Document>	collection(String collectionName) Specifies from which collection connector will read documents.
<T_NEW> MongoSourceBuilder.Stream<T_NEW>	collection(String collectionName, Class<T_NEW> mongoType) Specifies from which collection connector will read documents.
MongoSourceBuilder.Stream<T>	database(String database) Specifies which database will be queried.
MongoSourceBuilder.Stream<T>	filter(org.bson.conversions.Bson filter) Adds filter aggregate to this builder, which allows to filter documents in MongoDB, without the need to download all documents.
<T_NEW> MongoSourceBuilder.Stream<T_NEW>	mapFn(BiFunctionEx<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>,Long,T_NEW> mapFn)
MongoSourceBuilder.Stream<T>	project(org.bson.conversions.Bson projection) Adds a projection aggregate.
MongoSourceBuilder.Stream<T>	startAtOperationTime(org.bson.BsonTimestamp startAtOperationTime) Specifies time from which MongoDB's events will be read.
MongoSourceBuilder.Stream<T>	throwOnNonExisting(boolean throwOnNonExisting) If true, the lack of database or collection will cause an error.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

throwOnNonExisting

@Nonnull
public MongoSourceBuilder.Stream<T> throwOnNonExisting(boolean throwOnNonExisting)

If true, the lack of database or collection will cause an error. If false, database and collection will be automatically created. Default value is true.

Parameters:

throwOnNonExisting - if exception should be thrown when database or collection does not exist.

project

@Nonnull
public MongoSourceBuilder.Stream<T> project(@Nonnull
                                                     org.bson.conversions.Bson projection)

Adds a projection aggregate. Example use:

 import static com.mongodb.client.model.Projections.include;

  MongoSourceBuilder.stream(name, supplier)
      .projection(include("fieldName"));
 

Parameters:

projection - Bson form of projection; use Projections to create projection.

Returns:

this builder with projection added

filter

@Nonnull
public MongoSourceBuilder.Stream<T> filter(@Nonnull
                                                    org.bson.conversions.Bson filter)

Adds filter aggregate to this builder, which allows to filter documents in MongoDB, without the need to download all documents.

Example usage:

  import static com.mongodb.client.model.Filters.eq;

  MongoSourceBuilder.stream(name, supplier)
      .filter(eq("fieldName", 10));
 

Parameters:

filter - Bson form of filter. Use Filters to create sort.

Returns:

this builder with aggregate added

database

@Nonnull
public MongoSourceBuilder.Stream<T> database(@Nonnull
                                                      String database)

Specifies which database will be queried. If not specified, connector will look at all databases.

Parameters:

database - database name to query.

Returns:

this builder

collection

@Nonnull
public MongoSourceBuilder.Stream<org.bson.Document> collection(@Nonnull
                                                                        String collectionName)

Specifies from which collection connector will read documents. If not invoked, then connector will look at all collections in given database.

Example usage:

  MongoSourceBuilder.stream(name, supplier)
      .collection("myCollection");
 

This function is an equivalent of calling collection(String, Class) with Document as the second argument.

Parameters:

collectionName - Name of the collection that will be queried.

Returns:

this builder

collection

@Nonnull
public <T_NEW> MongoSourceBuilder.Stream<T_NEW> collection(@Nonnull
                                                                    String collectionName,
                                                                    @Nonnull
                                                                    Class<T_NEW> mongoType)

Specifies from which collection connector will read documents. If not invoked, then connector will look at all collections in given database. All documents read will be automatically parsed to user-defined type using MongoDB's standard codec registry with pojo support added.

Example usage:

  MongoSourceBuilder.stream(name, supplier)
      .collection("myCollection", MyDocumentPojo.class);
 

This function is an equivalent for calling:

 import static com.hazelcast.jet.mongodb.impl.Mappers.toClass;

  MongoSourceBuilder.stream(name, supplier)
      .collection("myCollection")
      .mapFn(toClass(MyuDocumentPojo.class));
 

Parameters:

collectionName - Name of the collection that will be queried.

mongoType - user defined type to which the document will be parsed.

Returns:

this builder

mapFn

@Nonnull
public <T_NEW> MongoSourceBuilder.Stream<T_NEW> mapFn(@Nonnull
                                                               BiFunctionEx<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>,Long,T_NEW> mapFn)

Type Parameters:

T_NEW - type of the emitted object

Parameters:

mapFn - transforms the queried document to the desired output object. Second parameter will be the event timestamp.

Returns:

this builder

startAtOperationTime

@Nonnull
public MongoSourceBuilder.Stream<T> startAtOperationTime(@Nonnull
                                                                  org.bson.BsonTimestamp startAtOperationTime)

Specifies time from which MongoDB's events will be read.

It is highly suggested to provide this argument, as it will reduce reading initial state of database.

Parameters:

startAtOperationTime - time from which events should be taken into consideration

Returns:

this builder

build

@Nonnull
public StreamSource<T> build()

Creates and returns the MongoDB StreamSource which watches the given collection.