com.hazelcast.jet.mongodb.datalink

Class MongoDataLink

java.lang.Object

com.hazelcast.datalink.DataLinkBase

com.hazelcast.jet.mongodb.datalink.MongoDataLink

All Implemented Interfaces:

DataLink

@Beta
public class MongoDataLink
extends DataLinkBase

Creates a MongoDB DataLink. According to MongoClient documentation, the client object is responsible for maintaining connection pool, so this data link just returns one, cached client.

Since:

5.3

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONNECTION_STRING_PROPERTY Name of a property which holds connection string to the mongodb instance.
static String	DATABASE_PROPERTY Name of a property with a database name hint.

Constructor Summary

Constructors

Constructor and Description
MongoDataLink(DataLinkConfig config) Creates a new data link based on given config.

Method Summary

Modifier and Type	Method and Description
void	destroy() Closes underlying client.
com.mongodb.client.MongoClient	getClient() Returns an instance of MongoClient.
String	getDatabaseName() Returns the database name hint.
List<DataLinkResource>	listResources() Lists all MongoDB collections in all databases.
static DataLinkConfig	mongoDataLinkConf(String name, String connectionString) Helper method to create new MongoDataLink with given name and connection string.

Methods inherited from class com.hazelcast.datalink.DataLinkBase

getConfig, getName, release, retain

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hazelcast.datalink.DataLink

options

Field Detail

CONNECTION_STRING_PROPERTY

public static final String CONNECTION_STRING_PROPERTY

Name of a property which holds connection string to the mongodb instance.

See Also:

Constant Field Values

DATABASE_PROPERTY

public static final String DATABASE_PROPERTY

Name of a property with a database name hint. This is used as a hint only; listResources() will return only collection from db with this name, but client is not restricted to this database. It can be used to specify database to which SQL Mappings will point.

See Also:

Constant Field Values

Constructor Detail

MongoDataLink

public MongoDataLink(DataLinkConfig config)

Creates a new data link based on given config.

Method Detail

getClient

@Nonnull
public com.mongodb.client.MongoClient getClient()

Returns an instance of MongoClient. If client is shared and there will be still some usages of given client, the MongoClient.close() method won't take an effect.

getDatabaseName

public String getDatabaseName()

Returns the database name hint.

listResources

@Nonnull
public List<DataLinkResource> listResources()

Lists all MongoDB collections in all databases.

destroy

public void destroy()

Closes underlying client.

mongoDataLinkConf

@Nonnull
public static DataLinkConfig mongoDataLinkConf(String name,
                                                        String connectionString)

Helper method to create new MongoDataLink with given name and connection string.