org.apache.solr.update.processor.UUIDUpdateProcessorFactory Maven / Gradle / Ivy
Show all versions of solr-core Show documentation
/*
* 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.solr.update.processor;
import java.util.Locale;
import java.util.UUID;
import org.apache.solr.common.util.NamedList;
import org.apache.solr.common.util.StrUtils;
import org.apache.solr.request.SolrQueryRequest;
import org.apache.solr.response.SolrQueryResponse;
import org.apache.solr.schema.SchemaField;
/**
* An update processor that adds a newly generated UUID value to any document being
* added that does not already have a value in the specified field.
*
* In the example configuration below, if a document does not contain a value in the id
* field, a new UUID will be generated and added as the value of that field.
*
*
*
* <processor class="solr.UUIDUpdateProcessorFactory">
* <str name="fieldName">id</str>
* </processor>
*
*
* You can also invoke the processor with request handler param(s) as uuid.fieldname
* with processor=uuid curl -X POST -H Content-Type: application/json
* http://localhost:8983/solr/test/update/json/docs?processor=uuid;ampersand;uuid.fieldName=id;ampersand;commit=true
* --data-binary {"id":"1","title": "titleA"}
*
*
NOTE: The param(s) provided in request handler will override / supersede processor's config.
*
*
If field name is omitted in processor configuration and not provided in request handler
* param(s), then {@link org.apache.solr.schema.IndexSchema#getUniqueKeyField()} is used as field
* and a new UUID will be generated and added as the value of that field. The field
* type of the uniqueKeyField must be anything which accepts a string or UUID value.
*
* @see UUID
* @since 4.0.0
*/
public class UUIDUpdateProcessorFactory extends UpdateRequestProcessorFactory {
private static final String PREFIX_PARAM = "uuid.";
public static final String NAME = "uuid";
private static final String FIELD_PARAM = "fieldName";
protected String fieldName = null;
@Override
public void init(NamedList args) {
Object obj = args.remove(FIELD_PARAM);
if (null != obj) {
fieldName = obj.toString();
}
}
@Override
public UpdateRequestProcessor getInstance(
SolrQueryRequest req, SolrQueryResponse rsp, UpdateRequestProcessor next) {
String fieldName = this.fieldName;
String fname = req.getParams().get(PREFIX_PARAM + FIELD_PARAM);
if (StrUtils.isNotNullOrEmpty(fname)) {
fieldName = fname;
}
if (StrUtils.isNullOrEmpty(fieldName)) {
SchemaField schemaField = req.getSchema().getUniqueKeyField();
fieldName = schemaField.getName();
}
return new AbstractDefaultValueUpdateProcessorFactory.DefaultValueUpdateProcessor(
fieldName, next) {
@Override
public Object getDefaultValue() {
return UUID.randomUUID().toString().toLowerCase(Locale.ROOT);
}
};
}
}