lincoln-lil commented on a change in pull request #9075: [FLINK-10245][hbase] Add an upsert table sink factory for HBase URL: https://github.com/apache/flink/pull/9075#discussion_r302347476
########## File path: flink-connectors/flink-hbase/src/main/java/org/apache/flink/addons/hbase/HBaseUpsertSinkFunction.java ########## @@ -0,0 +1,257 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.flink.addons.hbase; + +import org.apache.flink.addons.hbase.util.HBaseConfigurationUtil; +import org.apache.flink.addons.hbase.util.HBaseReadWriteHelper; +import org.apache.flink.api.java.tuple.Tuple2; +import org.apache.flink.configuration.Configuration; +import org.apache.flink.runtime.state.FunctionInitializationContext; +import org.apache.flink.runtime.state.FunctionSnapshotContext; +import org.apache.flink.runtime.util.ExecutorThreadFactory; +import org.apache.flink.streaming.api.checkpoint.CheckpointedFunction; +import org.apache.flink.streaming.api.functions.sink.RichSinkFunction; +import org.apache.flink.types.Row; +import org.apache.flink.util.StringUtils; + +import org.apache.hadoop.hbase.HBaseConfiguration; +import org.apache.hadoop.hbase.HConstants; +import org.apache.hadoop.hbase.TableName; +import org.apache.hadoop.hbase.TableNotFoundException; +import org.apache.hadoop.hbase.client.BufferedMutator; +import org.apache.hadoop.hbase.client.BufferedMutatorParams; +import org.apache.hadoop.hbase.client.Connection; +import org.apache.hadoop.hbase.client.ConnectionFactory; +import org.apache.hadoop.hbase.client.Delete; +import org.apache.hadoop.hbase.client.Put; +import org.apache.hadoop.hbase.client.RetriesExhaustedWithDetailsException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.IOException; +import java.util.concurrent.Executors; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.ScheduledFuture; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicLong; +import java.util.concurrent.atomic.AtomicReference; + +import static org.apache.flink.util.Preconditions.checkArgument; + +/** + * The upsert sink for HBase. + * + * <p>This class leverage {@link BufferedMutator} to buffer multiple + * {@link org.apache.hadoop.hbase.client.Mutation Mutations} before sending the requests to cluster. + * The buffering strategy can be configured by {@code bufferFlushMaxSizeInBytes}, + * {@code bufferFlushMaxMutations} and {@code bufferFlushIntervalMillis}.</p> + */ +public class HBaseUpsertSinkFunction + extends RichSinkFunction<Tuple2<Boolean, Row>> + implements CheckpointedFunction, BufferedMutator.ExceptionListener { + + private static final long serialVersionUID = 1L; + private static final Logger LOG = LoggerFactory.getLogger(HBaseUpsertSinkFunction.class); + + private final String hTableName; + private final HBaseTableSchema schema; + private final byte[] serializedConfig; + + private final long bufferFlushMaxSizeInBytes; + private final long bufferFlushMaxMutations; + private final long bufferFlushIntervalMillis; + + private transient HBaseReadWriteHelper helper; + + private transient Connection connection; + private transient BufferedMutator mutator; + + private transient ScheduledExecutorService executor; + private transient ScheduledFuture scheduledFuture; + private transient AtomicLong numPendingRequests; + + private transient volatile boolean closed = false; + + /** + * This is set from inside the {@link BufferedMutator.ExceptionListener} if a {@link Throwable} + * was thrown. + * + * <p>Errors will be checked and rethrown before processing each input element, and when the sink is closed. + */ + private final AtomicReference<Throwable> failureThrowable = new AtomicReference<>(); + + public HBaseUpsertSinkFunction( + String hTableName, + HBaseTableSchema schema, + org.apache.hadoop.conf.Configuration conf, + long bufferFlushMaxSizeInBytes, + long bufferFlushMaxMutations, + long bufferFlushIntervalMillis) { + checkArgument(schema.getRowKeyName().isPresent(), "HBaseUpsertSinkFunction requires rowkey is set."); + this.hTableName = hTableName; + this.schema = schema; + // Configuration is not serializable + this.serializedConfig = HBaseConfigurationUtil.serializeConfiguration(conf); + this.bufferFlushMaxSizeInBytes = bufferFlushMaxSizeInBytes; + this.bufferFlushMaxMutations = bufferFlushMaxMutations; + this.bufferFlushIntervalMillis = bufferFlushIntervalMillis; + } + + @Override + public void open(Configuration parameters) throws Exception { + LOG.info("start open ..."); + org.apache.hadoop.conf.Configuration config = prepareRuntimeConfiguration(); + try { + this.helper = new HBaseReadWriteHelper(schema); + this.numPendingRequests = new AtomicLong(0); + + if (null == connection) { + this.connection = ConnectionFactory.createConnection(config); + } + // co BufferedMutatorExample-04-Params Create a parameter instance, set the table name and custom listener reference. + BufferedMutatorParams params = new BufferedMutatorParams(TableName.valueOf(hTableName)) + .listener(this) + .writeBufferSize(bufferFlushMaxSizeInBytes); + this.mutator = connection.getBufferedMutator(params); + + if (bufferFlushIntervalMillis > 0) { + this.executor = Executors.newScheduledThreadPool( + 1, new ExecutorThreadFactory("hbase-upsert-sink-flusher")); + this.scheduledFuture = this.executor.scheduleWithFixedDelay(() -> { + if (closed) { + return; + } + try { + flush(); + } catch (Exception e) { + // fail the sink and skip the rest of the items + // if the failure handler decides to throw an exception + failureThrowable.compareAndSet(null, e); + } + }, bufferFlushIntervalMillis, bufferFlushIntervalMillis, TimeUnit.MILLISECONDS); + } + } catch (TableNotFoundException tnfe) { + LOG.error("The table " + hTableName + " not found ", tnfe); + throw new RuntimeException("HBase table '" + hTableName + "' not found.", tnfe); + } catch (IOException ioe) { + LOG.error("Exception while creating connection to HBase.", ioe); + throw new RuntimeException("Cannot create connection to HBase.", ioe); + } + LOG.info("end open."); + } + + private org.apache.hadoop.conf.Configuration prepareRuntimeConfiguration() throws IOException { + // create default configuration from current runtime env (`hbase-site.xml` in classpath) first, + // and overwrite configuration using serialized configuration from client-side env (`hbase-site.xml` in classpath). + // user params from client-side have the highest priority + org.apache.hadoop.conf.Configuration runtimeConfig = HBaseConfigurationUtil.deserializeConfiguration(serializedConfig, HBaseConfiguration.create()); + + // do validation: check key option(s) in final runtime configuration + if (StringUtils.isNullOrWhitespaceOnly(runtimeConfig.get(HConstants.ZOOKEEPER_QUORUM))) { + LOG.error("Can not connect to HBase without {} configuration", HConstants.ZOOKEEPER_QUORUM); + throw new IOException("Check HBase configuration failed, lost: '" + HConstants.ZOOKEEPER_QUORUM + "'!"); + } + + return runtimeConfig; + } + + private void checkErrorAndRethrow() { + Throwable cause = failureThrowable.get(); + if (cause != null) { + throw new RuntimeException("An error occurred in HBaseSink.", cause); + } + } + + @Override + public void invoke(Tuple2<Boolean, Row> value, Context context) throws Exception { + checkErrorAndRethrow(); + + if (value.f0) { + Put put = helper.createPutMutation(value.f1); + mutator.mutate(put); + } else { + Delete delete = helper.createDeleteMutation(value.f1); + mutator.mutate(delete); + } + + // flush when the buffer number of mutations greater than the configured max size. + if (bufferFlushMaxMutations > 0 && numPendingRequests.incrementAndGet() >= bufferFlushMaxMutations) { + flush(); + } + } + + private void flush() throws IOException { + // BufferedMutator is thread-safe + mutator.flush(); + numPendingRequests.set(0); + checkErrorAndRethrow(); + } + + @Override + public void close() throws Exception { + closed = true; + + if (mutator != null) { + try { + mutator.close(); + } catch (IOException e) { + LOG.warn("Exception occurs while closing HBase BufferedMutator.", e); + } + this.mutator = null; + } + + if (connection != null) { + try { + connection.close(); + } catch (IOException e) { + LOG.warn("Exception occurs while closing HBase Connection.", e); + } + this.connection = null; + } + + if (scheduledFuture != null) { + scheduledFuture.cancel(false); + if (executor != null) { + executor.shutdownNow(); + } + } + + // make sure any errors from callbacks are rethrown + checkErrorAndRethrow(); Review comment: remove this invocation and do `flush()` before close maybe better? ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
