Na tej stronie znajdują się przykłady użycia Dataflow do wykonywania zbiorczych operacji Cloud Firestore w potoku Apache Beam. Apache Beam obsługuje łącznik dla Cloud Firestore. Za pomocą tego łącznika można uruchamiać operacje wsadowe i strumieniowe w Dataflow.
W przypadku obciążeń związanych z przetwarzaniem danych na dużą skalę zalecamy używanie Dataflow i Apache Beam.
Łącznik Cloud Firestore dla Apache Beam jest dostępny w języku Java. Więcej informacji na temat łącznika Cloud Firestore można znaleźć w pakiecie Apache Beam SDK dla języka Java .
Zanim zaczniesz
Zanim przeczytasz tę stronę, powinieneś zapoznać się z modelem programowania dla Apache Beam .
Aby uruchomić przykłady, musisz włączyć interfejs Dataflow API .Przykładowe potoki Cloud Firestore
Poniższe przykłady przedstawiają potok, który zapisuje dane oraz potok, który odczytuje i filtruje dane. Możesz użyć tych próbek jako punktu wyjścia dla własnych potoków.
Uruchamianie przykładowych rurociągów
Kod źródłowy przykładów jest dostępny w repozytorium GitHub googleapis/java-firestore . Aby uruchomić te przykłady, pobierz kod źródłowy i zapoznaj się z plikiem README .
Przykład Write potoku
Poniższy przykład tworzy dokumenty w kolekcji cities-beam-sample :
public class ExampleFirestoreBeamWrite {
private static final FirestoreOptions FIRESTORE_OPTIONS = FirestoreOptions.getDefaultInstance();
public static void main(String[] args) {
runWrite(args, "cities-beam-sample");
}
public static void runWrite(String[] args, String collectionId) {
// create pipeline options from the passed in arguments
PipelineOptions options =
PipelineOptionsFactory.fromArgs(args).withValidation().as(PipelineOptions.class);
Pipeline pipeline = Pipeline.create(options);
RpcQosOptions rpcQosOptions =
RpcQosOptions.newBuilder()
.withHintMaxNumWorkers(options.as(DataflowPipelineOptions.class).getMaxNumWorkers())
.build();
// create some writes
Write write1 =
Write.newBuilder()
.setUpdate(
Document.newBuilder()
// resolves to
// projects/<projectId>/databases/<databaseId>/documents/<collectionId>/NYC
.setName(createDocumentName(collectionId, "NYC"))
.putFields("name", Value.newBuilder().setStringValue("New York City").build())
.putFields("state", Value.newBuilder().setStringValue("New York").build())
.putFields("country", Value.newBuilder().setStringValue("USA").build()))
.build();
Write write2 =
Write.newBuilder()
.setUpdate(
Document.newBuilder()
// resolves to
// projects/<projectId>/databases/<databaseId>/documents/<collectionId>/TOK
.setName(createDocumentName(collectionId, "TOK"))
.putFields("name", Value.newBuilder().setStringValue("Tokyo").build())
.putFields("country", Value.newBuilder().setStringValue("Japan").build())
.putFields("capital", Value.newBuilder().setBooleanValue(true).build()))
.build();
// batch write the data
pipeline
.apply(Create.of(write1, write2))
.apply(FirestoreIO.v1().write().batchWrite().withRpcQosOptions(rpcQosOptions).build());
// run the pipeline
pipeline.run().waitUntilFinish();
}
private static String createDocumentName(String collectionId, String cityDocId) {
String documentPath =
String.format(
"projects/%s/databases/%s/documents",
FIRESTORE_OPTIONS.getProjectId(), FIRESTORE_OPTIONS.getDatabaseId());
return documentPath + "/" + collectionId + "/" + cityDocId;
}
}W przykładzie zastosowano następujące argumenty w celu skonfigurowania i uruchomienia potoku:
GOOGLE_CLOUD_PROJECT=project-id REGION=region TEMP_LOCATION=gs://temp-bucket/temp/ NUM_WORKERS=number-workers MAX_NUM_WORKERS=max-number-workers
Przykład Read potoku
Poniższy przykładowy potok odczytuje dokumenty z kolekcji cities-beam-sample , stosuje filtr do dokumentów, w których pole country jest ustawione na USA i zwraca nazwy pasujących dokumentów.
public class ExampleFirestoreBeamRead {
public static void main(String[] args) {
runRead(args, "cities-beam-sample");
}
public static void runRead(String[] args, String collectionId) {
FirestoreOptions firestoreOptions = FirestoreOptions.getDefaultInstance();
PipelineOptions options =
PipelineOptionsFactory.fromArgs(args).withValidation().as(PipelineOptions.class);
Pipeline pipeline = Pipeline.create(options);
RpcQosOptions rpcQosOptions =
RpcQosOptions.newBuilder()
.withHintMaxNumWorkers(options.as(DataflowPipelineOptions.class).getMaxNumWorkers())
.build();
pipeline
.apply(Create.of(collectionId))
.apply(
new FilterDocumentsQuery(
firestoreOptions.getProjectId(), firestoreOptions.getDatabaseId()))
.apply(FirestoreIO.v1().read().runQuery().withRpcQosOptions(rpcQosOptions).build())
.apply(
ParDo.of(
// transform each document to its name
new DoFn<RunQueryResponse, String>() {
@ProcessElement
public void processElement(ProcessContext c) {
c.output(Objects.requireNonNull(c.element()).getDocument().getName());
}
}))
.apply(
ParDo.of(
// print the document name
new DoFn<String, Void>() {
@ProcessElement
public void processElement(ProcessContext c) {
System.out.println(c.element());
}
}));
pipeline.run().waitUntilFinish();
}
private static final class FilterDocumentsQuery
extends PTransform<PCollection<String>, PCollection<RunQueryRequest>> {
private final String projectId;
private final String databaseId;
public FilterDocumentsQuery(String projectId, String databaseId) {
this.projectId = projectId;
this.databaseId = databaseId;
}
@Override
public PCollection<RunQueryRequest> expand(PCollection<String> input) {
return input.apply(
ParDo.of(
new DoFn<String, RunQueryRequest>() {
@ProcessElement
public void processElement(ProcessContext c) {
// select from collection "cities-collection-<uuid>"
StructuredQuery.CollectionSelector collection =
StructuredQuery.CollectionSelector.newBuilder()
.setCollectionId(Objects.requireNonNull(c.element()))
.build();
// filter where country is equal to USA
StructuredQuery.Filter countryFilter =
StructuredQuery.Filter.newBuilder()
.setFieldFilter(
StructuredQuery.FieldFilter.newBuilder()
.setField(
StructuredQuery.FieldReference.newBuilder()
.setFieldPath("country")
.build())
.setValue(Value.newBuilder().setStringValue("USA").build())
.setOp(StructuredQuery.FieldFilter.Operator.EQUAL))
.buildPartial();
RunQueryRequest runQueryRequest =
RunQueryRequest.newBuilder()
.setParent(DocumentRootName.format(projectId, databaseId))
.setStructuredQuery(
StructuredQuery.newBuilder()
.addFrom(collection)
.setWhere(countryFilter)
.build())
.build();
c.output(runQueryRequest);
}
}));
}
}
}W przykładzie zastosowano następujące argumenty w celu skonfigurowania i uruchomienia potoku:
GOOGLE_CLOUD_PROJECT=project-id REGION=region TEMP_LOCATION=gs://temp-bucket/temp/ NUM_WORKERS=number-workers MAX_NUM_WORKERS=max-number-workers
cennik
Uruchamianie zadania Cloud Firestore w Dataflow wiąże się z kosztami użycia Cloud Firestore i Dataflow. Użycie przepływu danych jest rozliczane za zasoby używane przez zadania. Aby uzyskać szczegółowe informacje, zobacz stronę z cennikiem Dataflow . Aby zapoznać się z cennikiem Cloud Firestore, zobacz stronę Cennik .
Co dalej
- Zobacz Korzystanie z Firestore i Apache Beam do przetwarzania danych, aby zapoznać się z innym przykładem potoku.
- Więcej informacji na temat Dataflow i Apache Beam można znaleźć w dokumentacji Dataflow .