داده ها را به صورت انبوه با Dataflow پردازش کنید

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

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

رابط Cloud Firestore برای Apache Beam در جاوا موجود است. برای اطلاعات بیشتر در مورد رابط 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 Pipeline

خط لوله مثال زیر اسناد را از مجموعه 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 مراجعه کنید. برای قیمت‌گذاری Cloud Firestore ، صفحه قیمت‌گذاری را ببینید.

بعدش چی

• برای مثال خط لوله دیگری ، استفاده از Firestore و Apache Beam برای پردازش داده را ببینید.
• برای اطلاعات بیشتر درباره Dataflow و Apache Beam، به مستندات Dataflow مراجعه کنید.