com.arakelian.elastic.bulk.BulkOperation Maven / Gradle / Ivy
/*
* 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 com.arakelian.elastic.bulk;
import org.apache.commons.lang3.StringUtils;
import org.immutables.value.Value;
import com.arakelian.core.feature.Nullable;
import com.arakelian.elastic.Views;
import com.arakelian.elastic.model.Index;
import com.arakelian.elastic.model.VersionComponents;
import com.arakelian.json.JsonFilter;
import com.fasterxml.jackson.annotation.JsonValue;
import com.google.common.base.Preconditions;
/**
* Represents a source document that will be indexed into Elastic.
*/
@Value.Immutable(copy = false)
public abstract class BulkOperation {
/**
* Bulk actions are INDEX, CREATE, DELETE and UPDATE.
*
* @see Bulk
* API
*/
public static enum Action {
/**
* CREATE has put-if-absent semantics. The index operation will fail if a document by that
* id already exists in the index.
**/
CREATE(true),
/**
* DELETE does not expect a source on the following line, and has the same semantics as the
* standard delete API.
**/
DELETE(false),
/**
* Unlike {@link #CREATE}, INDEX will add or replace document as necessary.
*/
INDEX(true),
/**
* UPDATE expects that next line is a partial document or a script.
*/
UPDATE(true);
private final boolean hasSource;
private Action(final boolean hasSource) {
this.hasSource = hasSource;
}
public final boolean hasSource() {
return hasSource;
}
@Override
@JsonValue
public String toString() {
return this.name().toLowerCase();
}
}
// see: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html
public enum VersionType {
INTERNAL, //
EXTERNAL, //
EXTERNAL_GTE;
@Override
@JsonValue
public String toString() {
return this.name().toLowerCase();
}
}
private final static char[] DIGIT_TO_CHAR = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B',
'C', 'D', 'E', 'F' };
private void addActionAndMetadata(final StringBuilder buf) {
final Action action = getAction();
final boolean version7 = getElasticVersion().atLeast(7, 0, 0);
buf.append('{');
buf.append("\"");
appendEscaped(buf, action.toString());
buf.append("\"").append(':');
buf.append('{');
buf.append("\"_index\"").append(':');
buf.append('"');
appendEscaped(buf, getIndex().getName());
buf.append('"');
buf.append(',');
if (!version7) {
buf.append("\"_type\"").append(':');
buf.append('"');
appendEscaped(buf, getType());
buf.append('"');
buf.append(',');
}
buf.append("\"_id\"").append(':');
buf.append('"');
appendEscaped(buf, getId());
buf.append('"');
if (getVersion() != null) {
buf.append(',');
buf.append("\"");
if (version7) {
buf.append("version");
} else {
buf.append("_version");
}
buf.append("\"").append(':');
buf.append(getVersion());
if (getVersionType() != null) {
buf.append(',');
buf.append("\"version_type\"").append(':');
buf.append('"');
appendEscaped(buf, getVersionType().toString());
buf.append('"');
}
}
buf.append('}');
buf.append('}');
buf.append('\n');
}
private final void appendEscaped(final StringBuilder buf, final CharSequence csq) {
for (int i = 0, length = csq.length(); i < length; i++) {
final char ch = csq.charAt(i);
appendEscapedChar(buf, ch);
}
}
private final void appendEscapedChar(final StringBuilder buf, final char ch) {
// http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf
// note: we are not required to escape forward slash (e.g. solidus)
switch (ch) {
case '"':
buf.append("\\\"");
break;
case '\\':
buf.append("\\\\");
break;
case '\b':
buf.append("\\b");
break;
case '\f':
buf.append("\\f");
break;
case '\n':
buf.append("\\n");
break;
case '\r':
buf.append("\\r");
break;
case '\t':
buf.append("\\t");
break;
default:
// Reference: http://www.unicode.org/versions/Unicode5.1.0/
if (ch <= '\u001F' || ch >= '\u007F') {
buf.append("\\u");
appendHex(buf, ch, 4);
} else {
buf.append(ch);
}
}
}
private final int appendHex(final StringBuilder buf, final int val, int minLength) {
if (val >= 16) {
final int l2 = val / 16;
minLength = appendHex(buf, l2, minLength - 1);
while (minLength > 1) {
buf.append('0');
minLength--;
}
buf.append(DIGIT_TO_CHAR[val - l2 * 16]);
minLength--;
} else {
while (minLength > 1) {
buf.append('0');
minLength--;
}
buf.append(DIGIT_TO_CHAR[val]);
minLength--;
}
return minLength;
}
@Value.Check
protected void checkSource() {
if (getAction().hasSource()) {
final CharSequence source = getCompactSource();
Preconditions.checkState(source != null && source.length() != 0, "Source must be non-empty");
Preconditions.checkState(
StringUtils.indexOf(source, '\n') == -1,
"Newlines are not allowed in source JSON document when using Elastic bulk API");
}
}
/**
* Returns mapping type within index.
*
* @return mapping type within index.
*/
public abstract Action getAction();
@Nullable
@Value.Derived
@Value.Auxiliary
public CharSequence getCompactSource() {
final CharSequence source = getSource();
if (source != null && StringUtils.indexOf(source, '\n') != -1) {
// never returns JSON that has newline in it
return JsonFilter.compactQuietly(source);
}
return source;
}
@Value.Default
@Value.Auxiliary
public VersionComponents getElasticVersion() {
return Views.VERSION_6.getVersion();
}
/**
* Returns the id of the document.
*
* @return id of the document.
*/
public abstract String getId();
/**
* Returns index that this document will be indexed into.
*
* @return index that this document will be indexed into.
*/
public abstract Index getIndex();
@Nullable
@Value.Auxiliary
public abstract BulkOperationListener getListener();
@Value.Derived
@Value.Auxiliary
public CharSequence getOperation() {
final CharSequence source;
if (getAction().hasSource()) {
source = getCompactSource();
} else {
source = null;
}
// try to pre-allocate buffer large enough to hold operation
final int size = BulkIndexer.roundAllocation(128 + //
(source != null ? source.length() : 0));
final StringBuilder buf = new StringBuilder(size);
addActionAndMetadata(buf);
if (source != null) {
buf.append(source).append('\n');
}
return buf;
}
/**
* Returns source JSON document that will be indexed by {@link BulkIndexer}
*
* @return source JSON document that will be indexed by {@link BulkIndexer}
*/
@Nullable
@Value.Auxiliary
public abstract CharSequence getSource();
/**
* Returns mapping type within index.
*
* @return mapping type within index.
*/
@Value.Default
public String getType() {
// not meaningful for Elastic 7+
return "_doc";
}
@Nullable
public abstract Long getVersion();
@Nullable
@Value.Default
public VersionType getVersionType() {
return getVersion() != null ? VersionType.EXTERNAL : null;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy