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
|
# 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.
import pytest
from elasticsearch.dsl import AsyncDocument, InnerDoc, M
from elasticsearch.esql import ESQL, E, functions
class Address(InnerDoc):
address: M[str]
city: M[str]
class Employee(AsyncDocument):
emp_no: M[int]
first_name: M[str]
last_name: M[str]
height: M[float]
still_hired: M[bool]
address: M[Address]
class Index:
name = "employees"
async def load_db():
data = [
[
10000,
"Joseph",
"Wall",
2.2,
True,
Address(address="8875 Long Shoals Suite 441", city="Marcville, TX"),
],
[
10001,
"Stephanie",
"Ward",
1.749,
True,
Address(address="90162 Carter Harbor Suite 099", city="Davisborough, DE"),
],
[
10002,
"David",
"Keller",
1.872,
True,
Address(address="6697 Patrick Union Suite 797", city="Fuentesmouth, SD"),
],
[
10003,
"Roger",
"Hinton",
1.694,
False,
Address(address="809 Kelly Mountains", city="South Megan, DE"),
],
[
10004,
"Joshua",
"Garcia",
1.661,
False,
Address(address="718 Angela Forks", city="Port Erinland, MA"),
],
[
10005,
"Matthew",
"Richards",
1.633,
False,
Address(address="2869 Brown Mountains", city="New Debra, NH"),
],
[
10006,
"Maria",
"Luna",
1.893,
True,
Address(address="5861 Morgan Springs", city="Lake Daniel, WI"),
],
[
10007,
"Angela",
"Navarro",
1.604,
False,
Address(address="2848 Allen Station", city="Saint Joseph, OR"),
],
[
10008,
"Maria",
"Cannon",
2.079,
False,
Address(address="322 NW Johnston", city="Bakerburgh, MP"),
],
[
10009,
"Joseph",
"Sutton",
2.025,
True,
Address(address="77 Cardinal E", city="Lakestown, IL"),
],
]
if await Employee._index.exists():
await Employee._index.delete()
await Employee.init()
for e in data:
employee = Employee(
emp_no=e[0],
first_name=e[1],
last_name=e[2],
height=e[3],
still_hired=e[4],
address=e[5],
)
await employee.save()
await Employee._index.refresh()
@pytest.mark.asyncio
async def test_esql(async_client):
await load_db()
# get the full names of the employees
query = (
ESQL.from_(Employee)
.eval(full_name=functions.concat(Employee.first_name, " ", Employee.last_name))
.keep("full_name")
.sort("full_name")
.limit(10)
)
r = await async_client.esql.query(query=str(query))
assert r.body["values"] == [
["Angela Navarro"],
["David Keller"],
["Joseph Sutton"],
["Joseph Wall"],
["Joshua Garcia"],
["Maria Cannon"],
["Maria Luna"],
["Matthew Richards"],
["Roger Hinton"],
["Stephanie Ward"],
]
# get the average height of all hired employees
query = ESQL.from_(Employee).stats(
avg_height=functions.round(functions.avg(Employee.height), 2).where(
Employee.still_hired == True # noqa: E712
)
)
r = await async_client.esql.query(query=str(query))
assert r.body["values"] == [[1.95]]
# find employees by name using a parameter
query = (
ESQL.from_(Employee)
.where(Employee.first_name == E("?"))
.keep(Employee.last_name)
.sort(Employee.last_name.desc())
)
r = await async_client.esql.query(query=str(query), params=["Maria"])
assert r.body["values"] == [["Luna"], ["Cannon"]]
@pytest.mark.asyncio
async def test_esql_dsl(async_client):
await load_db()
# get employees with first name "Maria"
query = (
Employee.esql_from()
.where(Employee.first_name == "Maria")
.sort("last_name")
.limit(10)
)
marias = []
async for emp in Employee.esql_execute(query):
marias.append(emp)
assert len(marias) == 2
assert marias[0].last_name == "Cannon"
assert marias[0].address.address == "322 NW Johnston"
assert marias[0].address.city == "Bakerburgh, MP"
assert marias[1].last_name == "Luna"
assert marias[1].address.address == "5861 Morgan Springs"
assert marias[1].address.city == "Lake Daniel, WI"
# run a query with a missing field
query = (
Employee.esql_from()
.where(Employee.first_name == "Maria")
.drop(Employee.address.city)
.sort("last_name")
.limit(10)
)
with pytest.raises(ValueError):
await Employee.esql_execute(query).__anext__()
marias = []
async for emp in Employee.esql_execute(query, ignore_missing_fields=True):
marias.append(emp)
assert marias[0].last_name == "Cannon"
assert marias[0].address.address == "322 NW Johnston"
assert marias[0].address.city is None
assert marias[1].last_name == "Luna"
assert marias[1].address.address == "5861 Morgan Springs"
assert marias[1].address.city is None
# run a query with additional calculated fields
query = (
Employee.esql_from()
.where(Employee.first_name == "Maria")
.eval(
full_name=functions.concat(Employee.first_name, " ", Employee.last_name),
height_cm=functions.to_integer(Employee.height * 100),
)
.sort("last_name")
.limit(10)
)
assert isinstance(await Employee.esql_execute(query).__anext__(), Employee)
assert isinstance(
await Employee.esql_execute(query, return_additional=True).__anext__(), tuple
)
marias = []
async for emp, extra in Employee.esql_execute(query, return_additional=True):
marias.append([emp, extra])
assert marias[0][0].last_name == "Cannon"
assert marias[0][0].address.address == "322 NW Johnston"
assert marias[0][0].address.city == "Bakerburgh, MP"
assert marias[0][1] == {"full_name": "Maria Cannon", "height_cm": 208}
assert marias[1][0].last_name == "Luna"
assert marias[1][0].address.address == "5861 Morgan Springs"
assert marias[1][0].address.city == "Lake Daniel, WI"
assert marias[1][1] == {"full_name": "Maria Luna", "height_cm": 189}
|