Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ehanlin/mongodb-dbobject-embedder

Lets you use string easily embed other collection's DBObject
https://github.com/ehanlin/mongodb-dbobject-embedder

Last synced: 5 months ago
JSON representation

Lets you use string easily embed other collection's DBObject

Awesome Lists containing this project

README 

          
# mongodb-dbobject-embedder

>使用簡易的語法進行 mongodb 的資料查詢及再處理



## 簡易範例



#### Example 1

>執行 db.user.find({ height : { $gte : 215 } }) 的原始資料



```javascript

[

  { 

    "_id" : ObjectId("557e58727a8ea2a9dfe2ef76"), 

    "name" : "Kirk", 

    "postal_code" : ObjectId("557e56287a8ea2a9dfe2ef71"), 

    "height" : 220, 

    "friends" : [ 

      ObjectId("557e58727a8ea2a9dfe2ef74"), 

      ObjectId("557e58727a8ea2a9dfe2ef77"), 

      ObjectId("557e58727a8ea2a9dfe2ef7a"), 

      ObjectId("557e58727a8ea2a9dfe2ef7e")] 

  },

  { 

    "_id" : ObjectId("557e58727a8ea2a9dfe2ef7a"), 

    "name" : "Rick", 

    "postal_code" : ObjectId("557e56287a8ea2a9dfe2ef72"), 

    "height" : 218, 

    "friends" : [ 

      ObjectId("557e58727a8ea2a9dfe2ef76"), 

      ObjectId("557e58727a8ea2a9dfe2ef7c"), 

      ObjectId("557e58727a8ea2a9dfe2ef7e")] 

  }

]

```



>下面的 DSL 將會把 user 這個 collection 中身高大於 215 的使用者撈出，

>加入一個新欄位 num，值是同一個 postal_code 中身高大於 200 的使用者數，

>並且將其原本以 ObjectId 記錄的 postal_code 資料嵌入，

>再將 friends 中的 postal_code 嵌入。



```

@find 

[

  @count (db=user coll=user query={ height : { $gte : 200 } , postal_code : @.postal_code })

  num



  @findOneById 

  postal_code



  @findOneById [db=user coll=user, projection={ _id : 0 , postal_code : 1, height : 1}]

  friends

  [

    @findOneById 

    postal_code

  ]

]

```



>執行 DSL 之後的結果



```javascript

[

  {

    "_id":{"$oid":"557e58727a8ea2a9dfe2ef76"},

    "name":"Kirk",

    "postal_code":{"name":"中正區"},

    "height":220,

    "friends":[

      {"postal_code":{"name":"中正區"},"height":201},

      {"postal_code":{"name":"中正區"},"height":211},

      {"postal_code":{"name":"信義區"},"height":218},

      {"postal_code":{"name":"內湖區"},"height":208}],

    "num":3

  },

  {

    "_id":{"$oid":"557e58727a8ea2a9dfe2ef7a"},

    "name":"Rick",

    "postal_code":{"name":"信義區"},

    "height":218,

    "friends":[

      {"postal_code":{"name":"中正區"},"height":220},

      {"postal_code":{"name":"信義區"},"height":214},

      {"postal_code":{"name":"內湖區"},"height":208}],

    "num":4

  }

]

```



## Repository

> Maven



```



  

    mongodb-dbobject-embedder

    http://dl.bintray.com/hotdog929/maven

  



  

    tw.com.ehanlin

    mongodb-dbobject-embedder

    0.0.10

  



```



> Sbt



```

resolvers += "mongodb-dbobject-embedder" at "http://dl.bintray.com/hotdog929/maven"

libraryDependencies ++= Seq(

  "tw.com.ehanlin" % "mongodb-dbobject-embedder" % "0.0.10"

)

```



> Gradle



```

repositories {

    maven {

        url "http://dl.bintray.com/hotdog929/maven"

    }

}

dependencies {

    compile 'tw.com.ehanlin:mongodb-dbobject-embedder:0.0.10'

}

```



> Grape



```

@GrabResolver(name='mongodb-dbobject-embedder', root='http://dl.bintray.com/hotdog929/maven')

@Grab('tw.com.ehanlin:mongodb-dbobject-embedder:0.0.10')

```



## 使用方式



```java



Mongo mongo = new Mongo(host, port)



//設定 default db

MongoEmbedder.registerDB(mongo.getDB("info"))



//設定各 db

MongoEmbedder.registerDB("info", mongo.getDB("info"))

MongoEmbedder.registerDB("user", mongo.getDB("user"))



//執行 DSL

MongoEmbedder.instance.embed(null, "@find  [ ]")



```



## 語法說明



### 屬性的迭代作用域

>可以用在屬性上的作用城有二種

* < content... > 會將傳入的值當一個單一值處理

* [ content... ] 會將傳入的值當集合處理，依傳入值的類型，會有以下三種情況：

  * List ： for(v in List){List[index] = embed(v)} return List

  * Map ： for(k,v in Map){Map[k] = embed(v)} return Map

  * Other ： return [ embed(Other) ] as List

* 巢狀迭代是合法的，比如 [[ content... ]] 對應到巢狀 List 時的執行方式是 for(v in List){List[index] = for(vv in v){embed(vv)}} return List



#### Example 2  < content... >

>執行 db.user.findOne({ _id : ObjectId("557e58727a8ea2a9dfe2ef7a") }) 的原始資料



```javascript

{ 

  "_id" : ObjectId("557e58727a8ea2a9dfe2ef7a"), 

  "name" : "Rick", 

  "postal_code" : ObjectId("557e56287a8ea2a9dfe2ef72"), 

  "height" : 218, 

  "friends" : [ 

    ObjectId("557e58727a8ea2a9dfe2ef76"), 

    ObjectId("557e58727a8ea2a9dfe2ef7c"), 

    ObjectId("557e58727a8ea2a9dfe2ef7e")] 

}

```



>DSL



```

@findOne 

<

  @findOneById 

  postal_code

  <

    @findOne 

    city

    <

      @findOneById 

      country

    >

  >

>

```



>執行 DSL 之後的結果



```javascript

{

  "_id":{"$oid":"557e58727a8ea2a9dfe2ef7a"},

  "name":"Rick",

  "postal_code":{

    "country":"TW",

    "city":{

      "country":{

        "name":"臺灣"},

      "name":"臺北市"},

    "code":"110",

    "name":"信義區"},

  "height":218,

  "friends":[

    {"$oid":"557e58727a8ea2a9dfe2ef76"},

    {"$oid":"557e58727a8ea2a9dfe2ef7c"},

    {"$oid":"557e58727a8ea2a9dfe2ef7e"}]

}

```



#### Example 3  [ content... ] Map

>執行 db.team.find({ _id : "zebra" }) 的原始資料



```javascript

{

  "_id" : "zebra",

  "name" : "zebra",

  "player" : {

    "c" : ObjectId("557e58727a8ea2a9dfe2ef76"),

    "f" : ObjectId("557e58727a8ea2a9dfe2ef77"),

    "g" : ObjectId("557e58727a8ea2a9dfe2ef7b")}

}

```



>DSL



```

@findOne 

<

  @findOneById [db=user coll=user projection={ _id : 0 , name : 1 , postal_code : 1 }]

  player

  [

    @findOneById 

    postal_code

  ]

>

```



>執行 DSL 之後的結果



```javascript

{

  "name":"zebra",

  "player":{

    "c":{

      "name":"Kirk",

      "postal_code":{"name":"中正區"}},

    "f":{

      "name":"Mick",

      "postal_code":{"name":"中正區"}},

    "g":{

      "name":"Sean",

      "postal_code":{"name":"信義區"}}}

}

```



#### Example 4  [[ content... ]] List[ List... ]

>執行 db.team.find({ _id : ObjectId("557e58727a8ea2a9dfe2ef83") }) 的原始資料



```javascript

{

  "_id" : ObjectId("557e58727a8ea2a9dfe2ef83"),

  "team" : ["zebra","snake"],

  "box_score" : [

    [

      ObjectId("557e58727a8ea2a9dfe2ef86"),

      ObjectId("557e58727a8ea2a9dfe2ef87"),

      ObjectId("557e58727a8ea2a9dfe2ef88")

    ],

    [

      ObjectId("557e58727a8ea2a9dfe2ef89"),

      ObjectId("557e58727a8ea2a9dfe2ef8a"),

      ObjectId("557e58727a8ea2a9dfe2ef8b")

    ]

  ]

}

```



>DSL



```

@findOne 

<

  box_score

  [

    @findOneById [db=game coll=box_score projection={ _id : 0 , user : 1 , pts : 1 }]

    [

      @findOneById 

      user

    ]

  ]

>

```



>執行 DSL 之後的結果



```javascript

{

  "team":["zebra","snake"],

  "box_score":[

    [

      {"user":{"name":"Kirk"},"pts":11},

      {"user":{"name":"Mick"},"pts":5},

      {"user":{"name":"Sean"},"pts":5}

    ],

    [

      {"user":{"name":"Toby"},"pts":3},

      {"user":{"name":"Eric"},"pts":6},

      {"user":{"name":"Glen"},"pts":6}

    ]

  ]

}

```



### Action 的迭代作用域

>可以用在屬性上的作用城有三種

* @Action ( info... ) 位在 info 中的 @ 會以屬性的父層代入

* @Action < info... > 位在 info 中的 @ 會以屬性本身代入

* @Action [ info... ] 若屬性本身是個集合，則位在 info 中的 @ 會以各子項帶入，不然會以屬性本身代入但回傳 List



>位在 info 中的 @ 可以使用以下方法參照上層資料

* @../.property 代入父層資料的 property 屬性

* @../../.property 代入父層資料的 父層資料的 property 屬性

* @.../.property 代入最上層資料的 property 屬性



#### Example 5  ( info... )

>執行 db.postal_code.find({},{name:1}) 的原始資料



```javascript

[

  { "_id" : ObjectId("557e56287a8ea2a9dfe2ef71"), "name" : "中正區" },

  { "_id" : ObjectId("557e56287a8ea2a9dfe2ef72"), "name" : "信義區" },

  { "_id" : ObjectId("557e56287a8ea2a9dfe2ef73"), "name" : "內湖區" }

]

```



>DSL



```

@find 

[

  @count (db=user coll=user query={ height : { $gte : 200 } , postal_code : @._id })

  num

]

```



>執行 DSL 之後的結果



```javascript

[

  {

    "_id":{"$oid":"557e56287a8ea2a9dfe2ef71"},

    "name":"中正區",

    "num":3

  },

  {

    "_id":{"$oid":"557e56287a8ea2a9dfe2ef72"},

    "name":"信義區",

    "num":4

  },

  {

    "_id":{"$oid":"557e56287a8ea2a9dfe2ef73"},

    "name":"內湖區",

    "num":1

  }

]

```



#### Example 6  < info... >

>執行 db.postal_code.find({},{_id:0,code:0}) 的原始資料



```javascript

[

  { "country" : "TW", "city" : "557e55af7a8ea2a9dfe2ef70", "name" : "中正區" },

  { "country" : "TW", "city" : "557e55af7a8ea2a9dfe2ef70", "name" : "信義區" },

  { "country" : "TW", "city" : "557e55af7a8ea2a9dfe2ef70", "name" : "內湖區" }

]

```



>DSL



```

@find 

[

  @findOne (db=info coll=country query={ _id : @.country } projection={ _id : 0 })

  country



  @findOne (db=info coll=city query={ _id : { $oid : @.city } } projection={ _id : 0 , country : 0 })

  city

]

```



>執行 DSL 之後的結果



```javascript

[

  {

    "country":{"name":"臺灣"},

    "city":{"name":"臺北市"},

    "name":"中正區"

  },

  {

    "country":{"name":"臺灣"},

    "city":{"name":"臺北市"},

    "name":"信義區"

  },

  {

    "country":{"name":"臺灣"},

    "city":{"name":"臺北市"},

    "name":"內湖區"

  }

]

```



#### Example 7  [ info... ]

>執行 db.user.findOne({_id:ObjectId("557e58727a8ea2a9dfe2ef74")},{_id:0,name:1,friends:1}) 的原始資料



```javascript

{

  "name" : "Bill",

  "friends" : [

    ObjectId("557e58727a8ea2a9dfe2ef76"),

    ObjectId("557e58727a8ea2a9dfe2ef78"),

    ObjectId("557e58727a8ea2a9dfe2ef7e")]

}

```



>DSL



```

@findOne [db=user coll=user query={ _id : { $oid : "557e58727a8ea2a9dfe2ef74" } } projection={ _id : 0 , name : 1 , friends : 1 }]

<

  0 

  <

    @findOneById [db=user coll=user projection={ _id : 0 , name : 1 }]

    friends

  >

>

```



>執行 DSL 之後的結果



```javascript

[

  {

    "name":"Bill",

    "friends":[

      {"name":"Kirk"},

      {"name":"Noah"},

      {"name":"Andy"}]

  }

]

```



### 目前支援的 Action



#### DB Action

* @find

  * db

  * coll

  * index

  * projection

  * query

  * sort

  * skip

  * limit



* @findOne

  * db

  * coll

  * index

  * projection

  * query



* @findOneById

  * db

  * coll

  * index

  * projection



* @distinct

  * db

  * coll

  * index

  * key

  * query



* @count

  * db

  * coll

  * index

  * query



* @aggregate

  * db

  * coll

  * index

  * pipelines



* @findFirstOne

  * db

  * coll

  * index

  * projection

  * query

  * sort

  * skip

  

#### Data Action

  

* @fill

  * value



### 使用自訂 Action

>主要有二種方法可以選擇

* extends DslAction 將一群 Action 的集合打包成一個 Action

* extends DbAction 對單一個 DBColleciton 做自定的操作



#### Example 8  DslAction

>新增一個 EmbedPostalCode 類別



```java

package my.action;



import tw.com.ehanlin.mde.dsl.Dsl;

import tw.com.ehanlin.mde.dsl.action.data.DslAction;

import tw.com.ehanlin.mde.dsl.mongo.MdeDBObject;



public class EmbedPostalCode extends DslAction {



    private static Dsl _actionDsl;



    public EmbedPostalCode(Scope scope, MdeDBObject infos) {

        super(scope, infos);

    }



    @Override

    protected Dsl actionDsl() {

        if(_actionDsl == null) {

            _actionDsl = this.dsl().parser().parse("" +

                    "@findOne \n" +

                    "<\n" +

                    "  @findOneById \n" +

                    "  postal_code\n" +

                    "  <\n" +

                    "    @findOne \n" +

                    "    city\n" +

                    "    <\n" +

                    "      @findOneById \n" +

                    "      country\n" +

                    "    >\n" +

                    "  >\n" +

                    ">");

        }

        return _actionDsl;

    }



    @Override

    public String toString() {

        return toString("embedPostalCode");

    }

}

```



>註冊 EmbedPostalCode



```java

MongoEmbedder.dslParser.registerAction("embedPostalCode", my.action.EmbedPostalCode.class);

```



>DSL



```

@embedPostalCode []

[

  @findOneById [db=user coll=user projection={ _id : 0 , name : 1 }]

  friends

]

```



>執行 DSL



```java

  BasicDBList list = new BasicDBList();

  list.add("557e58727a8ea2a9dfe2ef76");

  list.add("557e58727a8ea2a9dfe2ef7a");

  MongoEmbedder.instance.embed(list, dsl);

```



>執行 DSL 之後的結果



```javascript

[

  {

    "_id":{"$oid":"557e58727a8ea2a9dfe2ef76"},

    "name":"Kirk",

    "postal_code":{

      "country":"TW",

      "city":{"country":{"name":"臺灣"},"name":"臺北市"},

      "code":"100",

      "name":"中正區"},

    "height":220,

    "friends":[

      {"name":"Bill"},

      {"name":"Mick"},

      {"name":"Rick"},

      {"name":"Andy"}]

  },

  {

    "_id":{"$oid":"557e58727a8ea2a9dfe2ef7a"},

    "name":"Rick",

    "postal_code":{

      "country":"TW",

      "city":{"country":{"name":"臺灣"},"name":"臺北市"},

      "code":"110",

      "name":"信義區"},

    "height":218,

    "friends":[

      {"name":"Kirk"},

      {"name":"Toby"},

      {"name":"Andy"}]

  }

]

```



#### Example 9  Custom Action

>新增一個 FindLimit2 類別



```java

package my.action;



import com.mongodb.BasicDBList;

import com.mongodb.DBCollection;

import com.mongodb.DBCursor;

import com.mongodb.DBObject;

import tw.com.ehanlin.mde.dsl.action.db.DbAction;

import tw.com.ehanlin.mde.dsl.mongo.MdeDBObject;

import tw.com.ehanlin.mde.util.DataStack;

import tw.com.ehanlin.mde.util.EmptyObject;



public class FindLimit2 extends DbAction {



    public static final String KEY_QUERY = "query";



    public FindLimit2(Scope scope, MdeDBObject infos) {

        super(scope, infos);

    }



    public DBObject query(DataStack data) {

        Object _query = evalInfo(KEY_QUERY, data);

        return (DBObject)((_query != null) ? _query : EmptyObject.BasicDBObject);

    }



    @Override

    public String toString() {

        return toString("findLimit2",

                KEY_DB, infos().get(KEY_DB),

                KEY_COLL, infos().get(KEY_COLL),

                KEY_QUERY, infos().get(KEY_QUERY));

    }



    @Override

    protected String cacheKey(DataStack data, String prefix) {

        return prefix+query(data);

    }



    @Override

    protected Object executeObject(DataStack data, DBCollection coll) {

        BasicDBList result = new BasicDBList();

        DBCursor cursor = coll.find(query(data)).limit(2);

        while(cursor.hasNext()){

            result.add(cursor.next());

        }

        cursor.close();

        return result;

    }



}

```



>註冊 EmbedPostalCode



```java

MongoEmbedder.dslParser.registerAction("findLimit2", my.action.FindLimit2.class);

```



>執行 db.user.find({height:{$gte:210}}) 的原始資料共 3 筆



```javascript

[

  {

    "_id" : ObjectId("557e58727a8ea2a9dfe2ef76"),

    "name" : "Kirk",

    "postal_code" : ObjectId("557e56287a8ea2a9dfe2ef71"),

    "height" : 220,

    "friends" : [

      ObjectId("557e58727a8ea2a9dfe2ef74"),

      ObjectId("557e58727a8ea2a9dfe2ef77"),

      ObjectId("557e58727a8ea2a9dfe2ef7a"),

      ObjectId("557e58727a8ea2a9dfe2ef7e")]

  },

  {

    "_id" : ObjectId("557e58727a8ea2a9dfe2ef7a"),

    "name" : "Rick",

    "postal_code" : ObjectId("557e56287a8ea2a9dfe2ef72"),

    "height" : 218,

    "friends" : [

      ObjectId("557e58727a8ea2a9dfe2ef76"),

      ObjectId("557e58727a8ea2a9dfe2ef7c"),

      ObjectId("557e58727a8ea2a9dfe2ef7e")]

  },

  {

    "_id" : ObjectId("557e58727a8ea2a9dfe2ef7c"),

    "name" : "Toby",

    "postal_code" : ObjectId("557e56287a8ea2a9dfe2ef72"),

    "height" : 214,

    "friends" : [

      ObjectId("557e58727a8ea2a9dfe2ef7a")]

  }

]

```



>DSL



```

@findLimit2 

[

  @findOneById [db=info coll=postal_code projection={ _id : 0 , name : 1 }]

  postal_code

]

```



>執行 DSL 之後的結果，會被 limit 限制到 2 筆資料



```javascript

[

  {

    "_id":{"$oid":"557e58727a8ea2a9dfe2ef76"},

    "name":"Kirk",

    "postal_code":[{"name":"中正區"}],

    "height":220,

    "friends":[

      {"$oid":"557e58727a8ea2a9dfe2ef74"},

      {"$oid":"557e58727a8ea2a9dfe2ef77"},

      {"$oid":"557e58727a8ea2a9dfe2ef7a"},

      {"$oid":"557e58727a8ea2a9dfe2ef7e"}]

  },

  {

    "_id":{"$oid":"557e58727a8ea2a9dfe2ef77"},

    "name":"Mick",

    "postal_code":[{"name":"中正區"}],

    "height":211,

    "friends":[

      {"$oid":"557e58727a8ea2a9dfe2ef76"}]

  }

]

```