KEK IMSS SBRC/PF Experimental Data Management System
Project description
KEK IMSS SBRC/PF Experimental Data Management System.
jsonファイル(階層構造になった実験データ等)を親子構造を解析し、MongoDBに投入します。
Requirement
pymongo
python-dateutil
jmespath
and MongoDB.
Modules Usage
◯Create
import json from edman import DB, Convert # Load json into a dictionary json_dict = json.load(json_file) # json to json for edman convert = Convert() converted_edman = convert.dict_to_edman(json_dict) # insert con = {'port':'27017', 'host':'localhost', 'user':'mongodb_user_name', 'password':'monogodb_user_password', 'database':'database_name', 'options':['authSource=auth_database_name']} db = DB(con) result = db.insert(converted_edman)
◯Read
from path import Path from edman import DB, JsonManager, Search con = {'port':'27017', 'host':'localhost', 'user':'mongodb_user_name', 'password':'monogodb_user_password', 'database':'database_name', 'options':['authSource=auth_database_name']} db = DB(con) search = Search(db) collection = 'target_collection' # Same syntax as pymongo's find query query = {'_id':'OBJECTID'} # example, 2 top levels of parents and 3 lower levels of children (ref mode) search_result = search.find(collection, query, parent_depth=2, child_depth=3) # Save search results dir = Path('path_to') jm = JsonManager() jm.save(search_result, dir, name='filename', date=True)
◯Update
import json from edman import DB modified_data = json.load(modified_json_file) # emb example # Same key will be modified, new key will be added # modified_data = {'key': 'modified value', 'child': {'key': 'value'}} # ref example # Same key will be modified, new key will be added # modified_data = {'key': 'modified value', 'new_key': 'value'} con = {'port':'27017', 'host':'localhost', 'user':'mongodb_user_name', 'password':'monogodb_user_password', 'database':'database_name', 'options':['authSource=auth_database_name']} db = DB(con) result = db.update(collection, objectid, modified_data, structure='ref')
◯Delete
from edman import DB con = {'port':'27017', 'host':'localhost', 'user':'mongodb_user_name', 'password':'monogodb_user_password', 'database':'database_name', 'options':['authSource=auth_database_name']} db = DB(con) result = db.delete(objectid, collection, structure='ref')
Json Format
example
{ "Beamtime": [ { "date": {"#date": "2019-09-17"}, "expInfo":[ { "time": {"#date": "2019/09/17 13:21:45"}, "int_value": 135, "float_value":24.98 }, { "time": {"#date": "2019/09/17 13:29:12"}, "string_value": "hello world" } ] }, { "date": {"#date": "2019-09-18"}, "expInfo":[ { "array_value": ["string", 1234, 56.78, true, null], "Bool": false, "Null type": null } ] } ] }
#date{}で囲むと日付書式がdatetime型に変換されます。書式はdateutilと同等。
使用できる型はjsonに準拠。整数、浮動小数点数、ブール値、null型、配列も使用可。
jsonのオブジェクト型はEdmanでは階層構造として認識されます。
予約コレクション名
・他ドキュメントのリファレンスと同じ名前(_ed_parent,_ed_child,_ed_file) ※システム構築時にのみ変更可
予約フィールド名
・日付表現の変換に使用(#date) ※システム構築時にのみ変更可
・ObjectIdと同じフィールド名(_id)
その他MongoDBで禁止されているフィールド名は使用不可
MongoDBの1つのドキュメントの容量上限は16MBですが、
emb形式の場合はObjectId及びファイル追加ごとのリファレンスデータを含むため、16MBより少なくなります。
ref形式の場合は1階層につきObjectId、及びroot(一番上の親)以外は親への参照もデフォルトで含め、子要素やファイルが多いほど参照が増えるため16MBより少なくなります。
◯emb(Embedded)とref(reference)について
embはjsonファイルの構造をそのままドキュメントとしてMongoDBに投入します。
・親子構造を含め全て一つのコレクションに保存します。
refはjsonの親子構造を解析し、オブジェクト単位をコレクションとし、親子それぞれをドキュメントとして保存します。
・親子関係はリファレンスによって繋がっているので指定のツリーを呼び出すことができます。
◯型変換について
・DB.bson_type()にて値の型変換を行うことができます
・DB内のすべてのコレクションが変換されます
・DBにあってJSONファイルにないキーは無視されます
・型一覧にない型を指定した時はstrに変換します
・型一覧:
[int,float,bool,str,datetime]
・値がリストの時
・双方どちらかがリストでない時は無視
・JSON側が単一、DB側が複数の時は単一の型で全て変換する
JSON:[‘str’]
DB:[‘1’,’2’,’3’]
・JSON側よりDB側が少ない時はJSON側は切り捨て
JSON:[‘str’、’int’, ‘int’]
DB:[‘1’,2]
・JSON側よりDB側が多い時は、リストの最後の型で繰り返す
JSON:[‘str’、’int’]
DB:[‘1’,2,3,4,5]
・型変換用の辞書の例:
{ "コレクション名":{ "キー": "変更する型", "キー2": "変更する型", }, "コレクション名2":{ "キー": ["変更する型","変更する型"], } }
Scripts Usage
コマンドライン用実行スクリプトはedman_cliを利用してください
Install
Please install MongoDB in advance.
pip install:
pip install edman
Licence
MIT
API Document
PyPI Project
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
edman-2023.11.2.tar.gz
(65.7 kB
view hashes)
Built Distribution
edman-2023.11.2-py3-none-any.whl
(43.5 kB
view hashes)
Close
Hashes for edman-2023.11.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 624ef81383af922191f06ffb5f089b31967120dd2b0525d82afefc3c64dfa399 |
|
MD5 | 58f7225734cf6a92444a1fc05e1e5331 |
|
BLAKE2b-256 | 7b1dad4ac50471061c4299c0c23368e86d49a72c0791aaae492c40ff9dd8b1df |