レコードを操作する（データベースプラグイン）

ここでは、サイトアカウントに存在するデータベースインスタンスを、SDKから操作する方法について解説します。

レコードオブジェクトECHO.Databases.RecordObject

RecordObjectは、個別レコードを操作するためのオブジェクトです。

オブジェクトを生成する

新しいレコードをオブジェクトとして生成するには、コンストラクタの第一引数にデータベースインスタンスのIDを指定します。

var record = new ECHO.Databases.RecordObject("データベースインスタンスID");

既存レコードをオブジェクトとして生成するには、コンストラクタの第二引数にレコードIDを指定します。

var record = new ECHO.Databases.RecordObject("データベースインスタンスID", "レコードID");

オブジェクトフィールド

レコードオブジェクトは、以下のフィールドを持ちます。

フィールド名	型	説明	可変
refid	String	レコードID	◯
url	String	URL	×
url_path	String	URLパス	×
title	String	レコードタイトル	◯
description	String	概要	◯
keywords	String	キーワード	◯
robots	String	検索エンジンロボット制御	◯
contents	Object	レコードコンテンツ	◯
link_status	Number	リンク設定値 1：通常リンク 2：セキュアリンク -1：リンクしない	◯
modified	Date	最終更新日時	×
created	Date	作成日時	×
categories	Array <ECHO.ContentsCategoryObject>	所属カテゴリ	◯

フィールドからデータを取得する

フィールドからデータを取得する場合は、getメソッドを使用します。

var title = record.get("title");

フィールドにデータをセットする

オブジェクトのフィールドにデータをセットするには、putメソッドを使用します。

record.put("title", "新しいレコード");

record.put("contents", {name:"レコードコンテンツです。"});

レコードを保存する

リモートサーバーへレコードを保存するには、pushメソッドを使用します。

var record = new ECHO.Databases.RecordObject("データベースインスタンスID");

record.put("title", "新しいレコード"); // レコードのタイトルをセット
record.put("refid", "record_xyz"); // レコードIDをセット
....

// レコードを保存
var promise = record.push();

// コールバックを定義
promise.then(function(success) { // 成功時
console.log("Complete: " + success);
}, function(error) { // 失敗時
console.log("Complete: " + error);
});

レコードを取得する

リモートサーバー上に存在するレコードを取得するには、fetchメソッドを使用します。

var record = new ECHO.Databases.RecordObject("データベースインスタンスID", "レコードID");

// レコードを取得
var promise = record.fetch();

// コールバックを定義
promise.then(function(success) { // 成功時
console.log("Complete: " + success);
}, function(error) { // 失敗時
console.log("Complete: " + error);
});

レコードを削除する

リモートサーバー上に存在するレコードを削除するには、deleteメソッドを使用します。

var record = new ECHO.Databases.RecordObject("データベースインスタンスID", "レコードID");

// レコードを削除

var promise = record.delete();

// コールバックを定義
promise.then(function(success) { // 成功時
console.log("Complete: " + success);
}, function(error) { // 失敗時
console.log("Complete: " + error);
});

レコードを検索する

レコードを検索するには、ECHO.Databases.findメソッドを使用します。
第二引数にリスト制御パラメータを与えることで、データの検索・抽出条件を指定することが可能です。

// レコード一覧を取得
var promise = ECHO.Databases.find("データベースインスタンスID", {q:"検索キーワード"});

// コールバックを定義
promise.then(function(success) { // 成功時
console.log("Complete: " + success);
}, function(error) { // 失敗時
console.log("Complete: " + error);
});

現在のACLを取得する

オブジェクトに現在設定されているACLを取得するには、getACLメソッドを使用します。

var current_acl = record.getACL();

ACLを変更する

オブジェクトに新しいACLを設定するには、setNewACLメソッドを使用します。

var new_acl = new ECHO.ACL(); // ACLオブジェクトを生成
new_acl.putEntryForAll(new ECHO.ACL.Entry(false, false, false, false)); // 例：非ログイン訪問者の操作権限を全て奪う

record.setNewACL(new_acl); // 新しいACLをセット

record.push(); // セットしたACLを反映させるには、最後に必ず保存を実行してください