This page describes an older version of the product. The latest stable version is 16.4.

Data Source

A MongoDB based implementation of the Space Data Source.

Library dependencies

The MongoDB Space Data Source uses MongoDB Driver For communicating with the MongoDB cluster.

include the following in your pom.xml

    <!-- currently the MongoDB library is not the central maven repository --> 

        <!-- mongodb java driver -->




An example of how the MongoDB Space Data Source can be configured for a space that loads data back from MongoDB once initialized and also asynchronously persists the data using a mirror (see MongoDB Space Synchronization Endpoint)).

<?xml version="1.0" encoding="utf-8"?>
<beans xmlns=""
    xmlns:xsi="" xmlns:context=""
    xmlns:os-core="" xmlns:os-jms=""
    xmlns:os-sla="" xmlns:tx=""

    <bean id="propertiesConfigurer"
    class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer" />

    <os-core:embedded-space id="space" space-name="dataSourceSpace">
        space-data-source="spaceDataSource" mirrored="true" schema="persistent">
            <!-- Use ALL IN CACHE, put 0 for LRU -->
            <prop key="space-config.engine.cache_policy">1</prop>
            <prop key="cluster-config.cache-loader.central-data-source">true</prop>
            <prop key="cluster-config.mirror-service.supports-partial-update">true</prop>
    <os-core:giga-space id="gigaSpace" space="space" />
    <bean id="mongoClient" class="com.gigaspaces.persistency.MongoClientConnectorBeanFactory">
        <property name="db" value="qadb" />
        <property name="config">
            <bean class="com.mongodb.MongoClient">
                <constructor-arg value="localhost" type="java.lang.String" />
                <constructor-arg value="27017" type="int" />
    <bean id="spaceDataSource" class="com.gigaspaces.persistency.MongoSpaceDataSourceBeanFactory">
        <property name="mongoClientConnector" ref="mongoClient" />
    MongoClient config = new MongoClient(host, port);

    MongoClientConnector client = new MongoClientConnectorConfigurer()
    MongoSpaceDataSource spaceDataSource = new MongoSpaceDataSourceConfigurer()
    GigaSpace gigaSpace = new GigaSpaceConfigurer(new EmbeddedSpaceConfigurer("space")
    .cachePolicy(new LruCachePolicy()) 
    .addProperty("cluster-config.cache-loader.central-data-source", "true") 
    .addProperty("cluster-config.mirror-service.supports-partial-update", "true") 

For more details about different configurations see Space Persistency.

Before you begin

Before deploying your Processing Unit, please do the following:

  1. Copy the xap-mongodb.jar and antlr4-runtime-4.0.jar from lib\optional\mongodb to lib\optional\pu-common.
  2. download the following jar and copy it to lib\optional\pu-common:
  3. mongo-java-driver-3.2.0.jar from mongoDB’s website .

MongoSpaceDataSource Properties

Property Description Default
mongoClientConnector A configured com.gigaspaces.persistency.MongoClientConnector bean. Must be configured


General limitations

  • All classes that belong to types that are to be introduced to the space during the initial metadata load must exist on the classpath of the JVM the Space is running on.

Cache miss Query limitations

Supported queries:

  • id = 1234

  • name = 'John' AND age = 13

  • address.streetName = 'Liberty'

  • age > 15

  • age < 20

  • age <= 20

  • age >= 15

  • name = 'John' OR name = 'Jane'

  • name rlike 'A.*B'

  • name like 'A%'

  • name is NULL

  • name is NOT NULL


Java types Short, Float, BigDecimal and BigInt supported only =,<> queries >,<,>=,<= is not supported.

Unsupported queries:

  • Contains is unsupported

Mongo As a Service

There are some Mongo DB hosting services that run on the cloud, and you can connect to them from your deployment environment for free. For example: mongolab

In order to configure the connection, you would need to connect using a URI that contains the username and password.

<bean id="mongoClient"
        <property name="db" value="xapdb" />
        <property name="config">
            <bean class="com.mongodb.MongoClient">
                 <bean class="com.mongodb.MongoClientURI">
                   <constructor-arg value="mongodb://<DB_USERNAME>:<DB_PASSWORD>" type="java.lang.String"/>