データ移行スクリプト実行手順

ニフクラmobile backendからFirebase Firestoreにデータを移行するためのスクリプトを実行する手順を説明します。

本スクリプトは、Firestoreのコレクションにデータを追加します。必ずテスト環境でお試しの上、本番環境へのデータインポートをお願いします。

必要条件

  • Node.jsがインストールされた環境: このプロジェクトを進めるためには、Node.jsがインストールされている環境が必須です。手順1では、Node.jsのインストールリンクを案内しています。

  • Firebase Admin SDKの設定ファイル: Firebase Admin SDKを使用するためには、設定ファイルが必要です。手順2では、Firebase Admin SDKの設定ファイルの準備方法を案内します。

手順

1. 環境準備

  • Node.jsがまだインストールされていない場合は、Node.js公式サイトからインストールしてください。

2. Firebase Admin SDKの設定

  • Firebaseプロジェクトにアクセスし、Firebase Admin SDKの設定ファイル（firebase-adminsdk.json）をダウンロードします。

  • ダウンロードしたファイルを、後で作成するスクリプトファイルと同じディレクトリに配置します。

Firebase Admin SDKの作成

3. データファイルの準備

  • ニフクラmobile backendからエクスポートしたJSON形式のデータファイル（例：import.json）を用意します。

  • このファイルもスクリプトファイルと同じディレクトリに配置します。

4. スクリプトの作成

  • 以下のスクリプトをmigrate.jsとして新しいファイルとして保存します。

const admin = require('firebase-admin');
const fs = require('fs');

// Firebaseの設定 ※ダウンロードした Firebase Admin SDKの設定ファイル名に変更してください
const serviceAccount = require('./serviceAccountKey.json');
admin.initializeApp({
  credential: admin.credential.cert(serviceAccount)
});

const db = admin.firestore();

// JSONファイルの読み込み (※ ファイル名は、import.jsonにしています。)
const data = JSON.parse(fs.readFileSync('import.json', 'utf8'));

// Firestoreにデータをインポート
data.results.forEach(async (item) => {
  // aclフィールドを削除
  delete item.acl;

  // createDateとupdateDateを文字列形式に変換
  if (item.createDate && item.createDate.iso) {
    item.createDate = item.createDate.iso;
  }
  if (item.updateDate && item.updateDate.iso) {
    item.updateDate = item.updateDate.iso;
  }
  
  // ※コレクション名は任意の名前に変更してください
  await db.collection('yourCollectionName').doc(item.objectId).set(item)
    .then(() => console.log(`Document ${item.objectId} successfully written!`))
    .catch((error) => console.error("Error writing document: ", error));
});

5. 必要なパッケージのインストール

  • コマンドラインまたはターミナルを開き、スクリプトファイルが保存されているディレクトリに移動します。

  • 次のコマンドを実行して、必要なパッケージをインストールします。

    npm install firebase-admin

6. スクリプトの実行

  • 以下のコマンドを実行してスクリプトを実行します。

    node migrate.js

  • スクリプトが正常に実行されると、コンソールに成功メッセージが表示されます。

7. Firebaseコンソールでの確認

スクリプトの実行結果をFirebaseコンソール上で確認してください。インポートが成功すると、Firebaseコンソール上で次のように確認できます。

移行スクリプトでは、ニフクラmobile backendのユニークなIDである「objectId」を、Firestoreコレクションのフィールドとして「objectId」という名前でインポートしています。これにより、ニフクラmobile backendで使用されているデータの識別子をFirestoreでも同様に利用できるようになります。

注意点

  • ニフクラ mobile backendからエクスポートしたファイルは、上記のスクリプトではimport.jsonというファイル名で扱っています。

  • 'yourCollectionName'は、Firebase Firestore内で使用したいコレクションの名前に置き換えてください。

  • スクリプト実行中にエラーが発生した場合は、エラーメッセージを確認し、適切に対処してください。

移行スクリプトで実施しているデータ変換について

スクリプトでは、ニフクラmobile backendからエクスポートしたデータをFirestoreに適した形式に変換しています。具体的に行われている変換処理は以下の通りです。

1. aclフィールドの削除

ニフクラmobile backendのデータに含まれるacl（Access Control List）フィールドは、データのアクセス権限を定義しています。Firestoreには異なる権限管理システムがあるため、このaclフィールドはFirestoreに移行する際に不要となります。そのため、このフィールドを各データ項目から削除しています。

delete item.acl;

2. createDateとupdateDateの変換

ニフクラmobile backendのデータでは、createDateとupdateDateはオブジェクト形式で、isoプロパティに日付の文字列が格納されています。例えば、以下のような構造です。

"createDate": {
  "iso": "2023-12-18T05:04:58.950Z"
}

Firestoreでは、日付をより直接的な形式（単なる文字列）で保存するのが一般的です。そのため、スクリプトではこれらのフィールドを文字列に変換しています。具体的には、isoプロパティの値を直接createDateとupdateDateフィールドに設定しています。

if (item.createDate && item.createDate.iso) {
  item.createDate = item.createDate.iso;
}
if (item.updateDate && item.updateDate.iso) {
  item.updateDate = item.updateDate.iso;
}
前へデータの移行次へ会員管理・認証

最終更新