Na tej stronie dowiesz się, jak zaplanować eksportowanie danych Cloud Firestore. Aby uruchamiać eksporty zgodnie z harmonogramem, zalecamy używanie Cloud Functions i Cloud Scheduler.
Zanim zaczniesz
Zanim zaplanujesz eksportowanie zarządzanych danych, musisz wykonać te czynności:
- Włącz płatności w projekcie Google Cloud. Z funkcji eksportowania i importowania mogą korzystać tylko projekty Google Cloud z włączonymi płatnościami.
- Operacje eksportowania wymagają zasobnika docelowego Cloud Storage. Utwórz Cloud Storagezasobnik w lokalizacji w pobliżu Cloud Firestorelokalizacji bazy danych. Nie możesz używać zasobnika Żądający płaci do operacji eksportu.
Tworzenie funkcji w Cloud Functions i zadania Cloud Scheduler
Aby utworzyć funkcję Cloud Functions w Node.js, która inicjuje eksportowanie danych Cloud Firestore i zadanie Cloud Scheduler wywołujące tę funkcję, wykonaj te czynności:
wiersz poleceń Firebase
-
Zainstaluj wiersz poleceń Firebase. W nowym katalogu zainicjuj interfejs wiersza poleceń dla Cloud Functions:
firebase init functions --project PROJECT_ID
- Wybierz JavaScript jako język.
- Opcjonalnie włącz ESLint.
- Wpisz
y
, aby zainstalować zależności.
-
Zastąp kod w pliku
functions/index.js
tym kodem:const functions = require('firebase-functions'); const firestore = require('@google-cloud/firestore'); const client = new firestore.v1.FirestoreAdminClient(); // Replace BUCKET_NAME const bucket = 'gs://BUCKET_NAME'; exports.scheduledFirestoreExport = functions.pubsub .schedule('every 24 hours') .onRun((context) => { const projectId = process.env.GCP_PROJECT; const databaseName = client.databasePath(projectId, '(default)'); return client.exportDocuments({ name: databaseName, outputUriPrefix: bucket, // Leave collectionIds empty to export all collections // or set to a list of collection IDs to export, // collectionIds: ['users', 'posts'] collectionIds: [] }) .then(responses => { const response = responses[0]; console.log(`Operation Name: ${response['name']}`); }) .catch(err => { console.error(err); throw new Error('Export operation failed'); }); });
-
W powyższym kodzie zmień te elementy:
- Zastąp
BUCKET_NAME
nazwą zasobnika. - Zmodyfikuj
every 24 hours
, aby ustawić harmonogram eksportu. Użyj składni pliku cron.yaml App Engine lub formatu unix-cron (* * * * *
). -
Zmodyfikuj wartość
collectionIds: []
, aby wyeksportować tylko określone grupy kolekcji. Aby wyeksportować wszystkie kolekcje, pozostaw to pole bez zmian.
- Zastąp
-
Wdróż zaplanowaną funkcję:
firebase deploy --only functions
Google Cloud Console
Utwórz funkcję w Cloud Functions
-
Otwórz stronę Cloud Functions w konsoli Google Cloud:
- Kliknij Utwórz funkcję.
- Wpisz nazwę funkcji, np.
firestoreExport
. - W sekcji Aktywator wybierz Cloud Pub/Sub.
- W sekcji Temat wybierz Utwórz nowy temat. Wpisz nazwę tematu Pub/Sub, np.
initiateFirestoreExport
. Zanotuj nazwę tematu, ponieważ będzie Ci potrzebna do utworzenia zadania Cloud Scheduler. - W sekcji Kod źródłowy wybierz Edytor wbudowany. Wpisz ten kod w sekcji
index.js
: W powyższym kodzie zmień te elementy:const firestore = require('@google-cloud/firestore'); const client = new firestore.v1.FirestoreAdminClient(); // Replace BUCKET_NAME const bucket = 'gs://BUCKET_NAME' exports.scheduledFirestoreExport = (event, context) => { const databaseName = client.databasePath( process.env.GCP_PROJECT, '(default)' ); return client .exportDocuments({ name: databaseName, outputUriPrefix: bucket, // Leave collectionIds empty to export all collections // or define a list of collection IDs: // collectionIds: ['users', 'posts'] collectionIds: [], }) .then(responses => { const response = responses[0]; console.log(`Operation Name: ${response['name']}`); return response; }) .catch(err => { console.error(err); }); };
- Zastąp
BUCKET_NAME
nazwą zasobnika. -
Zmodyfikuj wartość
collectionIds: []
, aby wyeksportować tylko określone grupy kolekcji. Aby wyeksportować wszystkie kolekcje, pozostaw to pole bez zmian.
- Zastąp
- W sekcji
package.json
dodaj tę zależność:{ "dependencies": { "@google-cloud/firestore": "^1.3.0" } }
- W polu Funkcja do wykonania wpisz
scheduledFirestoreExport
, czyli nazwę funkcji windex.js
. - Aby wdrożyć funkcję Cloud, kliknij Utwórz.
Tworzenie zadania Cloud Scheduler
Następnie utwórz zadanie Cloud Scheduler, które wywołuje funkcję w Cloud Functions:
-
W konsoli Google Cloud otwórz stronę Cloud Scheduler:
- Kliknij Utwórz zadanie.
- Wpisz nazwę zadania, np.
scheduledFirestoreExport
. - Wpisz częstotliwość, np.
every 24 hours
. - Wybierz strefę czasową.
- W sekcji Miejsce docelowe wybierz Pub/Sub. W polu Temat wpisz nazwę tematu Pub/Sub zdefiniowanego razem z funkcją w Cloud Functions,
initiateFirestoreExport
jak w przykładzie powyżej. - W polu Payload (Ładunek) wpisz
start export
. Zadanie wymaga zdefiniowania ładunku, ale powyższa funkcja w Cloud Functions nie używa tej wartości. - Kliknij Utwórz.
Konfigurowanie uprawnień dostępu
Następnie przyznaj funkcji w Cloud Functions uprawnienia do rozpoczynania operacji eksportowania i zapisu w zasobniku GCS.
Ta funkcja w Cloud Functions używa domyślnego konta usługi projektu do uwierzytelniania i autoryzowania operacji eksportowania. Gdy utworzysz projekt, zostanie dla Ciebie utworzone domyślne konto usługi o tej nazwie:
PROJECT_ID@appspot.gserviceaccount.com
To konto usługi wymaga uprawnień do rozpoczęcia operacji eksportowania i do zapisu w zasobniku Cloud Storage. Aby przyznać te uprawnienia, przypisz do domyślnego konta usługi te role uprawnień:
Cloud Datastore Import Export Admin
-
rolę
Owner
lubStorage Admin
w przypadku zasobnika.
Do przypisywania tych ról możesz używać narzędzi wiersza poleceń gcloud
i gsutil
.
Jeśli nie są jeszcze zainstalowane, możesz uzyskać do nich dostęp w konsoli Google Cloud, klikając Cloud Shell:
Uruchom Cloud Shell
-
Przypisz rolę Administrator eksportu i importu w Cloud Datastore. Zastąp PROJECT_ID i uruchom to polecenie:
gcloud projects add-iam-policy-binding PROJECT_ID \ --member serviceAccount:PROJECT_ID@appspot.gserviceaccount.com \ --role roles/datastore.importExportAdmin
-
Przypisz rolę Administrator pamięci masowej w zasobniku. Zastąp PROJECT_ID i BUCKET_NAME i uruchom to polecenie:
gsutil iam ch serviceAccount:PROJECT_ID@appspot.gserviceaccount.com:admin \ gs://BUCKET_NAME
Jeśli wyłączysz lub usuniesz App Enginedomyślne konto usługi, TwojaApp Engine aplikacja utraci dostęp do bazy danych Cloud Firestore. Jeśli wyłączysz konto usługi App Engine, możesz je ponownie włączyć. Zobacz włączanie konta usługi. Jeśli konto usługi App Engine zostało usunięte w ciągu ostatnich 30 dni, możesz je przywrócić. Więcej informacji znajdziesz w artykule przywracanie usuniętego konta usługi.
Przetestuj zadanie Cloud Scheduler i funkcję w Cloud Functions.
Możesz przetestować zadanie na stronie Cloud SchedulerCloud Scheduler w konsoli Google Cloud.
W konsoli Google Cloud otwórz stronę Cloud Scheduler.
Otwórz Cloud SchedulerW wierszu nowego zadania Cloud Scheduler kliknij Uruchom teraz.
Po kilku sekundach zadanie Cloud Scheduler powinno zaktualizować kolumnę wyniku do wartości Sukces, a kolumnę Ostatnie uruchomienie do bieżącego czasu. Może być konieczne kliknięcie Odśwież.
Strona Cloud Scheduler potwierdza tylko, że zadanie wywołało Twoją funkcję w Cloud Functions. Otwórz stronę Cloud Functions, aby wyświetlić logi funkcji.
Wyświetlanie logów funkcji w Cloud Functions
Aby sprawdzić, czy funkcja Cloud Function rozpoczęła operację eksportu, otwórz logi funkcji:
Konsola Firebase
W konsoli Firebase otwórz stronę Cloud Functions.
konsola GCP
W konsoli Google Cloud otwórz stronę Cloud Functions.
Wyświetlanie postępu eksportu
Aby wyświetlić postęp operacji eksportowania, możesz użyć polecenia gcloud firestore operations list
. Więcej informacji znajdziesz w artykule Zarządzanie operacjami eksportowania i importowania.
Po zakończeniu operacji eksportowania możesz wyświetlić pliki wyjściowe w swoim zasobniku Cloud Storage:
Otwórz Cloud Storage przeglądarkę