メインコンテンツまでスキップ

データストアの操作

データストアはクラウドで提供されるデータベースです。管理画面上でフィールドの設計を行い、APIを利用してデータのCRUD操作を行うことができます。

データストアはプロジェクトの中に存在します。プロジェクトは複数のデータストアを管理できます。

プロジェクト配下のデータストアを取得​

プロジェクトの中にある全データストアを取得します。

const datastores = await project.datastores();

特定のデータストアを取得​

特定のデータストアを取得する場合には、データストアIDを指定します。

const datastore = await project.datastore('DATASTORE_ID');

新規のデータストアを作成​

新規データストアを作成する場合には、引数なしで datastore を実行します。

const newDatastore = await project.datastore();
newDatastore.name = {
    ja: '新しいデータストア',
    en: 'new datastore'
};

データストアの保存​

データストアの保存は、save メソッドを実行します。

await newDatastore.save();

データストアの更新​

データストアの更新も、save メソッドを実行します。

newDatastore.name = {
    ja: '更新されたデータストア',
    en: 'updated datastore'
};
await newDatastore.save();

データストアの削除​

データストアを削除する場合には、delete メソッドを実行します。

await newDatastore.delete();

フィールドの取得​

データストアの中にある全フィールドを取得します。

const fields = await datastore.fields();

特定のフィールドを取得​

特定のフィールドを取得する場合には、フィールドIDを指定します。

const field = await datastore.field('FIELD_ID');

操作アクションを取得​

管理画面で設定した操作アクションを取得します。

const actions = await datastore.actions();

特定の操作アクションを取得​

特定の操作アクションを取得する場合には、操作アクションIDを指定します。

const action = await datastore.action('ACTION_ID');

ステータス一覧を取得​

管理画面で設定したステータス一覧を取得します。

const statuses = await datastore.statuses();

データストアのアイテムを取得​

データストアに保存されているアイテムを検索します。 params はオプションです。

const items = await datastore.items(params);

指定できる条件は ItemList | Hexabase API ガイド にて定義されています。

検索結果の件数も取得​

検索結果の件数も取得します。

const { items, totalCount } = await datastore.itemsWithCount(params);