io.cdap.plugin.batch.SolrSearchSink Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2016-2019 Cask Data, Inc.
 *
 * 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 io.cdap.plugin.batch;

import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;
import io.cdap.cdap.api.annotation.Description;
import io.cdap.cdap.api.annotation.Macro;
import io.cdap.cdap.api.annotation.Name;
import io.cdap.cdap.api.annotation.Plugin;
import io.cdap.cdap.api.data.batch.Output;
import io.cdap.cdap.api.data.batch.OutputFormatProvider;
import io.cdap.cdap.api.data.format.StructuredRecord;
import io.cdap.cdap.api.data.schema.Schema;
import io.cdap.cdap.api.dataset.lib.KeyValue;
import io.cdap.cdap.etl.api.Emitter;
import io.cdap.cdap.etl.api.PipelineConfigurer;
import io.cdap.cdap.etl.api.StageMetrics;
import io.cdap.cdap.etl.api.batch.BatchRuntimeContext;
import io.cdap.cdap.etl.api.batch.BatchSink;
import io.cdap.cdap.etl.api.batch.BatchSinkContext;
import io.cdap.cdap.format.StructuredRecordStringConverter;
import io.cdap.plugin.common.SolrOutputFormat;
import io.cdap.plugin.common.SolrRecordWriter;
import io.cdap.plugin.common.SolrSearchSinkConfig;
import org.apache.hadoop.io.Text;

import java.lang.reflect.Type;
import java.util.HashMap;
import java.util.Map;
import javax.annotation.Nullable;

/**
 * Batch SolrSearch Sink Plugin - Writes data to a SingleNode Solr or to SolrCloud.
 */
@Plugin(type = BatchSink.PLUGIN_TYPE)
@Name("SolrSearch")
@Description("This plugin allows users to build the pipelines to write data to Solr. The input fields coming from " +
  "the previous stage of the pipeline are mapped to Solr fields. User can also specify the mode of the Solr to " +
  "connect to. For example, SingleNode Solr or SolrCloud.")
public class SolrSearchSink extends BatchSink {
  private static final Gson GSON = new Gson();
  private static final Type SCHEMA_TYPE = new TypeToken() { }.getType();
  private final BatchSolrSearchConfig batchConfig;
  private StageMetrics metrics;

  public SolrSearchSink(BatchSolrSearchConfig batchConfig) {
    this.batchConfig = batchConfig;
  }

  @Override
  public void prepareRun(BatchSinkContext context) throws Exception {
    context.addOutput(Output.of(batchConfig.referenceName, new SolrSearchSink.SolrOutputFormatProvider(batchConfig)));
  }

  @Override
  public void configurePipeline(PipelineConfigurer pipelineConfigurer) {
    Schema inputSchema = pipelineConfigurer.getStageConfigurer().getInputSchema();
    batchConfig.validateSolrConnectionString();
    if (inputSchema != null) {
      batchConfig.validateKeyField(inputSchema);
      batchConfig.validateInputFieldsDataType(inputSchema);
    }
    batchConfig.validateOutputFieldMappings();
  }

  @Override
  public void initialize(BatchRuntimeContext context) throws Exception {
    metrics = context.getMetrics();
    //Calling testSolrConnection() before each mapper, to ensure that the connection is alive and available for
    //indexing.
    batchConfig.testSolrConnection();
  }

  @Override
  public void transform(StructuredRecord structuredRecord, Emitter> emitter) throws Exception {
    Schema recordSchema = structuredRecord.getSchema();
    batchConfig.validateKeyField(recordSchema);
    batchConfig.validateInputFieldsDataType(recordSchema);

    if (structuredRecord.get(batchConfig.getKeyField()) == null) {
      metrics.count("invalid", 1);
      return;
    }
    emitter.emit(new KeyValue((new Text(GSON.toJson(recordSchema, SCHEMA_TYPE))),
                                          new Text(StructuredRecordStringConverter.toJsonString(structuredRecord))));
  }

  /**
   * Output format provider for Batch SolrSearch Sink.
   */
  private static class SolrOutputFormatProvider implements OutputFormatProvider {
    private static final String DEAFULT_BATCHSIZE = "10000";
    private Map conf;

    private SolrOutputFormatProvider(BatchSolrSearchConfig batchConfig) {
      this.conf = new HashMap<>();
      conf.put(SolrRecordWriter.SERVER_URL, batchConfig.getSolrHost());
      conf.put(SolrRecordWriter.SERVER_MODE, batchConfig.getSolrMode());
      conf.put(SolrRecordWriter.COLLECTION_NAME, batchConfig.getCollectionName());
      conf.put(SolrRecordWriter.KEY_FIELD, batchConfig.getKeyField());
      conf.put(SolrRecordWriter.BATCH_SIZE, batchConfig.getBatchSize() == null ? DEAFULT_BATCHSIZE :
        batchConfig.getBatchSize());
      if (batchConfig.getOutputFieldMappings() == null) {
        conf.put(SolrRecordWriter.FIELD_MAPPINGS, "");
      } else {
        conf.put(SolrRecordWriter.FIELD_MAPPINGS, batchConfig.getOutputFieldMappings());
      }
    }

    @Override
    public String getOutputFormatClassName() {
      return SolrOutputFormat.class.getName();
    }

    @Override
    public Map getOutputFormatConfiguration() {
      return conf;
    }
  }

  /**
   * Config class for Batch SolrSearch sink.
   */
  public static class BatchSolrSearchConfig extends SolrSearchSinkConfig {
    @Description("Number of documents to create a batch and send it to Solr for indexing. After each batch, " +
      "commit will be triggered. Default batch size is 10000. (Macro-enabled)")
    @Nullable
    @Macro
    private final String batchSize;

    public BatchSolrSearchConfig(String referenceName, String solrMode, String solrHost, String collectionName,
                                 String keyField, @Nullable String outputFieldMappings, @Nullable String batchSize) {
      super(referenceName, solrMode, solrHost, collectionName, keyField, outputFieldMappings);
      this.batchSize = batchSize;
    }

    /**
     * Returns the batch size given as input by user.
     *
     * @return batch size
     */
    @Nullable
    public String getBatchSize() {
      return batchSize;
    }
  }
}