پردازش انبوه داده‌ها با Dataflow

این صفحه نمونه‌هایی از نحوه استفاده از Dataflow برای انجام عملیات انبوه Cloud Firestore در خط لوله Apache Beam ارائه می‌دهد. Apache Beam از رابطی برای Cloud Firestore پشتیبانی می‌کند. می‌توانید از این اتصال‌دهنده برای اجرای عملیات دسته‌ای و جاری‌سازی در Dataflow استفاده کنید.

توصیه می‌کنیم از Dataflow و Apache Beam برای حجم‌های کاری پردازش داده در مقیاس بزرگ استفاده کنید.

رابط Cloud Firestore برای Apache Beam در Java دردسترس است. برای اطلاعات بیشتر درباره رابط Cloud Firestore، به کیت توسعه نرم‌افزار Apache Beam برای 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;
  }
}

این مثال از آرگومان‌های زیر برای پیکربندی و اجرای خط لوله استفاده می‌کند:

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);
                }
              }));
    }
  }
}

این مثال از آرگومان‌های زیر برای پیکربندی و اجرای خط لوله استفاده می‌کند:

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، صفحه قیمت‌گذاری را ببینید.

حالا چه می‌شود