Monaca Docs
検索…
Cordova Sqlite Storage プラグイン
この Cordova プラグインは、HTML5/Web SQL API を使用して Android、iOS、Windows 上で sqlite データベースを開き、使用します。
サードパーティー製 Cordova プラグインを確認する場合は、カスタムビルドデバッガー ( Android 版 または iOS 版 ) を作成する必要があります。

デモ

Monaca クラウド IDE でプラグインを有効にする

  1. 1.
    IDE メニューから設定 → Cordova プラグインの管理へ移動します。
  2. 2.
    Cordova プラグインのインポートボタンをクリックします。 次に、[ZIP ファイル] または [パッケージ名 / URL] を使用してプラグインをインポートします。

使い方

プラグインをプロジェクトへインポート後、データベースの初期化を開始できます。[deviceready] イベント後にプラグイン API を使用します。
1
var database = null;
2
3
document.addEventListener("deviceready", function(){
4
// Initialize the database after the Cordova is ready.
5
initDatabase();
6
});
7
8
function initDatabase() {
9
database = window.sqlitePlugin.openDatabase({name: 'sample.db', location: 'default'});
10
11
database.transaction(function(transaction) {
12
transaction.executeSql('CREATE TABLE SampleTable (name, score)');
13
});
14
}
Copied!

API リファレンス

ここでは、デモ で使用されている主な API について説明します。 完全なAPIリファレンスについては、こちら を参照してください。

セルフテスト 機能

echoTest()

このプラグインの Javascript とネイティブ部分の両方がアプリにインストールされていることを確認してください。
1
window.sqlitePlugin.echoTest(successCallback, errorCallback);
Copied!
戻り値
  • Promise

selfTest()

プラグインがデータベースを開き、CRUD (作成、読み取り、更新、削除) 操作を実行し、正しくクリーンアップできることを確認します。
1
window.sqlitePlugin.selfTest(successCallback, errorCallback);
Copied!
戻り値
  • Promise

データベースの操作

データベースオブジェクトを開きます。
1
window.sqlitePlugin.openDatabase({name: String, [location: String],
2
[iosDatabaseLocation: String]}, [successCallback], [errorCallback]);
Copied!
パラメーター
パラメーター名
説明
name
String
データベースの名前
location
String
[オプション] データベースの場所
iosDatabaseLocation
String
[オプション] iOSデータベースの場所。
  • default: Library/LocalDatabase サブディレクトリ - iTunes には表示されず、iCloud によってバックアップされません。
  • Library: Library サブディレクトリ - iCloud によってバックアップされ、iTunes には表示されません。
  • Documents: Documents サブディレクトリ - iTunesに表示され、iCloudによってバックアップされる
戻り値
  • Promise
既定または指定された場所でデータベースアクセスハンドルオブジェクトを開く例:
1
// use the default location
2
var database = window.sqlitePlugin.openDatabase({name: 'my.db', location: 'default'});
3
4
// use a specified location for iOS only
5
var database = window.sqlitePlugin.openDatabase({name: 'my.db', iosDatabaseLocation: 'Library'});
Copied!
success および error コールバックパラメーターはオプションですが、問題が発生した場合に非常に役立ちます。 例:
1
window.sqlitePlugin.openDatabase({name: 'my.db', location: 'default'}, function(db) {
2
db.transaction(function(tx) {
3
// ...
4
}, function(err) {
5
console.log('Open database ERROR: ' + JSON.stringify(err));
6
});
7
});
Copied!

SQL トランザクション

開いているデータベースで SQL を実行します。
1
database.executeSql(SQL_STATEMENT: String, [] , [successCallback], [errorCallback]);
Copied!
戻り値
  • Promise
1
database.transaction(function(transaction) {
2
transaction.executeSql('SELECT count(*) AS recordCount FROM SampleTable', [], function(ignored, resultSet) {
3
$('#result').text('RECORD COUNT: ' + resultSet.rows.item(0).recordCount);
4
});
5
}, function(error) {
6
alert('SELECT count error: ' + error.message);
7
});
Copied!
1
database.transaction(function(transaction) {
2
transaction.executeSql('DELETE FROM SampleTable');
3
}, function(error) {
4
alert('DELETE error: ' + error.message);
5
}, function() {
6
alert('DELETE OK');
7
});
Copied!

データベースの削除

データベースオブジェクトを削除します。
1
window.sqlitePlugin.deleteDatabase({name: String, [location: String],
2
[iosDatabaseLocation: String]}, [successCallback], [errorCallback]);
Copied!
パラメーター
パラメーター名
説明
name
String
データベースの名前
location
String
[オプション] データベースの場所
iosDatabaseLocation
String
[オプション] iOSデータベースの場所。
  • default: Library/LocalDatabase サブディレクトリ - iTunes には表示されず、iCloud によってバックアップされません。
  • Library: Library サブディレクトリ - iCloud によってバックアップされ、iTunes には表示されません。
  • Documents: Documents サブディレクトリ - iTunesに表示され、iCloudによってバックアップされる
戻り値
  • Promise
1
// use the default location
2
window.sqlitePlugin.deleteDatabase({name: 'my.db', location: 'default'}, successcb, errorcb);
3
4
// use a specified location for iOS only
5
window.sqlitePlugin.deleteDatabase({name: 'my.db', iosDatabaseLocation: 'Library'});
Copied!
最終更新 3mo ago