דף זה נותן דוגמאות כיצד להשתמש ב-Dataflow לביצוע פעולות בכמות גדולה של Cloud Firestore בצינור Apache Beam. Apache Beam תומך במחבר עבור Cloud Firestore. אתה יכול להשתמש במחבר זה כדי להפעיל פעולות אצווה וזרימה ב-Dataflow.
אנו ממליצים להשתמש ב-Dataflow וב-Apache Beam לעומסי עבודה של עיבוד נתונים בקנה מידה גדול.
מחבר Cloud Firestore עבור Apache Beam זמין ב-Java. למידע נוסף על מחבר Cloud Firestore, עיין ב- Apache Beam SDK עבור 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 לפרטים. לתמחור של Cloud Firestore, עיין בדף התמחור .
מה הלאה
- ראה שימוש ב-Firestore וב-Apache Beam לעיבוד נתונים לקבלת דוגמה נוספת לצינור.
- למידע נוסף על Dataflow ו- Apache Beam, עיין בתיעוד של Dataflow .