com.spotify.scio.bigtable.BigtableBatchDoFn Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scio-google-cloud-platform_2.13 Show documentation
Scio add-on for Google Cloud Platform
The newest version!
/*
 * Copyright 2024 Spotify AB.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package com.spotify.scio.bigtable;

import com.google.cloud.bigtable.config.BigtableOptions;
import com.google.cloud.bigtable.grpc.BigtableSession;
import com.google.common.util.concurrent.ListenableFuture;
import com.spotify.scio.transforms.BaseAsyncLookupDoFn;
import com.spotify.scio.transforms.GuavaAsyncBatchLookupDoFn;
import java.io.IOException;
import java.util.List;
import org.apache.beam.sdk.transforms.DoFn;
import org.apache.beam.sdk.transforms.SerializableFunction;
import org.apache.commons.lang3.tuple.Pair;

/**
 * A {@link DoFn} which batches elements and performs asynchronous lookup for them using Google
 * Cloud Bigtable.
 *
 * @param  input element type.
 * @param  batched input element type
 * @param  batched response from BigTable type
 * @param  Bigtable lookup value type.
 */
public abstract class BigtableBatchDoFn
    extends GuavaAsyncBatchLookupDoFn {

  private final BigtableOptions options;

  /** Perform asynchronous Bigtable lookup. */
  public abstract ListenableFuture asyncLookup(
      BigtableSession session, BatchRequest batchRequest);

  /**
   * Create a {@link BigtableBatchDoFn} instance.
   *
   * @param options Bigtable options.
   */
  public BigtableBatchDoFn(
      BigtableOptions options,
      int batchSize,
      SerializableFunction, BatchRequest> batchRequestFn,
      SerializableFunction>> batchResponseFn,
      SerializableFunction idExtractorFn) {
    this(options, batchSize, batchRequestFn, batchResponseFn, idExtractorFn, 1000);
  }

  /**
   * Create a {@link BigtableBatchDoFn} instance.
   *
   * @param options Bigtable options.
   * @param maxPendingRequests maximum number of pending requests on every cloned DoFn. This
   *     prevents runner from timing out and retrying bundles.
   */
  public BigtableBatchDoFn(
      BigtableOptions options,
      int batchSize,
      SerializableFunction, BatchRequest> batchRequestFn,
      SerializableFunction>> batchResponseFn,
      SerializableFunction idExtractorFn,
      int maxPendingRequests) {
    this(
        options,
        batchSize,
        batchRequestFn,
        batchResponseFn,
        idExtractorFn,
        maxPendingRequests,
        new BaseAsyncLookupDoFn.NoOpCacheSupplier<>());
  }

  /**
   * Create a {@link BigtableBatchDoFn} instance.
   *
   * @param options Bigtable options.
   * @param maxPendingRequests maximum number of pending requests on every cloned DoFn. This
   *     prevents runner from timing out and retrying bundles.
   * @param cacheSupplier supplier for lookup cache.
   */
  public BigtableBatchDoFn(
      BigtableOptions options,
      int batchSize,
      SerializableFunction, BatchRequest> batchRequestFn,
      SerializableFunction>> batchResponseFn,
      SerializableFunction idExtractorFn,
      int maxPendingRequests,
      BaseAsyncLookupDoFn.CacheSupplier cacheSupplier) {
    super(
        batchSize,
        batchRequestFn,
        batchResponseFn,
        idExtractorFn,
        maxPendingRequests,
        cacheSupplier);
    this.options = options;
  }

  @Override
  public ResourceType getResourceType() {
    // BigtableSession is backed by a gRPC thread safe client
    return ResourceType.PER_INSTANCE;
  }

  protected BigtableSession newClient() {
    try {
      return new BigtableSession(options);
    } catch (IOException e) {
      throw new RuntimeException(e);
    }
  }
}