de.caluga.morphium.driver

Interface MorphiumDriver

All Known Implementing Classes:

InMemoryDriver, MongoDriver

public interface MorphiumDriver

Morphium driver interface

All drivers need to implement this interface. you can add your own drivers to morphium. These are actually not limited to be mongodb drivers. There is also an InMemory implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION_NAME

Method Summary

Modifier and Type	Method and Description
void	abortTransaction()
void	addClusterListener(com.mongodb.event.ClusterListener cl)
void	addCommandListener(com.mongodb.event.CommandListener cmd)
void	addConnectionPoolListener(com.mongodb.event.ConnectionPoolListener cpl)
List<Map<String,Object>>	aggregate(String db, String collection, List<Map<String,Object>> pipeline, boolean explain, boolean allowDiskUse, Collation collation, ReadPreference readPreference)
void	close()
void	closeIteration(MorphiumCursor crs)
void	commitTransaction()
void	connect()
void	connect(String replicasetName)
long	count(String db, String collection, Map<String,Object> query, Collation collation, ReadPreference rp)
BulkRequestContext	createBulkContext(Morphium m, String db, String collection, boolean ordered, WriteConcern wc)
void	createIndex(String db, String collection, Map<String,Object> index, Map<String,Object> options)
Map<String,Object>	delete(String db, String collection, Map<String,Object> query, boolean multiple, Collation collation, WriteConcern wc)
List<Object>	distinct(String db, String collection, String field, Map<String,Object> filter, Collation collation, ReadPreference rp)
void	drop(String db, String collection, WriteConcern wc)
void	drop(String db, WriteConcern wc)
long	estimatedDocumentCount(String db, String collection, ReadPreference rp)
boolean	exists(String db)
boolean	exists(String db, String collection)
List<Map<String,Object>>	find(String db, String collection, Map<String,Object> query, Map<String,Integer> sort, Map<String,Object> projection, int skip, int limit, int batchSize, ReadPreference readPreference, Collation collation, Map<String,Object> findMetaData)
Map<String,Object>	findAndOneAndDelete(String db, String col, Map<String,Object> query, Map<String,Integer> sort, Collation collation)
Map<String,Object>	findAndOneAndReplace(String db, String col, Map<String,Object> query, Map<String,Object> replacement, Map<String,Integer> sort, Collation collation)
Map<String,Object>	findAndOneAndUpdate(String db, String col, Map<String,Object> query, Map<String,Object> update, Map<String,Integer> sort, Collation collation)
String	getAtlasUrl()
List<String>	getCollectionNames(String db)
Map<String,Object>	getCollStats(String db, String coll)
int	getConnectionTimeout()
String[]	getCredentials(String db)
Map<String,Object>	getDBStats(String db)
int	getDefaultW()
int	getDefaultWriteTimeout()
int	getHeartbeatFrequency()
String[]	getHostSeed()
List<Map<String,Object>>	getIndexes(String db, String collection)
int	getLocalThreshold()
int	getMaxConnectionIdleTime()
int	getMaxConnectionLifetime()
int	getMaxConnections()
Maximums	getMaximums()
int	getMaxWaitTime()
int	getMinConnections()
Map<String,Object>	getOps(long threshold)
int	getReadTimeout()
Map<String,Object>	getReplsetStatus()
int	getRetriesOnNetworkError()
int	getServerSelectionTimeout()
int	getSleepBetweenErrorRetries()
SSLContext	getSslContext()
MorphiumTransactionContext	getTransactionContext()
String	getUuidRepresentation()
void	heartBeatFrequency(int t)
MorphiumCursor	initAggregationIteration(String db, String collection, List<Map<String,Object>> aggregationPipeline, ReadPreference readPreference, Collation collation, int batchSize, Map<String,Object> findMetaData)
MorphiumCursor	initIteration(String db, String collection, Map<String,Object> query, Map<String,Integer> sort, Map<String,Object> projection, int skip, int limit, int batchSize, ReadPreference readPreference, Collation coll, Map<String,Object> findMetaData)
void	insert(String db, String collection, List<Map<String,Object>> objs, WriteConcern wc) just insert - no special handling
boolean	isCapped(String db, String coll)
boolean	isConnected()
boolean	isDefaultFsync()
boolean	isDefaultJ()
boolean	isReplicaset()
boolean	isRetryReads()
boolean	isRetryWrites()
boolean	isSslInvalidHostNameAllowed()
boolean	isUseSSL()
List<String>	listCollections(String db, String pattern) list collections whose name match the pattern
List<String>	listDatabases()
List<Map<String,Object>>	mapReduce(String db, String collection, String mapping, String reducing)
List<Map<String,Object>>	mapReduce(String db, String collection, String mapping, String reducing, Map<String,Object> query)
List<Map<String,Object>>	mapReduce(String db, String collection, String mapping, String reducing, Map<String,Object> query, Map<String,Object> sorting, Collation collation)
MorphiumCursor	nextIteration(MorphiumCursor crs)
void	removeClusterListener(com.mongodb.event.ClusterListener cl)
void	removeCommandListener(com.mongodb.event.CommandListener cmd)
void	removeConnectionPoolListener(com.mongodb.event.ConnectionPoolListener cpl)
Map<String,Object>	runCommand(String db, Map<String,Object> cmd)
void	setAtlasUrl(String atlasUrl)
void	setConnectionTimeout(int timeout)
void	setCredentials(Map<String,String[]> credentials)
void	setCredentials(String db, String login, char[] pwd)
void	setDefaultBatchSize(int defaultBatchSize)
void	setDefaultFsync(boolean j)
void	setDefaultJ(boolean j)
void	setDefaultReadPreference(ReadPreference rp)
void	setDefaultW(int w)
void	setDefaultWriteTimeout(int wt)
void	setHeartbeatFrequency(int heartbeatFrequency)
void	setHostSeed(String... host)
void	setLocalThreshold(int thr)
void	setMaxConnectionIdleTime(int time)
void	setMaxConnectionLifetime(int timeout)
void	setMaxConnections(int maxConnections)
void	setMaxWaitTime(int maxWaitTime)
void	setMinConnections(int minConnections)
void	setReadTimeout(int readTimeout)
void	setRetriesOnNetworkError(int r)
void	setRetryReads(boolean retryReads)
void	setRetryWrites(boolean retryWrites)
void	setServerSelectionTimeout(int serverSelectionTimeout)
void	setSleepBetweenErrorRetries(int s)
void	setSslContext(SSLContext sslContext)
void	setSslInvalidHostNameAllowed(boolean sslInvalidHostNameAllowed)
void	setTransactionContext(MorphiumTransactionContext ctx)
void	setUseSSL(boolean useSSL)
void	setUuidRepresentation(String uuidRepresentation)
void	startTransaction()
Map<String,Integer>	store(String db, String collection, List<Map<String,Object>> objs, WriteConcern wc) store - if id == null, create it...
void	tailableIteration(String db, String collection, Map<String,Object> query, Map<String,Integer> sort, Map<String,Object> projection, int skip, int limit, int batchSize, ReadPreference readPreference, int timeout, DriverTailableIterationCallback cb)
Map<String,Object>	update(String db, String collection, Map<String,Object> query, Map<String,Object> op, boolean multiple, boolean upsert, Collation collation, WriteConcern wc)
void	useSsl(boolean ssl)
void	watch(String db, int maxWait, boolean fullDocumentOnUpdate, List<Map<String,Object>> pipeline, DriverTailableIterationCallback cb)
void	watch(String db, String collection, int maxWait, boolean fullDocumentOnUpdate, List<Map<String,Object>> pipeline, DriverTailableIterationCallback cb)

Field Detail

VERSION_NAME

static final String VERSION_NAME

See Also:

Constant Field Values

Method Detail

getAtlasUrl

String getAtlasUrl()

setAtlasUrl

void setAtlasUrl(String atlasUrl)

listDatabases

List<String> listDatabases()
                    throws MorphiumDriverException

Throws:

MorphiumDriverException

setCredentials

void setCredentials(String db,
                    String login,
                    char[] pwd)

isReplicaset

boolean isReplicaset()

getCredentials

String[] getCredentials(String db)

isDefaultFsync

boolean isDefaultFsync()

setDefaultFsync

void setDefaultFsync(boolean j)

getHostSeed

String[] getHostSeed()

setHostSeed

void setHostSeed(String... host)

getMaxConnections

int getMaxConnections()

setMaxConnections

void setMaxConnections(int maxConnections)

getMinConnections

int getMinConnections()

setMinConnections

void setMinConnections(int minConnections)

getMaxConnectionLifetime

int getMaxConnectionLifetime()

setMaxConnectionLifetime

void setMaxConnectionLifetime(int timeout)

getMaxConnectionIdleTime

int getMaxConnectionIdleTime()

setMaxConnectionIdleTime

void setMaxConnectionIdleTime(int time)

getConnectionTimeout

int getConnectionTimeout()

setConnectionTimeout

void setConnectionTimeout(int timeout)

getDefaultW

int getDefaultW()

setDefaultW

void setDefaultW(int w)

getHeartbeatFrequency

int getHeartbeatFrequency()

setHeartbeatFrequency

void setHeartbeatFrequency(int heartbeatFrequency)

setDefaultBatchSize

void setDefaultBatchSize(int defaultBatchSize)

setCredentials

void setCredentials(Map<String,String[]> credentials)

isRetryReads

boolean isRetryReads()

setRetryReads

void setRetryReads(boolean retryReads)

isRetryWrites

boolean isRetryWrites()

setRetryWrites

void setRetryWrites(boolean retryWrites)

getUuidRepresentation

String getUuidRepresentation()

setUuidRepresentation

void setUuidRepresentation(String uuidRepresentation)

isUseSSL

boolean isUseSSL()

setUseSSL

void setUseSSL(boolean useSSL)

isDefaultJ

boolean isDefaultJ()

setDefaultJ

void setDefaultJ(boolean j)

getLocalThreshold

int getLocalThreshold()

setLocalThreshold

void setLocalThreshold(int thr)

getReadTimeout

int getReadTimeout()

setReadTimeout

void setReadTimeout(int readTimeout)

heartBeatFrequency

void heartBeatFrequency(int t)

useSsl

void useSsl(boolean ssl)

connect

void connect()
      throws MorphiumDriverException

Throws:

MorphiumDriverException

setDefaultReadPreference

void setDefaultReadPreference(ReadPreference rp)

connect

void connect(String replicasetName)
      throws MorphiumDriverException

Throws:

MorphiumDriverException

getMaximums

Maximums getMaximums()

isConnected

boolean isConnected()

getDefaultWriteTimeout

int getDefaultWriteTimeout()

setDefaultWriteTimeout

void setDefaultWriteTimeout(int wt)

getRetriesOnNetworkError

int getRetriesOnNetworkError()

setRetriesOnNetworkError

void setRetriesOnNetworkError(int r)

getSleepBetweenErrorRetries

int getSleepBetweenErrorRetries()

setSleepBetweenErrorRetries

void setSleepBetweenErrorRetries(int s)

close

void close()
    throws MorphiumDriverException

Throws:

MorphiumDriverException

getReplsetStatus

Map<String,Object> getReplsetStatus()
                             throws MorphiumDriverException

Throws:

MorphiumDriverException

getDBStats

Map<String,Object> getDBStats(String db)
                       throws MorphiumDriverException

Throws:

MorphiumDriverException

getCollStats

Map<String,Object> getCollStats(String db,
                                String coll)
                         throws MorphiumDriverException

Throws:

MorphiumDriverException

getOps

Map<String,Object> getOps(long threshold)
                   throws MorphiumDriverException

Throws:

MorphiumDriverException

runCommand

Map<String,Object> runCommand(String db,
                              Map<String,Object> cmd)
                       throws MorphiumDriverException

Throws:

MorphiumDriverException

initAggregationIteration

MorphiumCursor initAggregationIteration(String db,
                                        String collection,
                                        List<Map<String,Object>> aggregationPipeline,
                                        ReadPreference readPreference,
                                        Collation collation,
                                        int batchSize,
                                        Map<String,Object> findMetaData)
                                 throws MorphiumDriverException

Throws:

MorphiumDriverException

initIteration

MorphiumCursor initIteration(String db,
                             String collection,
                             Map<String,Object> query,
                             Map<String,Integer> sort,
                             Map<String,Object> projection,
                             int skip,
                             int limit,
                             int batchSize,
                             ReadPreference readPreference,
                             Collation coll,
                             Map<String,Object> findMetaData)
                      throws MorphiumDriverException

Throws:

MorphiumDriverException

watch

void watch(String db,
           int maxWait,
           boolean fullDocumentOnUpdate,
           List<Map<String,Object>> pipeline,
           DriverTailableIterationCallback cb)
    throws MorphiumDriverException

Throws:

MorphiumDriverException

watch

void watch(String db,
           String collection,
           int maxWait,
           boolean fullDocumentOnUpdate,
           List<Map<String,Object>> pipeline,
           DriverTailableIterationCallback cb)
    throws MorphiumDriverException

Throws:

MorphiumDriverException

tailableIteration

void tailableIteration(String db,
                       String collection,
                       Map<String,Object> query,
                       Map<String,Integer> sort,
                       Map<String,Object> projection,
                       int skip,
                       int limit,
                       int batchSize,
                       ReadPreference readPreference,
                       int timeout,
                       DriverTailableIterationCallback cb)
                throws MorphiumDriverException

Throws:

MorphiumDriverException

nextIteration

MorphiumCursor nextIteration(MorphiumCursor crs)
                      throws MorphiumDriverException

Throws:

MorphiumDriverException

closeIteration

void closeIteration(MorphiumCursor crs)
             throws MorphiumDriverException

Throws:

MorphiumDriverException

find

List<Map<String,Object>> find(String db,
                              String collection,
                              Map<String,Object> query,
                              Map<String,Integer> sort,
                              Map<String,Object> projection,
                              int skip,
                              int limit,
                              int batchSize,
                              ReadPreference readPreference,
                              Collation collation,
                              Map<String,Object> findMetaData)
                       throws MorphiumDriverException

Throws:

MorphiumDriverException

count

long count(String db,
           String collection,
           Map<String,Object> query,
           Collation collation,
           ReadPreference rp)
    throws MorphiumDriverException

Throws:

MorphiumDriverException

estimatedDocumentCount

long estimatedDocumentCount(String db,
                            String collection,
                            ReadPreference rp)

insert

void insert(String db,
            String collection,
            List<Map<String,Object>> objs,
            WriteConcern wc)
     throws MorphiumDriverException

just insert - no special handling

Parameters:

db -

collection -

wc -

Throws:

MorphiumDriverException

store

Map<String,Integer> store(String db,
                          String collection,
                          List<Map<String,Object>> objs,
                          WriteConcern wc)
                   throws MorphiumDriverException

store - if id == null, create it...

Parameters:

db -

collection -

objs -

wc -

Throws:

MorphiumDriverException

update

Map<String,Object> update(String db,
                          String collection,
                          Map<String,Object> query,
                          Map<String,Object> op,
                          boolean multiple,
                          boolean upsert,
                          Collation collation,
                          WriteConcern wc)
                   throws MorphiumDriverException

Throws:

MorphiumDriverException

delete

Map<String,Object> delete(String db,
                          String collection,
                          Map<String,Object> query,
                          boolean multiple,
                          Collation collation,
                          WriteConcern wc)
                   throws MorphiumDriverException

Throws:

MorphiumDriverException

drop

void drop(String db,
          String collection,
          WriteConcern wc)
   throws MorphiumDriverException

Throws:

MorphiumDriverException

drop

void drop(String db,
          WriteConcern wc)
   throws MorphiumDriverException

Throws:

MorphiumDriverException

exists

boolean exists(String db)
        throws MorphiumDriverException

Throws:

MorphiumDriverException

distinct

List<Object> distinct(String db,
                      String collection,
                      String field,
                      Map<String,Object> filter,
                      Collation collation,
                      ReadPreference rp)
               throws MorphiumDriverException

Throws:

MorphiumDriverException

exists

boolean exists(String db,
               String collection)
        throws MorphiumDriverException

Throws:

MorphiumDriverException

getIndexes

List<Map<String,Object>> getIndexes(String db,
                                    String collection)
                             throws MorphiumDriverException

Throws:

MorphiumDriverException

getCollectionNames

List<String> getCollectionNames(String db)
                         throws MorphiumDriverException

Throws:

MorphiumDriverException

findAndOneAndDelete

Map<String,Object> findAndOneAndDelete(String db,
                                       String col,
                                       Map<String,Object> query,
                                       Map<String,Integer> sort,
                                       Collation collation)
                                throws MorphiumDriverException

Throws:

MorphiumDriverException

findAndOneAndUpdate

Map<String,Object> findAndOneAndUpdate(String db,
                                       String col,
                                       Map<String,Object> query,
                                       Map<String,Object> update,
                                       Map<String,Integer> sort,
                                       Collation collation)
                                throws MorphiumDriverException

Throws:

MorphiumDriverException

findAndOneAndReplace

Map<String,Object> findAndOneAndReplace(String db,
                                        String col,
                                        Map<String,Object> query,
                                        Map<String,Object> replacement,
                                        Map<String,Integer> sort,
                                        Collation collation)
                                 throws MorphiumDriverException

Throws:

MorphiumDriverException

aggregate

List<Map<String,Object>> aggregate(String db,
                                   String collection,
                                   List<Map<String,Object>> pipeline,
                                   boolean explain,
                                   boolean allowDiskUse,
                                   Collation collation,
                                   ReadPreference readPreference)
                            throws MorphiumDriverException

Throws:

MorphiumDriverException

getMaxWaitTime

int getMaxWaitTime()

setMaxWaitTime

void setMaxWaitTime(int maxWaitTime)

getServerSelectionTimeout

int getServerSelectionTimeout()

setServerSelectionTimeout

void setServerSelectionTimeout(int serverSelectionTimeout)

isCapped

boolean isCapped(String db,
                 String coll)
          throws MorphiumDriverException

Throws:

MorphiumDriverException

createBulkContext

BulkRequestContext createBulkContext(Morphium m,
                                     String db,
                                     String collection,
                                     boolean ordered,
                                     WriteConcern wc)

createIndex

void createIndex(String db,
                 String collection,
                 Map<String,Object> index,
                 Map<String,Object> options)
          throws MorphiumDriverException

Throws:

MorphiumDriverException

mapReduce

List<Map<String,Object>> mapReduce(String db,
                                   String collection,
                                   String mapping,
                                   String reducing)
                            throws MorphiumDriverException

Throws:

MorphiumDriverException

mapReduce

List<Map<String,Object>> mapReduce(String db,
                                   String collection,
                                   String mapping,
                                   String reducing,
                                   Map<String,Object> query)
                            throws MorphiumDriverException

Throws:

MorphiumDriverException

mapReduce

List<Map<String,Object>> mapReduce(String db,
                                   String collection,
                                   String mapping,
                                   String reducing,
                                   Map<String,Object> query,
                                   Map<String,Object> sorting,
                                   Collation collation)
                            throws MorphiumDriverException

Throws:

MorphiumDriverException

addCommandListener

void addCommandListener(com.mongodb.event.CommandListener cmd)

removeCommandListener

void removeCommandListener(com.mongodb.event.CommandListener cmd)

addClusterListener

void addClusterListener(com.mongodb.event.ClusterListener cl)

removeClusterListener

void removeClusterListener(com.mongodb.event.ClusterListener cl)

addConnectionPoolListener

void addConnectionPoolListener(com.mongodb.event.ConnectionPoolListener cpl)

removeConnectionPoolListener

void removeConnectionPoolListener(com.mongodb.event.ConnectionPoolListener cpl)

listCollections

List<String> listCollections(String db,
                             String pattern)
                      throws MorphiumDriverException

list collections whose name match the pattern

Parameters:

pattern - regular expression for the collection, might be null

Returns:

Throws:

MorphiumDriverException

startTransaction

void startTransaction()

commitTransaction

void commitTransaction()

getTransactionContext

MorphiumTransactionContext getTransactionContext()

setTransactionContext

void setTransactionContext(MorphiumTransactionContext ctx)

abortTransaction

void abortTransaction()

getSslContext

SSLContext getSslContext()

setSslContext

void setSslContext(SSLContext sslContext)

isSslInvalidHostNameAllowed

boolean isSslInvalidHostNameAllowed()

setSslInvalidHostNameAllowed

void setSslInvalidHostNameAllowed(boolean sslInvalidHostNameAllowed)