1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715
|
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. 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.
from elasticsearch.dsl import E
from elasticsearch.esql import ESQL, and_, functions, not_, or_
def test_from():
query = ESQL.from_("employees")
assert query.render() == "FROM employees"
query = ESQL.from_("<logs-{now/d}>")
assert query.render() == "FROM <logs-{now/d}>"
query = ESQL.from_("employees-00001", "other-employees-*")
assert query.render() == "FROM employees-00001, other-employees-*"
query = ESQL.from_("cluster_one:employees-00001", "cluster_two:other-employees-*")
assert (
query.render()
== "FROM cluster_one:employees-00001, cluster_two:other-employees-*"
)
query = ESQL.from_("employees").metadata("_id")
assert query.render() == "FROM employees METADATA _id"
def test_row():
query = ESQL.row(a=1, b="two", c=None)
assert query.render() == 'ROW a = 1, b = "two", c = null'
query = ESQL.row(a=[2, 1])
assert query.render() == "ROW a = [2, 1]"
query = ESQL.row(a=functions.round(1.23, 0))
assert query.render() == "ROW a = ROUND(1.23, 0)"
def test_show():
query = ESQL.show("INFO")
assert query.render() == "SHOW INFO"
def test_change_point():
query = (
ESQL.row(key=list(range(1, 26)))
.mv_expand("key")
.eval(value=functions.case(E("key") < 13, 0, 42))
.change_point("value")
.on("key")
.where("type IS NOT NULL")
)
assert (
query.render()
== """ROW key = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25]
| MV_EXPAND key
| EVAL value = CASE(key < 13, 0, 42)
| CHANGE_POINT value ON key
| WHERE type IS NOT NULL"""
)
def test_completion():
query = (
ESQL.row(question="What is Elasticsearch?")
.completion("question")
.with_("test_completion_model")
.keep("question", "completion")
)
assert (
query.render()
== """ROW question = "What is Elasticsearch?"
| COMPLETION question WITH test_completion_model
| KEEP question, completion"""
)
query = (
ESQL.row(question="What is Elasticsearch?")
.completion(answer=E("question"))
.with_("test_completion_model")
.keep("question", "answer")
)
assert (
query.render()
== """ROW question = "What is Elasticsearch?"
| COMPLETION answer = question WITH test_completion_model
| KEEP question, answer"""
)
query = (
ESQL.from_("movies")
.sort("rating DESC")
.limit(10)
.eval(
prompt="""CONCAT(
"Summarize this movie using the following information: \\n",
"Title: ", title, "\\n",
"Synopsis: ", synopsis, "\\n",
"Actors: ", MV_CONCAT(actors, ", "), "\\n",
)"""
)
.completion(summary="prompt")
.with_("test_completion_model")
.keep("title", "summary", "rating")
)
assert (
query.render()
== """FROM movies
| SORT rating DESC
| LIMIT 10
| EVAL prompt = CONCAT(
"Summarize this movie using the following information: \\n",
"Title: ", title, "\\n",
"Synopsis: ", synopsis, "\\n",
"Actors: ", MV_CONCAT(actors, ", "), "\\n",
)
| COMPLETION summary = prompt WITH test_completion_model
| KEEP title, summary, rating"""
)
query = (
ESQL.from_("movies")
.sort("rating DESC")
.limit(10)
.eval(
prompt=functions.concat(
"Summarize this movie using the following information: \n",
"Title: ",
E("title"),
"\n",
"Synopsis: ",
E("synopsis"),
"\n",
"Actors: ",
functions.mv_concat(E("actors"), ", "),
"\n",
)
)
.completion(summary="prompt")
.with_("test_completion_model")
.keep("title", "summary", "rating")
)
assert (
query.render()
== """FROM movies
| SORT rating DESC
| LIMIT 10
| EVAL prompt = CONCAT("Summarize this movie using the following information: \\n", "Title: ", title, "\\n", "Synopsis: ", synopsis, "\\n", "Actors: ", MV_CONCAT(actors, ", "), "\\n")
| COMPLETION summary = prompt WITH test_completion_model
| KEEP title, summary, rating"""
)
def test_dissect():
query = (
ESQL.row(a="2023-01-23T12:15:00.000Z - some text - 127.0.0.1")
.dissect("a", "%{date} - %{msg} - %{ip}")
.keep("date", "msg", "ip")
)
assert (
query.render()
== """ROW a = "2023-01-23T12:15:00.000Z - some text - 127.0.0.1"
| DISSECT a "%{date} - %{msg} - %{ip}"
| KEEP date, msg, ip"""
)
def test_drop():
query = ESQL.from_("employees").drop("height")
assert query.render() == "FROM employees\n| DROP height"
query = ESQL.from_("employees").drop("height*")
assert query.render() == "FROM employees\n| DROP height*"
def test_enrich():
query = ESQL.row(language_code="1").enrich("languages_policy")
assert (
query.render()
== """ROW language_code = "1"
| ENRICH languages_policy"""
)
query = ESQL.row(language_code="1").enrich("languages_policy").on("a")
assert (
query.render()
== """ROW language_code = "1"
| ENRICH languages_policy ON a"""
)
query = (
ESQL.row(language_code="1")
.enrich("languages_policy")
.on("a")
.with_(name="language_name")
)
assert (
query.render()
== """ROW language_code = "1"
| ENRICH languages_policy ON a WITH name = language_name"""
)
def test_eval():
query = (
ESQL.from_("employees")
.sort("emp_no")
.keep("first_name", "last_name", "height")
.eval(height_feet=E("height") * 3.281, height_cm=E("height") * 100)
)
assert (
query.render()
== """FROM employees
| SORT emp_no
| KEEP first_name, last_name, height
| EVAL height_feet = height * 3.281, height_cm = height * 100"""
)
query = (
ESQL.from_("employees")
.sort("emp_no")
.keep("first_name", "last_name", "height")
.eval(E("height") * 3.281)
)
assert (
query.render()
== """FROM employees
| SORT emp_no
| KEEP first_name, last_name, height
| EVAL height * 3.281"""
)
query = (
ESQL.from_("employees")
.eval("height * 3.281")
.stats(avg_height_feet=functions.avg(E("`height * 3.281`")))
)
assert (
query.render()
== """FROM employees
| EVAL height * 3.281
| STATS avg_height_feet = AVG(`height * 3.281`)"""
)
def test_fork():
query = (
ESQL.from_("employees")
.fork(
ESQL.branch().where(E("emp_no") == 10001),
ESQL.branch().where("emp_no == 10002"),
)
.keep("emp_no", "_fork")
.sort("emp_no")
)
assert (
query.render()
== """FROM employees
| FORK ( WHERE emp_no == 10001 )
( WHERE emp_no == 10002 )
| KEEP emp_no, _fork
| SORT emp_no"""
)
def test_grok():
query = (
ESQL.row(a="2023-01-23T12:15:00.000Z 127.0.0.1 some.email@foo.com 42")
.grok(
"a",
"%{TIMESTAMP_ISO8601:date} %{IP:ip} %{EMAILADDRESS:email} %{NUMBER:num}",
)
.keep("date", "ip", "email", "num")
)
assert (
query.render()
== """ROW a = "2023-01-23T12:15:00.000Z 127.0.0.1 some.email@foo.com 42"
| GROK a "%{TIMESTAMP_ISO8601:date} %{IP:ip} %{EMAILADDRESS:email} %{NUMBER:num}"
| KEEP date, ip, email, num"""
)
query = (
ESQL.row(a="2023-01-23T12:15:00.000Z 127.0.0.1 some.email@foo.com 42")
.grok(
"a",
"%{TIMESTAMP_ISO8601:date} %{IP:ip} %{EMAILADDRESS:email} %{NUMBER:num:int}",
)
.keep("date", "ip", "email", "num")
.eval(date=functions.to_datetime(E("date")))
)
assert (
query.render()
== """ROW a = "2023-01-23T12:15:00.000Z 127.0.0.1 some.email@foo.com 42"
| GROK a "%{TIMESTAMP_ISO8601:date} %{IP:ip} %{EMAILADDRESS:email} %{NUMBER:num:int}"
| KEEP date, ip, email, num
| EVAL date = TO_DATETIME(date)"""
)
query = (
ESQL.from_("addresses")
.keep("city.name", "zip_code")
.grok("zip_code", "%{WORD:zip_parts} %{WORD:zip_parts}")
)
assert (
query.render()
== """FROM addresses
| KEEP city.name, zip_code
| GROK zip_code "%{WORD:zip_parts} %{WORD:zip_parts}\""""
)
def test_keep():
query = ESQL.from_("employees").keep("emp_no", "first_name", "last_name", "height")
assert (
query.render() == "FROM employees\n| KEEP emp_no, first_name, last_name, height"
)
query = ESQL.from_("employees").keep("h*")
assert query.render() == "FROM employees\n| KEEP h*"
query = ESQL.from_("employees").keep("*", "first_name")
assert query.render() == "FROM employees\n| KEEP *, first_name"
def test_limit():
query = ESQL.from_("index").where(E("field") == "value").limit(1000)
assert query.render() == 'FROM index\n| WHERE field == "value"\n| LIMIT 1000'
query = (
ESQL.from_("index").stats(functions.avg(E("field1"))).by("field2").limit(20000)
)
assert (
query.render()
== "FROM index\n| STATS AVG(field1)\n BY field2\n| LIMIT 20000"
)
def test_lookup_join():
query = (
ESQL.from_("firewall_logs")
.lookup_join("threat_list")
.on("source.IP")
.where("threat_level IS NOT NULL")
)
assert (
query.render()
== """FROM firewall_logs
| LOOKUP JOIN threat_list ON source.IP
| WHERE threat_level IS NOT NULL"""
)
query = (
ESQL.from_("system_metrics")
.lookup_join("host_inventory")
.on("host.name")
.lookup_join("ownerships")
.on("host.name")
)
assert (
query.render()
== """FROM system_metrics
| LOOKUP JOIN host_inventory ON host.name
| LOOKUP JOIN ownerships ON host.name"""
)
query = ESQL.from_("app_logs").lookup_join("service_owners").on("service_id")
assert (
query.render()
== """FROM app_logs
| LOOKUP JOIN service_owners ON service_id"""
)
query = (
ESQL.from_("employees")
.eval(language_code="languages")
.where(E("emp_no") >= 10091, E("emp_no") < 10094)
.lookup_join("languages_lookup")
.on("language_code")
)
assert (
query.render()
== """FROM employees
| EVAL language_code = languages
| WHERE emp_no >= 10091 AND emp_no < 10094
| LOOKUP JOIN languages_lookup ON language_code"""
)
def test_mv_expand():
query = ESQL.row(a=[1, 2, 3], b="b", j=["a", "b"]).mv_expand("a")
assert (
query.render()
== """ROW a = [1, 2, 3], b = "b", j = ["a", "b"]
| MV_EXPAND a"""
)
def test_rename():
query = (
ESQL.from_("employees")
.keep("first_name", "last_name", "still_hired")
.rename(still_hired="employed")
)
assert (
query.render()
== """FROM employees
| KEEP first_name, last_name, still_hired
| RENAME still_hired AS employed"""
)
def test_sample():
query = ESQL.from_("employees").keep("emp_no").sample(0.05)
assert (
query.render()
== """FROM employees
| KEEP emp_no
| SAMPLE 0.05"""
)
def test_sort():
query = (
ESQL.from_("employees").keep("first_name", "last_name", "height").sort("height")
)
assert (
query.render()
== """FROM employees
| KEEP first_name, last_name, height
| SORT height"""
)
query = (
ESQL.from_("employees")
.keep("first_name", "last_name", "height")
.sort("height DESC")
)
assert (
query.render()
== """FROM employees
| KEEP first_name, last_name, height
| SORT height DESC"""
)
query = (
ESQL.from_("employees")
.keep("first_name", "last_name", "height")
.sort("height DESC", "first_name ASC")
)
assert (
query.render()
== """FROM employees
| KEEP first_name, last_name, height
| SORT height DESC, first_name ASC"""
)
query = (
ESQL.from_("employees")
.keep("first_name", "last_name", "height")
.sort("first_name ASC NULLS FIRST")
)
assert (
query.render()
== """FROM employees
| KEEP first_name, last_name, height
| SORT first_name ASC NULLS FIRST"""
)
def test_stats():
query = (
ESQL.from_("employees")
.stats(count=functions.count(E("emp_no")))
.by("languages")
.sort("languages")
)
assert (
query.render()
== """FROM employees
| STATS count = COUNT(emp_no)
BY languages
| SORT languages"""
)
query = ESQL.from_("employees").stats(avg_lang=functions.avg(E("languages")))
assert (
query.render()
== """FROM employees
| STATS avg_lang = AVG(languages)"""
)
query = ESQL.from_("employees").stats(
avg_lang=functions.avg(E("languages")), max_lang=functions.max(E("languages"))
)
assert (
query.render()
== """FROM employees
| STATS avg_lang = AVG(languages),
max_lang = MAX(languages)"""
)
query = (
ESQL.from_("employees")
.stats(
avg50s=functions.avg(E("salary")).where('birth_date < "1960-01-01"'),
avg60s=functions.avg(E("salary")).where('birth_date >= "1960-01-01"'),
)
.by("gender")
.sort("gender")
)
assert (
query.render()
== """FROM employees
| STATS avg50s = AVG(salary) WHERE birth_date < "1960-01-01",
avg60s = AVG(salary) WHERE birth_date >= "1960-01-01"
BY gender
| SORT gender"""
)
query = (
ESQL.from_("employees")
.eval(Ks="salary / 1000")
.stats(
under_40K=functions.count(E("*")).where("Ks < 40"),
inbetween=functions.count(E("*")).where("40 <= Ks", "Ks < 60"),
over_60K=functions.count(E("*")).where("60 <= Ks"),
total=functions.count(E("*")),
)
)
assert (
query.render()
== """FROM employees
| EVAL Ks = salary / 1000
| STATS under_40K = COUNT(*) WHERE Ks < 40,
inbetween = COUNT(*) WHERE (40 <= Ks) AND (Ks < 60),
over_60K = COUNT(*) WHERE 60 <= Ks,
total = COUNT(*)"""
)
query = (
ESQL.row(i=1, a=["a", "b"]).stats(functions.min(E("i"))).by("a").sort("a ASC")
)
assert (
query.render()
== 'ROW i = 1, a = ["a", "b"]\n| STATS MIN(i)\n BY a\n| SORT a ASC'
)
query = (
ESQL.from_("employees")
.eval(hired=functions.date_format(E("hire_date"), "yyyy"))
.stats(avg_salary=functions.avg(E("salary")))
.by("hired", "languages.long")
.eval(avg_salary=functions.round(E("avg_salary")))
.sort("hired", "languages.long")
)
assert (
query.render()
== """FROM employees
| EVAL hired = DATE_FORMAT("yyyy", hire_date)
| STATS avg_salary = AVG(salary)
BY hired, languages.long
| EVAL avg_salary = ROUND(avg_salary)
| SORT hired, languages.long"""
)
def test_where():
query = (
ESQL.from_("employees")
.keep("first_name", "last_name", "still_hired")
.where("still_hired == true")
)
assert (
query.render()
== """FROM employees
| KEEP first_name, last_name, still_hired
| WHERE still_hired == true"""
)
query = ESQL.from_("sample_data").where("@timestamp > NOW() - 1 hour")
assert (
query.render()
== """FROM sample_data
| WHERE @timestamp > NOW() - 1 hour"""
)
query = (
ESQL.from_("employees")
.keep("first_name", "last_name", "height")
.where("LENGTH(first_name) < 4")
)
assert (
query.render()
== """FROM employees
| KEEP first_name, last_name, height
| WHERE LENGTH(first_name) < 4"""
)
def test_and_operator():
query = ESQL.from_("index").where(
and_(E("age") > 30, E("age") < 40, E("name").is_not_null())
)
assert (
query.render()
== """FROM index
| WHERE (age > 30) AND (age < 40) AND (name IS NOT NULL)"""
)
def test_or_operator():
query = ESQL.from_("index").where(
or_(E("age") < 30, E("age") > 40, E("name").is_null())
)
assert (
query.render()
== """FROM index
| WHERE (age < 30) OR (age > 40) OR (name IS NULL)"""
)
def test_not_operator():
query = ESQL.from_("index").where(not_(E("age") > 40))
assert (
query.render()
== """FROM index
| WHERE NOT (age > 40)"""
)
def test_in_operator():
query = ESQL.row(a=1, b=4, c=3).where((E("c") - E("a")).in_(3, E("b") / 2, "a"))
assert (
query.render()
== """ROW a = 1, b = 4, c = 3
| WHERE c - a IN (3, b / 2, a)"""
)
def test_like_operator():
query = (
ESQL.from_("employees")
.where(E("first_name").like("?b*"))
.keep("first_name", "last_name")
)
assert (
query.render()
== """FROM employees
| WHERE first_name LIKE "?b*"
| KEEP first_name, last_name"""
)
query = ESQL.row(message="foo * bar").where(E("message").like("foo \\* bar"))
assert (
query.render()
== """ROW message = "foo * bar"
| WHERE message LIKE "foo \\\\* bar\""""
)
query = ESQL.row(message="foobar").where(E("message").like("foo*", "bar?"))
assert (
query.render()
== """ROW message = "foobar"
| WHERE message LIKE ("foo*", "bar?")"""
)
def test_rlike_operator():
query = (
ESQL.from_("employees")
.where(E("first_name").rlike(".leja*"))
.keep("first_name", "last_name")
)
assert (
query.render()
== """FROM employees
| WHERE first_name RLIKE ".leja*"
| KEEP first_name, last_name"""
)
query = ESQL.row(message="foo ( bar").where(E("message").rlike("foo \\( bar"))
assert (
query.render()
== """ROW message = "foo ( bar"
| WHERE message RLIKE "foo \\\\( bar\""""
)
query = ESQL.row(message="foobar").where(E("message").rlike("foo.*", "bar."))
assert (
query.render()
== """ROW message = "foobar"
| WHERE message RLIKE ("foo.*", "bar.")"""
)
def test_match_operator():
query = ESQL.from_("books").where(E("author").match("Faulkner"))
assert (
query.render()
== """FROM books
| WHERE author:"Faulkner\""""
)
|