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.

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

Keep includes when specifying excludes and vice versa #3059

Merged
merged 1 commit into from
May 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,31 @@ case class GetRequest(index: IndexLike,

def fetchSourceContext(context: FetchSourceContext): GetRequest = copy(fetchSource = context.some)

def fetchSourceInclude(include: String): GetRequest = fetchSourceContext(List(include), Nil)
def fetchSourceInclude(includes: Iterable[String]): GetRequest = fetchSourceContext(includes, Nil)
def fetchSourceInclude(includes: String*): GetRequest = fetchSourceContext(includes, Nil)
def fetchSourceInclude(include: String): GetRequest = fetchSource match {
case Some(ctx) => fetchSourceContext(List(include), ctx.excludes)
case None => fetchSourceContext(List(include), Nil)
}
def fetchSourceInclude(includes: Iterable[String]): GetRequest = fetchSource match {
case Some(ctx) => fetchSourceContext(includes, ctx.excludes)
case None => fetchSourceContext(includes, Nil)
}
def fetchSourceInclude(includes: String*): GetRequest = fetchSource match {
case Some(ctx) => fetchSourceContext(includes, ctx.excludes)
case None => fetchSourceContext(includes, Nil)
}

def fetchSourceExclude(exclude: String): GetRequest = fetchSourceContext(Nil, List(exclude))
def fetchSourceExclude(excludes: Iterable[String]): GetRequest = fetchSourceContext(Nil, excludes)
def fetchSourceExclude(excludes: String*): GetRequest = fetchSourceContext(Nil, excludes)
def fetchSourceExclude(exclude: String): GetRequest = fetchSource match {
case Some(ctx) => fetchSourceContext(ctx.includes, List(exclude))
case None => fetchSourceContext(Nil, List(exclude))
}
def fetchSourceExclude(excludes: Iterable[String]): GetRequest = fetchSource match {
case Some(ctx) => fetchSourceContext(ctx.includes, excludes)
case None => fetchSourceContext(Nil, excludes)
}
def fetchSourceExclude(excludes: String*): GetRequest = fetchSource match {
case Some(ctx) => fetchSourceContext(ctx.includes, excludes)
case None => fetchSourceContext(Nil, excludes)
}

def storedFields(first: String, rest: String*): GetRequest = storedFields(first +: rest)
def storedFields(fs: Iterable[String]): GetRequest = copy(storedFields = fs.toSeq)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -273,13 +273,25 @@ case class SearchRequest(indexes: Indexes,

def fetchSource(fetch: Boolean): SearchRequest = copy(fetchContext = FetchSourceContext(fetch).some)

def sourceInclude(first: String, rest: String*): SearchRequest = sourceFiltering(first +: rest, Nil)
def sourceInclude(first: String, rest: String*): SearchRequest = fetchContext match {
case Some(ctx) => sourceFiltering(first +: rest, ctx.excludes)
case None => sourceFiltering(first +: rest, Nil)
}

def sourceInclude(includes: Iterable[String]): SearchRequest = sourceFiltering(includes, Nil)
def sourceInclude(includes: Iterable[String]): SearchRequest = fetchContext match {
case Some(ctx) => sourceFiltering(includes, ctx.excludes)
case None => sourceFiltering(includes, Nil)
}

def sourceExclude(first: String, rest: String*): SearchRequest = sourceFiltering(Nil, first +: rest)
def sourceExclude(first: String, rest: String*): SearchRequest = fetchContext match {
case Some(ctx) => sourceFiltering(ctx.includes, first +: rest)
case None => sourceFiltering(Nil, first +: rest)
}

def sourceExclude(excludes: Iterable[String]): SearchRequest = sourceFiltering(Nil, excludes)
def sourceExclude(excludes: Iterable[String]): SearchRequest = fetchContext match {
case Some(ctx) => sourceFiltering(ctx.includes, excludes)
case None => sourceFiltering(Nil, excludes)
}

def sourceFiltering(includes: Iterable[String], excludes: Iterable[String]): SearchRequest =
copy(fetchContext = FetchSourceContext(true, includes.toArray, excludes.toArray).some)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,17 @@ class GetTest extends AnyFlatSpec with Matchers with DockerTests {
resp.sourceAsMap shouldBe Map("name" -> "bud lite")
}

it should "support specifying source includes and excludes separately" in {

val resp = client.execute {
get("8") from "beer" fetchSourceInclude(List("name")) fetchSourceExclude(List("bran"))
}.await.result

resp.exists should be(true)
resp.id shouldBe "8"
resp.sourceAsMap shouldBe Map("name" -> "bud lite")
}

it should "retrieve a document supporting stored fields" in {

val resp = client.execute {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,11 @@ class SearchTest extends AnyWordSpec with DockerTests with Matchers {
search("chess") query matchAllQuery() sourceExclude "count"
}.await.result.hits.hits.map(_.sourceAsString).toSet shouldBe Set("{\"name\":\"pawn\",\"value\":1}", "{\"aka\":\"horse\",\"name\":\"knight\",\"value\":3}", "{\"name\":\"king\",\"value\":0}", "{\"aka\":\"castle\",\"name\":\"rook\",\"value\":5}", "{\"name\":\"queen\",\"value\":10}", "{\"name\":\"bishop\",\"value\":3}")
}
"support a mix of source includes and excludes" in {
client.execute {
search("chess") query matchAllQuery() sourceInclude "value" sourceExclude "name"
}.await.result.hits.hits.map(_.sourceAsString).toSet shouldBe Set("{\"value\":0}", "{\"value\":1}", "{\"value\":3}", "{\"value\":5}", "{\"value\":10}")
}
"support constantScoreQuery" should {
"work with termQuery" in {
client.execute {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,22 @@ class MatchQueryTest

resp.hits.hits.head.sourceAsMap shouldBe Map("scientist.name" -> "Jules Violle")
}

"a match query" should "support excluding nested properties" in {

val resp = client.execute {
search("units") query matchQuery("name", "candela") sourceExclude "scientist.name"
}.await.result

resp.hits.hits.head.sourceAsMap shouldBe Map("name" -> "candela", "scientist.country" -> "France")
}

"a match query" should "support including and excluding nested properties" in {

val resp = client.execute {
search("units") query matchQuery("name", "candela") sourceInclude "*name" sourceExclude "scientist.*"
}.await.result

resp.hits.hits.head.sourceAsMap shouldBe Map("name" -> "candela")
}
}