org.apache.metamodel.mongodb.mongo3

Class MongoDbDataContext

java.lang.Object

org.apache.metamodel.AbstractDataContext

org.apache.metamodel.QueryPostprocessDataContext

org.apache.metamodel.mongodb.mongo3.MongoDbDataContext

All Implemented Interfaces:

HasReadTypeConverters, DataContext, UpdateableDataContext

public class MongoDbDataContext
extends QueryPostprocessDataContext
implements UpdateableDataContext

DataContext implementation for MongoDB. Since MongoDB has no schema, a virtual schema will be used in this DataContext. This implementation supports either automatic discovery of a schema or manual specification of a schema, through the SimpleTableDef class.

Field Summary

Fields inherited from class org.apache.metamodel.QueryPostprocessDataContext

INFORMATION_SCHEMA_NAME, SYSTEM_PROPERTY_CREATE_DEFAULT_TABLE_ALIAS

Constructor Summary

Constructors

Constructor and Description
MongoDbDataContext(com.mongodb.client.MongoDatabase mongoDb) Constructs a MongoDbDataContext and automatically detects the schema structure/view on all collections (see detectSchema(MongoDatabase)).
MongoDbDataContext(com.mongodb.client.MongoDatabase mongoDb, SimpleTableDef... tableDefs) Constructs a MongoDbDataContext.

Method Summary

Modifier and Type	Method and Description
protected void	addTable(MutableTable table)
protected org.bson.Document	createMongoDbQuery(Table table, List<FilterItem> whereItems, Consumer<FilterItem> whereItemToPostProcessConsumer)
static SimpleTableDef[]	detectSchema(com.mongodb.client.MongoDatabase mongoDb) Performs an analysis of the available collections in a Mongo DB instance and tries to detect the table's structure based on the first 1000 documents in each collection.
static SimpleTableDef	detectTable(com.mongodb.client.MongoDatabase mongoDb, String collectionName) Performs an analysis of an available collection in a Mongo DB instance and tries to detect the table structure based on the first 1000 documents in the collection.
protected Number	executeCountQuery(Table table, List<FilterItem> whereItems, boolean functionApproximationAllowed)
protected Row	executePrimaryKeyLookupQuery(Table table, List<SelectItem> selectItems, Column primaryKeyColumn, Object keyValue)
DataSet	executeQuery(Query query)
UpdateSummary	executeUpdate(UpdateScript update)
UpdateSummary	executeUpdate(UpdateScript update, com.mongodb.WriteConcern writeConcern) Executes an update with a specific WriteConcern.
UpdateSummary	executeUpdate(UpdateScript update, WriteConcernAdvisor writeConcernAdvisor) Executes an update with a specific WriteConcernAdvisor.
protected Schema	getMainSchema()
protected String	getMainSchemaName()
com.mongodb.client.MongoDatabase	getMongoDb() Gets the DB instance that this DataContext is backed by.
WriteConcernAdvisor	getWriteConcernAdvisor() Gets the WriteConcernAdvisor to use on executeUpdate(UpdateScript) calls.
protected DataSet	materializeMainSchemaTable(Table table, List<Column> columns, int maxRows)
protected DataSet	materializeMainSchemaTable(Table table, List<Column> columns, int firstRow, int maxRows)
void	setWriteConcernAdvisor(WriteConcernAdvisor writeConcernAdvisor) Sets a global WriteConcern advisor to use on executeUpdate(UpdateScript).

Methods inherited from class org.apache.metamodel.QueryPostprocessDataContext

addConverter, getDefaultSchemaName, getSchemaByNameInternal, getSchemaNamesInternal, isMainSchemaTable, isScalarFunctionMaterialized, materializeFromItem, materializeMainSchemaTable, materializeMainSchemaTableSelect, materializeTable

Methods inherited from class org.apache.metamodel.AbstractDataContext

compileQuery, executeQuery, executeQuery, getColumnByQualifiedLabel, getDefaultSchema, getSchemaByName, getSchemaNames, getSchemas, getTableByQualifiedLabel, isQualifiedPathDelim, onSchemaCacheRefreshed, parseQuery, query, refreshSchemas

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.metamodel.DataContext

compileQuery, executeQuery, executeQuery, getColumnByQualifiedLabel, getDefaultSchema, getSchemaByName, getSchemaNames, getSchemas, getTableByQualifiedLabel, parseQuery, query, refreshSchemas

Constructor Detail

MongoDbDataContext

public MongoDbDataContext(com.mongodb.client.MongoDatabase mongoDb,
                          SimpleTableDef... tableDefs)

Constructs a MongoDbDataContext. This constructor accepts a custom array of SimpleTableDefs which allows the user to define his own view on the collections in the database.

Parameters:

mongoDb - the mongo db connection

tableDefs - an array of SimpleTableDefs, which define the table and column model of the mongo db collections. (consider using detectSchema(MongoDatabase) or detectTable(MongoDatabase, String) ).

MongoDbDataContext

public MongoDbDataContext(com.mongodb.client.MongoDatabase mongoDb)

Constructs a MongoDbDataContext and automatically detects the schema structure/view on all collections (see detectSchema(MongoDatabase)).

Parameters:

mongoDb - the mongo db connection

Method Detail

detectSchema

public static SimpleTableDef[] detectSchema(com.mongodb.client.MongoDatabase mongoDb)

Performs an analysis of the available collections in a Mongo DB instance and tries to detect the table's structure based on the first 1000 documents in each collection.

Parameters:

mongoDb - the mongo db to inspect

Returns:

a mutable schema instance, useful for further fine tuning by the user.

See Also:

detectTable(MongoDatabase, String)

detectTable

public static SimpleTableDef detectTable(com.mongodb.client.MongoDatabase mongoDb,
                                         String collectionName)

Performs an analysis of an available collection in a Mongo DB instance and tries to detect the table structure based on the first 1000 documents in the collection.

Parameters:

mongoDb - the mongo DB

collectionName - the name of the collection

Returns:

a table definition for mongo db.

getMainSchema

protected Schema getMainSchema()
                        throws MetaModelException

Specified by:

getMainSchema in class QueryPostprocessDataContext

Throws:

MetaModelException

getMainSchemaName

protected String getMainSchemaName()
                            throws MetaModelException

Specified by:

getMainSchemaName in class QueryPostprocessDataContext

Throws:

MetaModelException

executeCountQuery

protected Number executeCountQuery(Table table,
                                   List<FilterItem> whereItems,
                                   boolean functionApproximationAllowed)

Overrides:

executeCountQuery in class QueryPostprocessDataContext

executePrimaryKeyLookupQuery

protected Row executePrimaryKeyLookupQuery(Table table,
                                           List<SelectItem> selectItems,
                                           Column primaryKeyColumn,
                                           Object keyValue)

Overrides:

executePrimaryKeyLookupQuery in class QueryPostprocessDataContext

executeQuery

public DataSet executeQuery(Query query)

Specified by:

executeQuery in interface DataContext

Overrides:

executeQuery in class QueryPostprocessDataContext

createMongoDbQuery

protected org.bson.Document createMongoDbQuery(Table table,
                                               List<FilterItem> whereItems,
                                               Consumer<FilterItem> whereItemToPostProcessConsumer)

materializeMainSchemaTable

protected DataSet materializeMainSchemaTable(Table table,
                                             List<Column> columns,
                                             int maxRows)

Specified by:

materializeMainSchemaTable in class QueryPostprocessDataContext

materializeMainSchemaTable

protected DataSet materializeMainSchemaTable(Table table,
                                             List<Column> columns,
                                             int firstRow,
                                             int maxRows)

Overrides:

materializeMainSchemaTable in class QueryPostprocessDataContext

executeUpdate

public UpdateSummary executeUpdate(UpdateScript update,
                                   WriteConcernAdvisor writeConcernAdvisor)

Executes an update with a specific WriteConcernAdvisor.

executeUpdate

public UpdateSummary executeUpdate(UpdateScript update,
                                   com.mongodb.WriteConcern writeConcern)

Executes an update with a specific WriteConcern.

executeUpdate

public UpdateSummary executeUpdate(UpdateScript update)

Specified by:

executeUpdate in interface UpdateableDataContext

getWriteConcernAdvisor

public WriteConcernAdvisor getWriteConcernAdvisor()

Gets the WriteConcernAdvisor to use on executeUpdate(UpdateScript) calls.

setWriteConcernAdvisor

public void setWriteConcernAdvisor(WriteConcernAdvisor writeConcernAdvisor)

Sets a global WriteConcern advisor to use on executeUpdate(UpdateScript).

getMongoDb

public com.mongodb.client.MongoDatabase getMongoDb()

Gets the DB instance that this DataContext is backed by.

Returns:

addTable

protected void addTable(MutableTable table)