NCMB Python SDK

ニフクラmobile backendを利用するためのPython SDKです。

使い方

インポート

pip install NCMB

初期化

from NCMB.Client import NCMB
ncmb = NCMB('YOUR_APPLICATION_KEY', 'YOUR_CLIENT_KEY')

データストア

データ保存

obj = ncmb.Object('Python')
obj.set(
  'message', 'Hello from Python'
).set(
  'message2', 'Hello from Python'
).set(
  'number', 100
).save()

カラムへのアクセスはgetを使います。

print(obj.get('objectId'))
# -> 5CN1U23KLd6zatu8など

データ検索

query = ncmb.Query('Python')
query.equal_to('number', 100)
ary = query.fetch_all()

検索用メソッドについて

検索条件は以下に対応しています。

equal_to(self, key, value):
greater_than_or_equal_to(self, key, value):
not_equal_to(self, key, value):
less_than(self, key, value):
less_than_or_equal_to(self, key, value):
greater_than(self, key, value):
in_value(self, key, values):
not_in(self, key, values):
exists(self, key, exist = True):
regular_expression_to(self, key, regex):
in_array(self, key, values):
not_in_array(self, key, values):
all_in_array(self, key, values):

このほか limit / order / skip で並び替えやデータの取得件数の変更を行えます。

query.limit(1)  # 取得件数指定
query.order('updateDate') # 並び替え
query.skip(100) # スキップする件数

ACL

ACLはNCMBAclを使います。

acl = ncmb.Acl()

メソッドは下記が用意されています。

• set_public_read_access(self, bol):
• set_public_write_access(self, bol):
• set_user_read_access(self, user, bol):
• set_user_write_access(self, user, bol):
• set_role_read_access(self, role, bol):
• set_role_write_access(self, role, bol):

権限を適用した後、setで設定してください。

obj.set('acl', acl)

位置情報

位置情報の保存はNCMBGeoPointを使います。

geo = ncmb.GeoPoint(35.658611, 139.745556)

ポインタ

オブジェクトどうしの関連付けはポインタを利用します。NCMBObjectを関連付けてください。

obj1 = ncmb.Object('Test1')
obj2 = ncmb.Object('Test2')

obj2.set('obj', obj1)
obj2.save()

LICENSE

MIT.