עיבוד נתונים בכמות גדולה באמצעות Dataflow

בדף הזה מופיעות דוגמאות לשימוש ב-Dataflow כדי לבצע פעולות Cloud Firestore בכמות גדולה בצינור עיבוד נתונים של Apache Beam. ‫Apache Beam תומך בחיבור ל-Cloud Firestore. אפשר להשתמש במחבר הזה כדי להפעיל פעולות באצווה ובסטרימינג ב-Dataflow.

מומלץ להשתמש ב-Dataflow וב-Apache Beam לעומסי עבודה (workloads) של עיבוד נתונים בקנה מידה גדול.

מחבר Cloud Firestore ל-Apache Beam זמין ב-Java. מידע נוסף על מחבר Cloud Firestore זמין ב-Apache Beam SDK for Java.

לפני שמתחילים

לפני שקוראים את הדף הזה, כדאי להכיר את מודל התכנות של Apache Beam.

כדי להריץ את הדוגמאות, צריך להפעיל את Dataflow API.

דוגמאות לצינורות Cloud Firestore

בדוגמאות שלמטה מוצג צינור עיבוד נתונים שכותב נתונים וצינור עיבוד נתונים שקורא ומסנן נתונים. אפשר להשתמש בדוגמאות האלה כנקודת התחלה ליצירת צינורות משלכם.

הרצת צינורות עיבוד נתונים לדוגמה

קוד המקור של הדוגמאות זמין במאגר googleapis/java-firestore ב-GitHub. כדי להריץ את הדוגמאות האלה, צריך להוריד את קוד המקור ולעיין בקובץ README.

דוגמה לצינור Write

בדוגמה הבאה נוצרים מסמכים באוסף 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;
  }
}
ExampleFirestoreBeamWrite.java

בדוגמה נעשה שימוש בארגומנטים הבאים כדי להגדיר ולהפעיל צינור:

GOOGLE_CLOUD_PROJECT=project-id
REGION=region
TEMP_LOCATION=gs://temp-bucket/temp/
NUM_WORKERS=number-workers
MAX_NUM_WORKERS=max-number-workers

דוגמה Read לצינור

בצינור הנתונים הבא, המערכת קוראת מסמכים מהאוסף cities-beam-sample, מחילה מסנן על מסמכים שבהם השדה country מוגדר לערך USA, ומחזירה את השמות של המסמכים התואמים.

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);
                }
              }));
    }
  }
}
ExampleFirestoreBeamRead.java

בדוגמה נעשה שימוש בארגומנטים הבאים כדי להגדיר ולהפעיל צינור:

GOOGLE_CLOUD_PROJECT=project-id
REGION=region
TEMP_LOCATION=gs://temp-bucket/temp/
NUM_WORKERS=number-workers
MAX_NUM_WORKERS=max-number-workers

תמחור

הפעלת עומס עבודה מסוג Cloud Firestore ב-Dataflow כרוכה בעלויות על Cloud Firestore שימוש ועל שימוש ב-Dataflow. השימוש ב-Dataflow מחויב על המשאבים שבהם נעשה שימוש במשימות. פרטים נוספים מופיעים בדף המחירים של Dataflow. למידע על התמחור של Cloud Firestore, אפשר לעיין בדף התמחור.

המאמרים הבאים

• במאמר שימוש ב-Firestore וב-Apache Beam לעיבוד נתונים מופיעה דוגמה נוספת לצינור עיבוד נתונים.
• מידע נוסף על Dataflow ו-Apache Beam זמין במסמכי התיעוד של Dataflow.