de.caluga.morphium.driver

Interface MorphiumDriver

All Known Implementing Classes:

Driver, InMemoryDriver

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()
List<Map<String,Object>>	aggregate(String db, String collection, List<Map<String,Object>> pipeline, boolean explain, boolean allowDiskUse, 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, 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, WriteConcern wc)
List<Object>	distinct(String db, String collection, String field, Map<String,Object> filter, ReadPreference rp)
void	drop(String db, String collection, WriteConcern wc)
void	drop(String db, WriteConcern wc)
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 rp, Map<String,Object> findMetaData)
List<String>	getCollectionNames(String db)
int	getConnectionTimeout()
String[]	getCredentials(String db)
Map<String,Object>	getDBStats(String db)
int	getDefaultW()
int	getDefaultWriteTimeout()
int	getHeartbeatConnectTimeout()
int	getHeartbeatFrequency()
int	getHeartbeatSocketTimeout()
String[]	getHostSeed()
List<Map<String,Object>>	getIndexes(String db, String collection)
int	getLocalThreshold()
int	getMaxBlockintThreadMultiplier()
int	getMaxConnectionIdleTime()
int	getMaxConnectionLifetime()
int	getMaxConnectionsPerHost()
Maximums	getMaximums()
int	getMaxWaitTime()
int	getMinConnectionsPerHost()
Map<String,Object>	getOps(long threshold)
Map<String,Object>	getReplsetStatus()
int	getRetriesOnNetworkError()
int	getSleepBetweenErrorRetries()
int	getSocketTimeout()
MorphiumTransactionContext	getTransactionContext()
int	getWriteTimeout()
Map<String,Object>	group(String db, String coll, Map<String,Object> query, Map<String,Object> initial, String jsReduce, String jsFinalize, ReadPreference rp, String... keys)
void	heartBeatFrequency(int t)
void	heartBeatSocketTimeout(int t)
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, 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	isSocketKeepAlive()
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)
MorphiumCursor	nextIteration(MorphiumCursor crs)
Map<String,Object>	runCommand(String db, Map<String,Object> cmd)
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	setHeartbeatConnectTimeout(int heartbeatConnectTimeout)
void	setHeartbeatFrequency(int heartbeatFrequency)
void	setHeartbeatSocketTimeout(int heartbeatSocketTimeout)
void	setHostSeed(String... host)
void	setLocalThreshold(int thr)
void	setMaxBlockingThreadMultiplier(int m)
void	setMaxConnectionIdleTime(int time)
void	setMaxConnectionLifetime(int timeout)
void	setMaxConnectionsPerHost(int mx)
void	setMaxWaitTime(int maxWaitTime)
void	setMinConnectionsPerHost(int mx)
void	setRetriesOnNetworkError(int r)
void	setSleepBetweenErrorRetries(int s)
void	setSocketKeepAlive(boolean socketKeepAlive)
void	setSocketTimeout(int timeout)
void	setTransactionContext(MorphiumTransactionContext ctx)
void	setUseSSL(boolean useSSL)
void	setWriteTimeout(int writeTimeout)
void	startTransaction()
Map<String,Object>	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, WriteConcern wc)
void	useSsl(boolean ssl)
void	watch(String db, int maxWait, boolean fullDocumentOnUpdate, DriverTailableIterationCallback cb)
void	watch(String db, String collection, int maxWait, boolean fullDocumentOnUpdate, DriverTailableIterationCallback cb)

Field Detail

VERSION_NAME

static final String VERSION_NAME

See Also:

Constant Field Values

Method Detail

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)

getMaxConnectionsPerHost

int getMaxConnectionsPerHost()

setMaxConnectionsPerHost

void setMaxConnectionsPerHost(int mx)

getMinConnectionsPerHost

int getMinConnectionsPerHost()

setMinConnectionsPerHost

void setMinConnectionsPerHost(int mx)

getMaxConnectionLifetime

int getMaxConnectionLifetime()

setMaxConnectionLifetime

void setMaxConnectionLifetime(int timeout)

getMaxConnectionIdleTime

int getMaxConnectionIdleTime()

setMaxConnectionIdleTime

void setMaxConnectionIdleTime(int time)

getSocketTimeout

int getSocketTimeout()

setSocketTimeout

void setSocketTimeout(int timeout)

getConnectionTimeout

int getConnectionTimeout()

setConnectionTimeout

void setConnectionTimeout(int timeout)

getDefaultW

int getDefaultW()

setDefaultW

void setDefaultW(int w)

getMaxBlockintThreadMultiplier

int getMaxBlockintThreadMultiplier()

getHeartbeatFrequency

int getHeartbeatFrequency()

setHeartbeatFrequency

void setHeartbeatFrequency(int heartbeatFrequency)

setDefaultBatchSize

void setDefaultBatchSize(int defaultBatchSize)

setCredentials

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

getHeartbeatSocketTimeout

int getHeartbeatSocketTimeout()

setHeartbeatSocketTimeout

void setHeartbeatSocketTimeout(int heartbeatSocketTimeout)

isUseSSL

boolean isUseSSL()

setUseSSL

void setUseSSL(boolean useSSL)

isDefaultJ

boolean isDefaultJ()

setDefaultJ

void setDefaultJ(boolean j)

getWriteTimeout

int getWriteTimeout()

setWriteTimeout

void setWriteTimeout(int writeTimeout)

getLocalThreshold

int getLocalThreshold()

setLocalThreshold

void setLocalThreshold(int thr)

setMaxBlockingThreadMultiplier

void setMaxBlockingThreadMultiplier(int m)

heartBeatFrequency

void heartBeatFrequency(int t)

heartBeatSocketTimeout

void heartBeatSocketTimeout(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

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

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,
                             Map<String,Object> findMetaData)
                      throws MorphiumDriverException

Throws:

MorphiumDriverException

watch

void watch(String db,
           int maxWait,
           boolean fullDocumentOnUpdate,
           DriverTailableIterationCallback cb)
    throws MorphiumDriverException

Throws:

MorphiumDriverException

watch

void watch(String db,
           String collection,
           int maxWait,
           boolean fullDocumentOnUpdate,
           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 rp,
                              Map<String,Object> findMetaData)
                       throws MorphiumDriverException

Throws:

MorphiumDriverException

count

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

Throws:

MorphiumDriverException

insert

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

just insert - no special handling

Parameters:

db -

collection -

objs -

wc -

Throws:

MorphiumDriverException

store

Map<String,Object> 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,
                          WriteConcern wc)
                   throws MorphiumDriverException

Throws:

MorphiumDriverException

delete

Map<String,Object> delete(String db,
                          String collection,
                          Map<String,Object> query,
                          boolean multiple,
                          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,
                      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

group

Map<String,Object> group(String db,
                         String coll,
                         Map<String,Object> query,
                         Map<String,Object> initial,
                         String jsReduce,
                         String jsFinalize,
                         ReadPreference rp,
                         String... keys)
                  throws MorphiumDriverException

Throws:

MorphiumDriverException

aggregate

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

Throws:

MorphiumDriverException

isSocketKeepAlive

boolean isSocketKeepAlive()

setSocketKeepAlive

void setSocketKeepAlive(boolean socketKeepAlive)

getHeartbeatConnectTimeout

int getHeartbeatConnectTimeout()

setHeartbeatConnectTimeout

void setHeartbeatConnectTimeout(int heartbeatConnectTimeout)

getMaxWaitTime

int getMaxWaitTime()

setMaxWaitTime

void setMaxWaitTime(int maxWaitTime)

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)
                            throws MorphiumDriverException

Throws:

MorphiumDriverException

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()