Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add _routing to SQL includes list #277

Merged
merged 2 commits into from
Jun 21, 2023
Merged

Add _routing to SQL includes list #277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1fd3a57
Add _routing to SQL includes list
acarbonetto Jun 16, 2023
da1973f
Update IT index
acarbonetto Jun 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions integ-test/src/test/java/org/opensearch/sql/sql/IdentifierIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
import static org.opensearch.sql.util.TestUtils.performRequest;

import java.io.IOException;
import java.util.ArrayList;
import org.json.JSONArray;
import org.json.JSONObject;
import org.junit.jupiter.api.Test;
import org.opensearch.client.Request;
Expand Down Expand Up @@ -99,6 +101,31 @@ public void testMetafieldIdentifierTest() throws IOException {
verifyDataRows(result, rows(30, id, index, 1.0, 1.0, -2));
}

@Test
public void testMetafieldIdentifierRoutingTest() throws IOException {
// create an index, but the contents doesn't matter
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// create an index, but the contents doesn't matter
// create an index, but the contents don't matter

String id = "12345";
String index = "test.routing_metafields";
new Index(index).addDoc("{\"age\": 30}", id);

// Execute using field metadata values
final JSONObject result = new JSONObject(executeQuery(
"SELECT _id, _index, _routing "
+ "FROM " + index,
"jdbc"));

// Verify that the metadata values are returned when requested
verifySchema(result,
schema("_id", null, "keyword"),
schema("_index", null, "keyword"),
schema("_routing", null, "keyword"));
assertTrue(result.getJSONArray("schema").length() == 3);

// routing has the format: [thread_id][index][node] - where thread_id and node may be variable
// per run
assertTrue(result.getJSONArray("datarows").get(0).toString().contains("[" + index + "]"));
}

@Test
public void testMetafieldIdentifierWithAliasTest() throws IOException {
// create an index, but the contents doesn't matter
Expand Down
7 changes: 4 additions & 3 deletions opensearch/src/main/java/org/opensearch/sql/opensearch/response/OpenSearchResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,15 @@
import static org.opensearch.sql.opensearch.storage.OpenSearchIndex.METADATA_FIELD_ID;
import static org.opensearch.sql.opensearch.storage.OpenSearchIndex.METADATA_FIELD_INDEX;
import static org.opensearch.sql.opensearch.storage.OpenSearchIndex.METADATA_FIELD_MAXSCORE;
import static org.opensearch.sql.opensearch.storage.OpenSearchIndex.METADATA_FIELD_ROUTING;
import static org.opensearch.sql.opensearch.storage.OpenSearchIndex.METADATA_FIELD_SCORE;
import static org.opensearch.sql.opensearch.storage.OpenSearchIndex.METADATA_FIELD_SORT;

import com.google.common.collect.ImmutableMap;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;
import lombok.EqualsAndHashCode;
import lombok.ToString;
Expand Down Expand Up @@ -146,8 +145,10 @@ public Iterator<ExprValue> iterator() {
if (maxScore != null) {
builder.put(METADATA_FIELD_MAXSCORE, maxScore);
}
} else { // if (metaDataField.equals(METADATA_FIELD_SORT)) {
} else if (metaDataField.equals(METADATA_FIELD_SORT)) {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe: use switch - case?

builder.put(METADATA_FIELD_SORT, new ExprLongValue(hit.getSeqNo()));
} else { // if (metaDataField.equals(METADATA_FIELD_ROUTING)){
builder.put(METADATA_FIELD_ROUTING, new ExprStringValue(hit.getShard().toString()));
}
});

Expand Down
5 changes: 4 additions & 1 deletion opensearch/src/main/java/org/opensearch/sql/opensearch/storage/OpenSearchIndex.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,15 @@ public class OpenSearchIndex implements Table {
public static final String METADATA_FIELD_MAXSCORE = "_maxscore";
public static final String METADATA_FIELD_SORT = "_sort";

public static final String METADATA_FIELD_ROUTING = "_routing";

public static final java.util.Map<String, ExprType> METADATAFIELD_TYPE_MAP = Map.of(
METADATA_FIELD_ID, ExprCoreType.STRING,
METADATA_FIELD_INDEX, ExprCoreType.STRING,
METADATA_FIELD_SCORE, ExprCoreType.FLOAT,
METADATA_FIELD_MAXSCORE, ExprCoreType.FLOAT,
METADATA_FIELD_SORT, ExprCoreType.LONG
METADATA_FIELD_SORT, ExprCoreType.LONG,
METADATA_FIELD_ROUTING, ExprCoreType.STRING
);

/** OpenSearch client connection. */
Expand Down
9 changes: 8 additions & 1 deletion opensearch/src/test/java/org/opensearch/sql/opensearch/response/OpenSearchResponseTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,10 @@
import org.opensearch.action.search.SearchResponse;
import org.opensearch.common.bytes.BytesArray;
import org.opensearch.common.text.Text;
import org.opensearch.index.shard.ShardId;
import org.opensearch.search.SearchHit;
import org.opensearch.search.SearchHits;
import org.opensearch.search.SearchShardTarget;
import org.opensearch.search.aggregations.Aggregations;
import org.opensearch.search.fetch.subphase.highlight.HighlightField;
import org.opensearch.sql.data.model.ExprFloatValue;
Expand Down Expand Up @@ -143,9 +145,13 @@ void iterator_metafields() {
new TotalHits(1L, TotalHits.Relation.EQUAL_TO),
3.75F));

ShardId shardId = new ShardId("index", "indexUUID", 42);
SearchShardTarget shardTarget = new SearchShardTarget("node", shardId, null, null);

when(searchHit1.getSourceAsString()).thenReturn("{\"id1\", 1}");
when(searchHit1.getId()).thenReturn("testId");
when(searchHit1.getIndex()).thenReturn("testIndex");
when(searchHit1.getShard()).thenReturn(shardTarget);
when(searchHit1.getScore()).thenReturn(3.75F);
when(searchHit1.getSeqNo()).thenReturn(123456L);

Expand All @@ -155,11 +161,12 @@ void iterator_metafields() {
"id1", new ExprIntegerValue(1),
"_index", new ExprStringValue("testIndex"),
"_id", new ExprStringValue("testId"),
"_routing", new ExprStringValue(shardTarget.toString()),
"_sort", new ExprLongValue(123456L),
"_score", new ExprFloatValue(3.75F),
"_maxscore", new ExprFloatValue(3.75F)
));
List includes = List.of("id1", "_index", "_id", "_sort", "_score", "_maxscore");
List includes = List.of("id1", "_index", "_id", "_routing", "_sort", "_score", "_maxscore");
int i = 0;
for (ExprValue hit : new OpenSearchResponse(searchResponse, factory, includes)) {
if (i == 0) {
Expand Down
3 changes: 2 additions & 1 deletion opensearch/src/test/java/org/opensearch/sql/opensearch/storage/OpenSearchIndexTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,9 +187,10 @@ void getReservedFieldTypes() {
assertThat(
fieldTypes,
allOf(
aMapWithSize(5),
aMapWithSize(6),
hasEntry("_id", ExprCoreType.STRING),
hasEntry("_index", ExprCoreType.STRING),
hasEntry("_routing", ExprCoreType.STRING),
hasEntry("_sort", ExprCoreType.LONG),
hasEntry("_score", ExprCoreType.FLOAT),
hasEntry("_maxscore", ExprCoreType.FLOAT)
Expand Down