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 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>7.13.2. Script syntax — Groonga v10.1.1-31-g1e46ba6 documentation</title>
<link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/language_data.js"></script>
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="7.14. Regular expression" href="../regular_expression.html" />
<link rel="prev" title="7.13.1. Query syntax" href="query_syntax.html" />
</head><body>
<div class="header">
<h1 class="title">
<a id="top-link" href="../../index.html">
<span class="project">groonga</span>
<span class="separator">-</span>
<span class="description">An open-source fulltext search engine and column store.</span>
</a>
</h1>
<div class="other-language-links">
<ul>
<li><a href="../../../../ja/html/reference/grn_expr/script_syntax.html">日本語</a></li>
</ul>
</div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../regular_expression.html" title="7.14. Regular expression"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="query_syntax.html" title="7.13.1. Query syntax"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> »</li>
<li class="nav-item nav-item-2"><a href="../grn_expr.html" accesskey="U"><span class="section-number">7.13. </span>grn_expr</a> »</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">7.13.2. </span>Script syntax</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="script-syntax">
<h1><span class="section-number">7.13.2. </span>Script syntax<a class="headerlink" href="#script-syntax" title="Permalink to this headline">¶</a></h1>
<p>Script syntax is a syntax to specify complex search condition. It is
similar to ECMAScript. For example, <code class="docutils literal notranslate"><span class="pre">_key</span> <span class="pre">==</span> <span class="pre">"book"</span></code> means that
groonga searches records that <code class="docutils literal notranslate"><span class="pre">_key</span></code> value is <code class="docutils literal notranslate"><span class="pre">"book"</span></code>. All values
are string in <a class="reference internal" href="query_syntax.html"><span class="doc">Query syntax</span></a> but its own type in script
syntax. For example, <code class="docutils literal notranslate"><span class="pre">"book"</span></code> is string, <code class="docutils literal notranslate"><span class="pre">1</span></code> is integer,
<code class="docutils literal notranslate"><span class="pre">TokenBigram</span></code> is the object whose name is <code class="docutils literal notranslate"><span class="pre">TokenBigram</span></code> and so on.</p>
<p>Script syntax doesn’t support full ECMAScript syntax. For example,
script syntax doesn’t support statement such as <code class="docutils literal notranslate"><span class="pre">if</span></code> control
statement, <code class="docutils literal notranslate"><span class="pre">for</span></code> iteration statement and variable definition
statement. Function definion is not supported too. But script syntax
addes the original additional operators. They are described after
ECMAScript syntax is described.</p>
<div class="section" id="security">
<span id="script-syntax-security"></span><h2><span class="section-number">7.13.2.1. </span>Security<a class="headerlink" href="#security" title="Permalink to this headline">¶</a></h2>
<p>For security reason, you should not pass an input from users to
Groonga directly. If there is an evil user, the user may input a query
that retrieves records that should not be shown to the user.</p>
<p>Think about the following case.</p>
<p>A Groonga application constructs a Groonga request by the following
program:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>filter = "column @ \"#{user_input}\""
select_options = {
# ...
:filter => filter,
}
groonga_client.select(select_options)
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">user_input</span></code> is an input from user. If the input is <code class="docutils literal notranslate"><span class="pre">query</span></code>,
here is the constructed <a class="reference internal" href="../commands/select.html#select-filter"><span class="std std-ref">filter</span></a> parameter:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>column @ "query"
</pre></div>
</div>
<p>If the input is <code class="docutils literal notranslate"><span class="pre">x"</span> <span class="pre">||</span> <span class="pre">true</span> <span class="pre">||</span> <span class="pre">"</span></code>, here is the constructed
<a class="reference internal" href="../commands/select.html#select-filter"><span class="std std-ref">filter</span></a> parameter:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>column @ "x" || true || ""
</pre></div>
</div>
<p>This query matches to all records. The user will get all records from
your database. The user may be evil.</p>
<p>It’s better that you just receive an user input as a value. It means
that you don’t accept that user input can contain operator such as
<code class="docutils literal notranslate"><span class="pre">@</span></code> and <code class="docutils literal notranslate"><span class="pre">&&</span></code>. If you accept operator, user can create evil query.</p>
<p>If user input has only value, you blocks evil query by escaping user
input value. Here is a list how to escape user input value:</p>
<blockquote>
<div><ul class="simple">
<li><p>True value: Convert it to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p></li>
<li><p>False value: Convert it to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p></li>
<li><p>Numerical value: Convert it to <a class="reference internal" href="#script-syntax-literal-integer"><span class="std std-ref">Integer</span></a>
or <a class="reference internal" href="#script-syntax-literal-float"><span class="std std-ref">Float</span></a>. For example, <code class="docutils literal notranslate"><span class="pre">1.2</span></code>,
<code class="docutils literal notranslate"><span class="pre">-10</span></code>, <code class="docutils literal notranslate"><span class="pre">314e-2</span></code> and so on.</p></li>
<li><p>String value: Replace <code class="docutils literal notranslate"><span class="pre">"</span></code> with <code class="docutils literal notranslate"><span class="pre">\"</span></code> and <code class="docutils literal notranslate"><span class="pre">\</span></code> with <code class="docutils literal notranslate"><span class="pre">\\</span></code> in
the string value and surround substituted string value by
<code class="docutils literal notranslate"><span class="pre">"</span></code>. For example, <code class="docutils literal notranslate"><span class="pre">double</span> <span class="pre">"</span> <span class="pre">quote</span> <span class="pre">and</span> <span class="pre">back</span> <span class="pre">\</span> <span class="pre">slash</span></code> should be
converted to <code class="docutils literal notranslate"><span class="pre">"double</span> <span class="pre">\"</span> <span class="pre">quote</span> <span class="pre">and</span> <span class="pre">back</span> <span class="pre">\\</span> <span class="pre">slash"</span></code>.</p></li>
</ul>
</div></blockquote>
</div>
<div class="section" id="sample-data">
<h2><span class="section-number">7.13.2.2. </span>Sample data<a class="headerlink" href="#sample-data" title="Permalink to this headline">¶</a></h2>
<p>Here are a schema definition and sample data to show usage.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create Entries TABLE_PAT_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries content COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries n_likes COLUMN_SCALAR UInt32
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms entries_key_index COLUMN_INDEX|WITH_POSITION Entries _key
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms entries_content_index COLUMN_INDEX|WITH_POSITION Entries content
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Entries
[
{"_key": "The first post!",
"content": "Welcome! This is my first post!",
"n_likes": 5},
{"_key": "Groonga",
"content": "I started to use Groonga. It's very fast!",
"n_likes": 10},
{"_key": "Mroonga",
"content": "I also started to use Mroonga. It's also very fast! Really fast!",
"n_likes": 15},
{"_key": "Good-bye Senna",
"content": "I migrated all Senna system!",
"n_likes": 3},
{"_key": "Good-bye Tritonn",
"content": "I also migrated all Tritonn system!",
"n_likes": 3}
]
# [[0, 1337566253.89858, 0.000355720520019531], 5]
</pre></div>
</div>
<p>There is a table, <code class="docutils literal notranslate"><span class="pre">Entries</span></code>, for blog entries. An entry has title,
content and the number of likes for the entry. Title is key of
<code class="docutils literal notranslate"><span class="pre">Entries</span></code>. Content is value of <code class="docutils literal notranslate"><span class="pre">Entries.content</span></code> column. The
number of likes is value of <code class="docutils literal notranslate"><span class="pre">Entries.n_likes</span></code> column.</p>
<p><code class="docutils literal notranslate"><span class="pre">Entries._key</span></code> column and <code class="docutils literal notranslate"><span class="pre">Entries.content</span></code> column are indexed
using <code class="docutils literal notranslate"><span class="pre">TokenBigram</span></code> tokenizer. So both <code class="docutils literal notranslate"><span class="pre">Entries._key</span></code> and
<code class="docutils literal notranslate"><span class="pre">Entries.content</span></code> are fulltext search ready.</p>
<p>OK. The schema and data for examples are ready.</p>
</div>
<div class="section" id="literals">
<span id="script-syntax-literals"></span><h2><span class="section-number">7.13.2.3. </span>Literals<a class="headerlink" href="#literals" title="Permalink to this headline">¶</a></h2>
<div class="section" id="integer">
<span id="script-syntax-literal-integer"></span><h3><span class="section-number">7.13.2.3.1. </span>Integer<a class="headerlink" href="#integer" title="Permalink to this headline">¶</a></h3>
<p>Integer literal is sequence of <code class="docutils literal notranslate"><span class="pre">0</span></code> to <code class="docutils literal notranslate"><span class="pre">9</span></code> such as
<code class="docutils literal notranslate"><span class="pre">1234567890</span></code>. <code class="docutils literal notranslate"><span class="pre">+</span></code> or <code class="docutils literal notranslate"><span class="pre">-</span></code> can be prepended as sign such as
<code class="docutils literal notranslate"><span class="pre">+29</span></code> and <code class="docutils literal notranslate"><span class="pre">-29</span></code>. Integer literal must be decimal. Octal notation,
hex and so on can’t be used.</p>
<p>The maximum value of integer literal is <code class="docutils literal notranslate"><span class="pre">9223372036854775807</span></code> (<code class="docutils literal notranslate"><span class="pre">=</span> <span class="pre">2</span>
<span class="pre">**</span> <span class="pre">63</span> <span class="pre">-</span> <span class="pre">1</span></code>). The minimum value of integer literal is
<code class="docutils literal notranslate"><span class="pre">-9223372036854775808</span></code> (<code class="docutils literal notranslate"><span class="pre">=</span> <span class="pre">-(2</span> <span class="pre">**</span> <span class="pre">63)</span></code>).</p>
</div>
<div class="section" id="float">
<span id="script-syntax-literal-float"></span><h3><span class="section-number">7.13.2.3.2. </span>Float<a class="headerlink" href="#float" title="Permalink to this headline">¶</a></h3>
<p>Float literal is sequence of <code class="docutils literal notranslate"><span class="pre">0</span></code> to <code class="docutils literal notranslate"><span class="pre">9</span></code>, <code class="docutils literal notranslate"><span class="pre">.</span></code> and <code class="docutils literal notranslate"><span class="pre">0</span></code> to <code class="docutils literal notranslate"><span class="pre">9</span></code>
such as <code class="docutils literal notranslate"><span class="pre">3.14</span></code>. <code class="docutils literal notranslate"><span class="pre">+</span></code> or <code class="docutils literal notranslate"><span class="pre">-</span></code> can be prepended as sign such as
<code class="docutils literal notranslate"><span class="pre">+3.14</span></code> and <code class="docutils literal notranslate"><span class="pre">-3.14</span></code>. <code class="docutils literal notranslate"><span class="pre">${RADIX}e${EXPORNENTIAL}</span></code> and
<code class="docutils literal notranslate"><span class="pre">${RADIX}E${EXPORNENTIAL}</span></code> formats are also supported. For example,
<code class="docutils literal notranslate"><span class="pre">314e-2</span></code> is the same as <code class="docutils literal notranslate"><span class="pre">3.14</span></code>.</p>
</div>
<div class="section" id="string">
<span id="script-syntax-literal-string"></span><h3><span class="section-number">7.13.2.3.3. </span>String<a class="headerlink" href="#string" title="Permalink to this headline">¶</a></h3>
<p>String literal is <code class="docutils literal notranslate"><span class="pre">"..."</span></code>. You need to escape <code class="docutils literal notranslate"><span class="pre">"</span></code> in literal by
prepending <code class="docutils literal notranslate"><span class="pre">\\''</span> <span class="pre">such</span> <span class="pre">as</span> <span class="pre">``\"</span></code>. For example, <code class="docutils literal notranslate"><span class="pre">"Say</span> <span class="pre">\"Hello!\"."</span></code> is
a literal for <code class="docutils literal notranslate"><span class="pre">Say</span> <span class="pre">"Hello!".</span></code> string.</p>
<p>String encoding must be the same as encoding of database. The default
encoding is UTF-8. It can be changed by <code class="docutils literal notranslate"><span class="pre">--with-default-encoding</span></code>
configure option, <code class="docutils literal notranslate"><span class="pre">--encodiong</span></code> <a class="reference internal" href="../executables/groonga.html"><span class="doc">groonga executable file</span></a> option
and so on.</p>
</div>
<div class="section" id="boolean">
<span id="script-syntax-literal-boolean"></span><h3><span class="section-number">7.13.2.3.4. </span>Boolean<a class="headerlink" href="#boolean" title="Permalink to this headline">¶</a></h3>
<p>Boolean literal is <code class="docutils literal notranslate"><span class="pre">true</span></code> and <code class="docutils literal notranslate"><span class="pre">false</span></code>. <code class="docutils literal notranslate"><span class="pre">true</span></code> means true and
<code class="docutils literal notranslate"><span class="pre">false</span></code> means false.</p>
</div>
<div class="section" id="null">
<span id="script-syntax-literal-null"></span><h3><span class="section-number">7.13.2.3.5. </span>Null<a class="headerlink" href="#null" title="Permalink to this headline">¶</a></h3>
<p>Null literal is <code class="docutils literal notranslate"><span class="pre">null</span></code>. Groonga doesn’t support null value but null
literal is supported.</p>
</div>
<div class="section" id="time">
<span id="script-syntax-literal-time"></span><h3><span class="section-number">7.13.2.3.6. </span>Time<a class="headerlink" href="#time" title="Permalink to this headline">¶</a></h3>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This is the groonga original notation.</p>
</div>
<p>Time literal doesn’t exit. There are string time notation, integer
time notation and float time notation.</p>
<p>String time notation is <code class="docutils literal notranslate"><span class="pre">"YYYY/MM/DD</span> <span class="pre">hh:mm:ss.uuuuuu"</span></code> or
<code class="docutils literal notranslate"><span class="pre">"YYYY-MM-DD</span> <span class="pre">hh:mm:ss.uuuuuu"</span></code>. <code class="docutils literal notranslate"><span class="pre">YYYY</span></code> is year, <code class="docutils literal notranslate"><span class="pre">MM</span></code> is month,
<code class="docutils literal notranslate"><span class="pre">DD</span></code> is day, <code class="docutils literal notranslate"><span class="pre">hh</span></code> is hour, <code class="docutils literal notranslate"><span class="pre">mm</span></code> is minute, <code class="docutils literal notranslate"><span class="pre">ss</span></code> is second and
<code class="docutils literal notranslate"><span class="pre">uuuuuu</span></code> is micro second. It is local time. For example,
<code class="docutils literal notranslate"><span class="pre">"2012/07/23</span> <span class="pre">02:41:10.436218"</span></code> is <code class="docutils literal notranslate"><span class="pre">2012-07-23T02:41:10.436218</span></code> in
ISO 8601 format.</p>
<p>Integer time notation is the number of seconds that have elapsed since
midnight UTC, January 1, 1970. It is also known as POSIX time. For
example, <code class="docutils literal notranslate"><span class="pre">1343011270</span></code> is <code class="docutils literal notranslate"><span class="pre">2012-07-23T02:41:10Z</span></code> in ISO 8601 format.</p>
<p>Float time notation is the number of seconds and micro seconds that
have elapsed since midnight UTC, January 1, 1970. For example,
<code class="docutils literal notranslate"><span class="pre">1343011270.436218</span></code> is <code class="docutils literal notranslate"><span class="pre">2012-07-23T02:41:10.436218Z</span></code> in ISO 8601
format.</p>
</div>
<div class="section" id="geo-point">
<span id="script-syntax-literal-geo-point"></span><h3><span class="section-number">7.13.2.3.7. </span>Geo point<a class="headerlink" href="#geo-point" title="Permalink to this headline">¶</a></h3>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This is the groonga original notation.</p>
</div>
<p>Geo point literal doesn’t exist. There is string geo point notation.</p>
<p>String geo point notation has the following patterns:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">"LATITUDE_IN_MSECxLONGITUDE_IN_MSEC"</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">"LATITUDE_IN_MSEC,LONGITUDE_IN_MSEC"</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">"LATITUDE_IN_DEGREExLONGITUDE_IN_DEGREE"</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">"LATITUDE_IN_DEGREE,LONGITUDE_IN_DEGREE"</span></code></p></li>
</ul>
</div></blockquote>
<p><code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">,</span></code> can be used for separator. Latitude and longitude can
be represented in milliseconds or degree.</p>
</div>
<div class="section" id="array">
<span id="script-syntax-literal-array"></span><h3><span class="section-number">7.13.2.3.8. </span>Array<a class="headerlink" href="#array" title="Permalink to this headline">¶</a></h3>
<p>Array literal is <code class="docutils literal notranslate"><span class="pre">[element1,</span> <span class="pre">element2,</span> <span class="pre">...]</span></code>.</p>
</div>
<div class="section" id="object-literal">
<span id="script-syntax-literal-object"></span><h3><span class="section-number">7.13.2.3.9. </span>Object literal<a class="headerlink" href="#object-literal" title="Permalink to this headline">¶</a></h3>
<p>Object literal is <code class="docutils literal notranslate"><span class="pre">{name1:</span> <span class="pre">value1,</span> <span class="pre">name2:</span> <span class="pre">value2,</span> <span class="pre">...}</span></code>. Groonga
doesn’t support object literal yet.</p>
</div>
</div>
<div class="section" id="control-syntaxes">
<h2><span class="section-number">7.13.2.4. </span>Control syntaxes<a class="headerlink" href="#control-syntaxes" title="Permalink to this headline">¶</a></h2>
<p>Script syntax doesn’t support statement. So you cannot use control
statement such as <code class="docutils literal notranslate"><span class="pre">if</span></code>. You can only use <code class="docutils literal notranslate"><span class="pre">A</span> <span class="pre">?</span> <span class="pre">B</span> <span class="pre">:</span> <span class="pre">C</span></code> expression as
control syntax.</p>
<p><code class="docutils literal notranslate"><span class="pre">A</span> <span class="pre">?</span> <span class="pre">B</span> <span class="pre">:</span> <span class="pre">C</span></code> returns <code class="docutils literal notranslate"><span class="pre">B</span></code> if <code class="docutils literal notranslate"><span class="pre">A</span></code> is true, <code class="docutils literal notranslate"><span class="pre">C</span></code> otherwise.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == (_id == 1 ? 5 : 3)'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 3
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 4,
# "Good-bye Senna",
# "I migrated all Senna system!",
# 3
# ],
# [
# 5,
# "Good-bye Tritonn",
# "I also migrated all Tritonn system!",
# 3
# ],
# [
# 1,
# "The first post!",
# "Welcome! This is my first post!",
# 5
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that <code class="docutils literal notranslate"><span class="pre">_id</span></code> column value is equal to <code class="docutils literal notranslate"><span class="pre">1</span></code>
and <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value is equal to <code class="docutils literal notranslate"><span class="pre">5</span></code> or <code class="docutils literal notranslate"><span class="pre">_id</span></code> column value is
not equal to 1 and <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value is equal to <code class="docutils literal notranslate"><span class="pre">3</span></code>.</p>
</div>
<div class="section" id="grouping">
<h2><span class="section-number">7.13.2.5. </span>Grouping<a class="headerlink" href="#grouping" title="Permalink to this headline">¶</a></h2>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">(...)</span></code>. <code class="docutils literal notranslate"><span class="pre">...</span></code> is comma separated expression list.</p>
<p><code class="docutils literal notranslate"><span class="pre">(...)</span></code> groups one ore more expressions and they can be processed as
an expression. <code class="docutils literal notranslate"><span class="pre">a</span> <span class="pre">&&</span> <span class="pre">b</span> <span class="pre">||</span> <span class="pre">c</span></code> means that <code class="docutils literal notranslate"><span class="pre">a</span></code> and <code class="docutils literal notranslate"><span class="pre">b</span></code> are matched
or <code class="docutils literal notranslate"><span class="pre">c</span></code> is matched. <code class="docutils literal notranslate"><span class="pre">a</span> <span class="pre">&&</span> <span class="pre">(b</span> <span class="pre">||</span> <span class="pre">c)</span></code> means that <code class="docutils literal notranslate"><span class="pre">a</span></code> and one of
<code class="docutils literal notranslate"><span class="pre">b</span></code> and <code class="docutils literal notranslate"><span class="pre">c</span></code> are matched.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes < 5 && content @ "senna" || content @ "fast"'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 3
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 4,
# "Good-bye Senna",
# "I migrated all Senna system!",
# 3
# ],
# [
# 2,
# "Groonga",
# "I started to use Groonga. It's very fast!",
# 10
# ],
# [
# 3,
# "Mroonga",
# "I also started to use Mroonga. It's also very fast! Really fast!",
# 15
# ]
# ]
# ]
# ]
select Entries --filter 'n_likes < 5 && (content @ "senna" || content @ "fast")'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 1
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 4,
# "Good-bye Senna",
# "I migrated all Senna system!",
# 3
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The first expression doesn’t use grouping. It matches records that
<code class="docutils literal notranslate"><span class="pre">n_likes</span> <span class="pre"><</span> <span class="pre">5</span></code> and <code class="docutils literal notranslate"><span class="pre">content</span> <span class="pre">@</span> <span class="pre">"senna"</span></code> are matched or
<code class="docutils literal notranslate"><span class="pre">content</span> <span class="pre">@</span> <span class="pre">"fast"</span></code> is matched.</p>
<p>The second expression uses grouping. It matches records that <code class="docutils literal notranslate"><span class="pre">n_likes</span>
<span class="pre"><</span> <span class="pre">5</span></code> and one of <code class="docutils literal notranslate"><span class="pre">content</span> <span class="pre">@</span> <span class="pre">"senna"</span></code> or <code class="docutils literal notranslate"><span class="pre">content</span> <span class="pre">@</span> <span class="pre">"fast"</span></code> are
matched.</p>
</div>
<div class="section" id="function-call">
<h2><span class="section-number">7.13.2.6. </span>Function call<a class="headerlink" href="#function-call" title="Permalink to this headline">¶</a></h2>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">name(arugment1,</span> <span class="pre">argument2,</span> <span class="pre">...)</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">name(argument1,</span> <span class="pre">argument2,</span> <span class="pre">...)</span></code> calls a function that is named
<code class="docutils literal notranslate"><span class="pre">name</span></code> with arguments <code class="docutils literal notranslate"><span class="pre">argument1</span></code>, <code class="docutils literal notranslate"><span class="pre">argument2</span></code> and <code class="docutils literal notranslate"><span class="pre">...</span></code>.</p>
<p>See <a class="reference internal" href="../function.html"><span class="doc">Function</span></a> for available functin list.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'edit_distance(_key, "Groonga") <= 1'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 2
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 2,
# "Groonga",
# "I started to use Groonga. It's very fast!",
# 10
# ],
# [
# 3,
# "Mroonga",
# "I also started to use Mroonga. It's also very fast! Really fast!",
# 15
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression uses <a class="reference internal" href="../functions/edit_distance.html"><span class="doc">edit_distance</span></a>. It
matches records that <code class="docutils literal notranslate"><span class="pre">_key</span></code> column value is similar to
<code class="docutils literal notranslate"><span class="pre">"Groonga"</span></code>. Similality of <code class="docutils literal notranslate"><span class="pre">"Groonga"</span></code> is computed as edit
distance. If edit distance is less than or equal to 1, the value is
treated as similar. In this case, <code class="docutils literal notranslate"><span class="pre">"Groonga"</span></code> and <code class="docutils literal notranslate"><span class="pre">"Mroonga"</span></code> are
treated as similar.</p>
</div>
<div class="section" id="basic-operators">
<h2><span class="section-number">7.13.2.7. </span>Basic operators<a class="headerlink" href="#basic-operators" title="Permalink to this headline">¶</a></h2>
<p>Groonga supports operators defined in ECMAScript.</p>
<div class="section" id="arithmetic-operators">
<h3><span class="section-number">7.13.2.7.1. </span>Arithmetic operators<a class="headerlink" href="#arithmetic-operators" title="Permalink to this headline">¶</a></h3>
<p>Here are arithmetic operators.</p>
<div class="section" id="addition-operator">
<h4><span class="section-number">7.13.2.7.1.1. </span>Addition operator<a class="headerlink" href="#addition-operator" title="Permalink to this headline">¶</a></h4>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">number1</span> <span class="pre">+</span> <span class="pre">number2</span></code>.</p>
<p>The operator adds <code class="docutils literal notranslate"><span class="pre">number1</span></code> and <code class="docutils literal notranslate"><span class="pre">number2</span></code> and returns the result.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == 10 + 5'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 1
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 3,
# "Mroonga",
# "I also started to use Mroonga. It's also very fast! Really fast!",
# 15
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value is equal
to <code class="docutils literal notranslate"><span class="pre">15</span></code> (= <code class="docutils literal notranslate"><span class="pre">10</span> <span class="pre">+</span> <span class="pre">5</span></code>).</p>
</div>
<div class="section" id="subtraction-operator">
<h4><span class="section-number">7.13.2.7.1.2. </span>Subtraction operator<a class="headerlink" href="#subtraction-operator" title="Permalink to this headline">¶</a></h4>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">number1</span> <span class="pre">-</span> <span class="pre">number2</span></code>.</p>
<p>The operator subtracts <code class="docutils literal notranslate"><span class="pre">number2</span></code> from <code class="docutils literal notranslate"><span class="pre">number1</span></code> and returns the result.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == 20 - 5'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 1
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 3,
# "Mroonga",
# "I also started to use Mroonga. It's also very fast! Really fast!",
# 15
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value is equal
to <code class="docutils literal notranslate"><span class="pre">15</span></code> (= <code class="docutils literal notranslate"><span class="pre">20</span> <span class="pre">-</span> <span class="pre">5</span></code>).</p>
</div>
<div class="section" id="multiplication-operator">
<h4><span class="section-number">7.13.2.7.1.3. </span>Multiplication operator<a class="headerlink" href="#multiplication-operator" title="Permalink to this headline">¶</a></h4>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">number1</span> <span class="pre">*</span> <span class="pre">number2</span></code>.</p>
<p>The operator multiplies <code class="docutils literal notranslate"><span class="pre">number1</span></code> and <code class="docutils literal notranslate"><span class="pre">number2</span></code> and returns the result.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == 3 * 5'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 1
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 3,
# "Mroonga",
# "I also started to use Mroonga. It's also very fast! Really fast!",
# 15
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value is equal
to <code class="docutils literal notranslate"><span class="pre">15</span></code> (= <code class="docutils literal notranslate"><span class="pre">3</span> <span class="pre">*</span> <span class="pre">5</span></code>).</p>
</div>
<div class="section" id="division-operator">
<h4><span class="section-number">7.13.2.7.1.4. </span>Division operator<a class="headerlink" href="#division-operator" title="Permalink to this headline">¶</a></h4>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">number1</span> <span class="pre">/</span> <span class="pre">number2</span></code> and <code class="docutils literal notranslate"><span class="pre">number1</span> <span class="pre">%</span> <span class="pre">number2</span></code>.</p>
<p>The operator divides <code class="docutils literal notranslate"><span class="pre">number2</span></code> by <code class="docutils literal notranslate"><span class="pre">number1</span></code>. <code class="docutils literal notranslate"><span class="pre">/</span></code> returns the
quotient of result. <code class="docutils literal notranslate"><span class="pre">%</span></code> returns the remainder of result.</p>
<p>Here is simple examples.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == 26 / 7'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 2
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 4,
# "Good-bye Senna",
# "I migrated all Senna system!",
# 3
# ],
# [
# 5,
# "Good-bye Tritonn",
# "I also migrated all Tritonn system!",
# 3
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value is equal
to <code class="docutils literal notranslate"><span class="pre">3</span></code> (= <code class="docutils literal notranslate"><span class="pre">26</span> <span class="pre">/</span> <span class="pre">7</span></code>).</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == 26 % 7'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 1
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 1,
# "The first post!",
# "Welcome! This is my first post!",
# 5
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value is equal
to <code class="docutils literal notranslate"><span class="pre">5</span></code> (= <code class="docutils literal notranslate"><span class="pre">26</span> <span class="pre">%</span> <span class="pre">7</span></code>).</p>
</div>
</div>
<div class="section" id="logical-operators">
<h3><span class="section-number">7.13.2.7.2. </span>Logical operators<a class="headerlink" href="#logical-operators" title="Permalink to this headline">¶</a></h3>
<p>Here are logical operators.</p>
<div class="section" id="logical-not-operator">
<h4><span class="section-number">7.13.2.7.2.1. </span>Logical NOT operator<a class="headerlink" href="#logical-not-operator" title="Permalink to this headline">¶</a></h4>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">!condition</span></code>.</p>
<p>The operator inverts boolean value of <code class="docutils literal notranslate"><span class="pre">condition</span></code>.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter '!(n_likes == 5)'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 4
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 4,
# "Good-bye Senna",
# "I migrated all Senna system!",
# 3
# ],
# [
# 5,
# "Good-bye Tritonn",
# "I also migrated all Tritonn system!",
# 3
# ],
# [
# 2,
# "Groonga",
# "I started to use Groonga. It's very fast!",
# 10
# ],
# [
# 3,
# "Mroonga",
# "I also started to use Mroonga. It's also very fast! Really fast!",
# 15
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value is not
equal to <code class="docutils literal notranslate"><span class="pre">5</span></code>.</p>
</div>
<div class="section" id="logical-and-operator">
<h4><span class="section-number">7.13.2.7.2.2. </span>Logical AND operator<a class="headerlink" href="#logical-and-operator" title="Permalink to this headline">¶</a></h4>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">condition1</span> <span class="pre">&&</span> <span class="pre">condition2</span></code>.</p>
<p>The operator returns true if both of <code class="docutils literal notranslate"><span class="pre">condition1</span></code> and
<code class="docutils literal notranslate"><span class="pre">condition2</span></code> are true, false otherwise.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'content @ "fast" && n_likes >= 10'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 2
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 2,
# "Groonga",
# "I started to use Groonga. It's very fast!",
# 10
# ],
# [
# 3,
# "Mroonga",
# "I also started to use Mroonga. It's also very fast! Really fast!",
# 15
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that <code class="docutils literal notranslate"><span class="pre">content</span></code> column value has the
word <code class="docutils literal notranslate"><span class="pre">fast</span></code> and <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value is greater or equal to
<code class="docutils literal notranslate"><span class="pre">10</span></code>.</p>
</div>
<div class="section" id="logical-or-operator">
<h4><span class="section-number">7.13.2.7.2.3. </span>Logical OR operator<a class="headerlink" href="#logical-or-operator" title="Permalink to this headline">¶</a></h4>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">condition1</span> <span class="pre">||</span> <span class="pre">condition2</span></code>.</p>
<p>The operator returns true if either <code class="docutils literal notranslate"><span class="pre">condition1</span></code> or <code class="docutils literal notranslate"><span class="pre">condition2</span></code> is
true, false otherwise.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == 5 || n_likes == 10'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 2
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 1,
# "The first post!",
# "Welcome! This is my first post!",
# 5
# ],
# [
# 2,
# "Groonga",
# "I started to use Groonga. It's very fast!",
# 10
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value is equal
to <code class="docutils literal notranslate"><span class="pre">5</span></code> or <code class="docutils literal notranslate"><span class="pre">10</span></code>.</p>
</div>
<div class="section" id="logical-and-not-operator">
<h4><span class="section-number">7.13.2.7.2.4. </span>Logical AND NOT operator<a class="headerlink" href="#logical-and-not-operator" title="Permalink to this headline">¶</a></h4>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">condition1</span> <span class="pre">&!</span> <span class="pre">condition2</span></code>.</p>
<p>The operator returns true if <code class="docutils literal notranslate"><span class="pre">condition1</span></code> is true but <code class="docutils literal notranslate"><span class="pre">condition2</span></code>
is false, false otherwise. It returns difference set.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'content @ "fast" &! content @ "mroonga"'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 1
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 2,
# "Groonga",
# "I started to use Groonga. It's very fast!",
# 10
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that <code class="docutils literal notranslate"><span class="pre">content</span></code> column value has the
word <code class="docutils literal notranslate"><span class="pre">fast</span></code> but doesn’t have the word <code class="docutils literal notranslate"><span class="pre">mroonga</span></code>.</p>
</div>
</div>
<div class="section" id="bitwise-operators">
<span id="script-syntax-bitwise-operators"></span><h3><span class="section-number">7.13.2.7.3. </span>Bitwise operators<a class="headerlink" href="#bitwise-operators" title="Permalink to this headline">¶</a></h3>
<p>Here are bitwise operators.</p>
<div class="section" id="bitwise-not-operator">
<span id="script-syntax-bitwise-not"></span><h4><span class="section-number">7.13.2.7.3.1. </span>Bitwise NOT operator<a class="headerlink" href="#bitwise-not-operator" title="Permalink to this headline">¶</a></h4>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">~number</span></code>.</p>
<p>The operator returns bitwise NOT of <code class="docutils literal notranslate"><span class="pre">number</span></code>.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter '~n_likes == -6'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 1
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 1,
# "The first post!",
# "Welcome! This is my first post!",
# 5
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value is equal
to <code class="docutils literal notranslate"><span class="pre">5</span></code> because bitwise NOT of <code class="docutils literal notranslate"><span class="pre">5</span></code> is equal to <code class="docutils literal notranslate"><span class="pre">-6</span></code>.</p>
</div>
<div class="section" id="bitwise-and-operator">
<span id="script-syntax-bitwise-and"></span><h4><span class="section-number">7.13.2.7.3.2. </span>Bitwise AND operator<a class="headerlink" href="#bitwise-and-operator" title="Permalink to this headline">¶</a></h4>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">number1</span> <span class="pre">&</span> <span class="pre">number2</span></code>.</p>
<p>The operator returns bitwise AND between <code class="docutils literal notranslate"><span class="pre">number1</span></code> and <code class="docutils literal notranslate"><span class="pre">number2</span></code>.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter '(n_likes & 1) == 1'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 4
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 4,
# "Good-bye Senna",
# "I migrated all Senna system!",
# 3
# ],
# [
# 5,
# "Good-bye Tritonn",
# "I also migrated all Tritonn system!",
# 3
# ],
# [
# 3,
# "Mroonga",
# "I also started to use Mroonga. It's also very fast! Really fast!",
# 15
# ],
# [
# 1,
# "The first post!",
# "Welcome! This is my first post!",
# 5
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value is even
number because bitwise AND between an even number and <code class="docutils literal notranslate"><span class="pre">1</span></code> is equal
to <code class="docutils literal notranslate"><span class="pre">1</span></code> and bitwise AND between an odd number and <code class="docutils literal notranslate"><span class="pre">1</span></code> is equal to
<code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>
</div>
</div>
<div class="section" id="bitwise-or-operator">
<span id="script-syntax-bitwise-or"></span><h3><span class="section-number">7.13.2.7.4. </span>Bitwise OR operator<a class="headerlink" href="#bitwise-or-operator" title="Permalink to this headline">¶</a></h3>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">number1</span> <span class="pre">|</span> <span class="pre">number2</span></code>.</p>
<p>The operator returns bitwise OR between <code class="docutils literal notranslate"><span class="pre">number1</span></code> and <code class="docutils literal notranslate"><span class="pre">number2</span></code>.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == (1 | 4)'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 1
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 1,
# "The first post!",
# "Welcome! This is my first post!",
# 5
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value is equal
to <code class="docutils literal notranslate"><span class="pre">5</span></code> (= <code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre">|</span> <span class="pre">4</span></code>).</p>
</div>
<div class="section" id="bitwise-xor-operator">
<span id="script-syntax-bitwise-xor"></span><h3><span class="section-number">7.13.2.7.5. </span>Bitwise XOR operator<a class="headerlink" href="#bitwise-xor-operator" title="Permalink to this headline">¶</a></h3>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">number1</span> <span class="pre">^</span> <span class="pre">number2</span></code>.</p>
<p>The operator returns bitwise XOR between <code class="docutils literal notranslate"><span class="pre">number1</span></code> and <code class="docutils literal notranslate"><span class="pre">number2</span></code>.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == (10 ^ 15)'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 1
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 1,
# "The first post!",
# "Welcome! This is my first post!",
# 5
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value is equal
to <code class="docutils literal notranslate"><span class="pre">5</span></code> (= <code class="docutils literal notranslate"><span class="pre">10</span> <span class="pre">^</span> <span class="pre">15</span></code>).</p>
</div>
<div class="section" id="shift-operators">
<span id="script-syntax-shift-operators"></span><h3><span class="section-number">7.13.2.7.6. </span>Shift operators<a class="headerlink" href="#shift-operators" title="Permalink to this headline">¶</a></h3>
<p>Here are shift operators.</p>
<div class="section" id="left-shift-operator">
<span id="script-syntax-shift-left"></span><h4><span class="section-number">7.13.2.7.6.1. </span>Left shift operator<a class="headerlink" href="#left-shift-operator" title="Permalink to this headline">¶</a></h4>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">number1</span> <span class="pre"><<</span> <span class="pre">number2</span></code>.</p>
<p>The operator performs a bitwise left shift operation on <code class="docutils literal notranslate"><span class="pre">number1</span></code> by
<code class="docutils literal notranslate"><span class="pre">number2</span></code>.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == (5 << 1)'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 1
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 2,
# "Groonga",
# "I started to use Groonga. It's very fast!",
# 10
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value is equal
to <code class="docutils literal notranslate"><span class="pre">10</span></code> (= <code class="docutils literal notranslate"><span class="pre">5</span> <span class="pre"><<</span> <span class="pre">1</span></code>).</p>
</div>
<div class="section" id="signed-right-shift-operator">
<span id="script-syntax-shift-signed-right"></span><h4><span class="section-number">7.13.2.7.6.2. </span>Signed right shift operator<a class="headerlink" href="#signed-right-shift-operator" title="Permalink to this headline">¶</a></h4>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">number1</span> <span class="pre">>></span> <span class="pre">number2</span></code>.</p>
<p>The operator shifts bits of <code class="docutils literal notranslate"><span class="pre">number1</span></code> to right by <code class="docutils literal notranslate"><span class="pre">number2</span></code>. The sign
of the result is the same as <code class="docutils literal notranslate"><span class="pre">number1</span></code>.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == -(-10 >> 1)'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 1
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 1,
# "The first post!",
# "Welcome! This is my first post!",
# 5
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value is equal
to <code class="docutils literal notranslate"><span class="pre">5</span></code> (= <code class="docutils literal notranslate"><span class="pre">-(-10</span> <span class="pre">>></span> <span class="pre">1)</span></code> = <code class="docutils literal notranslate"><span class="pre">-(-5)</span></code>).</p>
</div>
<div class="section" id="unsigned-right-shift-operator">
<span id="script-syntax-shift-unsigned-right"></span><h4><span class="section-number">7.13.2.7.6.3. </span>Unsigned right shift operator<a class="headerlink" href="#unsigned-right-shift-operator" title="Permalink to this headline">¶</a></h4>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">number1</span> <span class="pre">>>></span> <span class="pre">number2</span></code>.</p>
<p>The operator shifts bits of <code class="docutils literal notranslate"><span class="pre">number1</span></code> to right by <code class="docutils literal notranslate"><span class="pre">number2</span></code>. The
leftmost <code class="docutils literal notranslate"><span class="pre">number2</span></code> bits are filled by <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == (2147483648 - (-10 >>> 1))'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 1
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 1,
# "The first post!",
# "Welcome! This is my first post!",
# 5
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value is equal
to <code class="docutils literal notranslate"><span class="pre">5</span></code> (= <code class="docutils literal notranslate"><span class="pre">2147483648</span> <span class="pre">-</span> <span class="pre">(-10</span> <span class="pre">>>></span> <span class="pre">1)</span></code> = <code class="docutils literal notranslate"><span class="pre">2147483648</span> <span class="pre">-</span> <span class="pre">2147483643</span></code>).</p>
</div>
</div>
<div class="section" id="comparison-operators">
<h3><span class="section-number">7.13.2.7.7. </span>Comparison operators<a class="headerlink" href="#comparison-operators" title="Permalink to this headline">¶</a></h3>
<p>Here are comparison operators.</p>
<div class="section" id="equal-operator">
<span id="script-syntax-equal-operator"></span><h4><span class="section-number">7.13.2.7.7.1. </span>Equal operator<a class="headerlink" href="#equal-operator" title="Permalink to this headline">¶</a></h4>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">object1</span> <span class="pre">==</span> <span class="pre">object2</span></code>.</p>
<p>The operator returns true if <code class="docutils literal notranslate"><span class="pre">object1</span></code> equals to <code class="docutils literal notranslate"><span class="pre">object2</span></code>, false
otherwise.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes == 5'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 1
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 1,
# "The first post!",
# "Welcome! This is my first post!",
# 5
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value is equal
to <code class="docutils literal notranslate"><span class="pre">5</span></code>.</p>
</div>
<div class="section" id="not-equal-operator">
<h4><span class="section-number">7.13.2.7.7.2. </span>Not equal operator<a class="headerlink" href="#not-equal-operator" title="Permalink to this headline">¶</a></h4>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">object1</span> <span class="pre">!=</span> <span class="pre">object2</span></code>.</p>
<p>The operator returns true if <code class="docutils literal notranslate"><span class="pre">object1</span></code> does not equal to
<code class="docutils literal notranslate"><span class="pre">object2</span></code>, false otherwise.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'n_likes != 5'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 4
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 4,
# "Good-bye Senna",
# "I migrated all Senna system!",
# 3
# ],
# [
# 5,
# "Good-bye Tritonn",
# "I also migrated all Tritonn system!",
# 3
# ],
# [
# 2,
# "Groonga",
# "I started to use Groonga. It's very fast!",
# 10
# ],
# [
# 3,
# "Mroonga",
# "I also started to use Mroonga. It's also very fast! Really fast!",
# 15
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value is not
equal to <code class="docutils literal notranslate"><span class="pre">5</span></code>.</p>
</div>
<div class="section" id="less-than-operator">
<h4><span class="section-number">7.13.2.7.7.3. </span>Less than operator<a class="headerlink" href="#less-than-operator" title="Permalink to this headline">¶</a></h4>
<p>TODO: …</p>
</div>
<div class="section" id="less-than-or-equal-to-operator">
<h4><span class="section-number">7.13.2.7.7.4. </span>Less than or equal to operator<a class="headerlink" href="#less-than-or-equal-to-operator" title="Permalink to this headline">¶</a></h4>
<p>TODO: …</p>
</div>
<div class="section" id="greater-than-operator">
<h4><span class="section-number">7.13.2.7.7.5. </span>Greater than operator<a class="headerlink" href="#greater-than-operator" title="Permalink to this headline">¶</a></h4>
<p>TODO: …</p>
</div>
<div class="section" id="greater-than-or-equal-to-operator">
<h4><span class="section-number">7.13.2.7.7.6. </span>Greater than or equal to operator<a class="headerlink" href="#greater-than-or-equal-to-operator" title="Permalink to this headline">¶</a></h4>
<p>TODO: …</p>
</div>
</div>
</div>
<div class="section" id="assignment-operators">
<h2><span class="section-number">7.13.2.8. </span>Assignment operators<a class="headerlink" href="#assignment-operators" title="Permalink to this headline">¶</a></h2>
<div class="section" id="addition-assignment-operator">
<h3><span class="section-number">7.13.2.8.1. </span>Addition assignment operator<a class="headerlink" href="#addition-assignment-operator" title="Permalink to this headline">¶</a></h3>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">column1</span> <span class="pre">+=</span> <span class="pre">column2</span></code>.</p>
<p>The operator performs addition assignment operation on column1 by column2.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score += n_likes'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 5
# ],
# [
# [
# "_key",
# "ShortText"
# ],
# [
# "n_likes",
# "UInt32"
# ],
# [
# "_score",
# "Int32"
# ]
# ],
# [
# "Good-bye Senna",
# 3,
# 4
# ],
# [
# "Good-bye Tritonn",
# 3,
# 4
# ],
# [
# "Groonga",
# 10,
# 11
# ],
# [
# "Mroonga",
# 15,
# 16
# ],
# [
# "The first post!",
# 5,
# 6
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The value of <code class="docutils literal notranslate"><span class="pre">_score</span></code> by <code class="docutils literal notranslate"><span class="pre">--filter</span></code> is always 1 in this case,
then performs addition assignment operation such as ‘_score = _score + n_likes’ for each records.</p>
<p>For example, the value of <code class="docutils literal notranslate"><span class="pre">_score</span></code> about the record which stores “Good-bye Senna” as the <code class="docutils literal notranslate"><span class="pre">_key</span></code>
is 3.</p>
<p>So the expression <code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre">+</span> <span class="pre">3</span></code> is evaluated and stored to <code class="docutils literal notranslate"><span class="pre">_score</span></code> column as the execution result.</p>
</div>
<div class="section" id="subtraction-assignment-operator">
<h3><span class="section-number">7.13.2.8.2. </span>Subtraction assignment operator<a class="headerlink" href="#subtraction-assignment-operator" title="Permalink to this headline">¶</a></h3>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">column1</span> <span class="pre">-=</span> <span class="pre">column2</span></code>.</p>
<p>The operator performs subtraction assignment operation on column1 by column2.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score -= n_likes'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 5
# ],
# [
# [
# "_key",
# "ShortText"
# ],
# [
# "n_likes",
# "UInt32"
# ],
# [
# "_score",
# "Int32"
# ]
# ],
# [
# "Good-bye Senna",
# 3,
# -2
# ],
# [
# "Good-bye Tritonn",
# 3,
# -2
# ],
# [
# "Groonga",
# 10,
# -9
# ],
# [
# "Mroonga",
# 15,
# -14
# ],
# [
# "The first post!",
# 5,
# -4
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The value of <code class="docutils literal notranslate"><span class="pre">_score</span></code> by <code class="docutils literal notranslate"><span class="pre">--filter</span></code> is always 1 in this case,
then performs subtraction assignment operation such as ‘_score = _score - n_likes’ for each records.</p>
<p>For example, the value of <code class="docutils literal notranslate"><span class="pre">_score</span></code> about the record which stores “Good-bye Senna” as the <code class="docutils literal notranslate"><span class="pre">_key</span></code>
is 3.</p>
<p>So the expression <code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre">-</span> <span class="pre">3</span></code> is evaluated and stored to <code class="docutils literal notranslate"><span class="pre">_score</span></code> column as the execution result.</p>
</div>
<div class="section" id="multiplication-assignment-operator">
<h3><span class="section-number">7.13.2.8.3. </span>Multiplication assignment operator<a class="headerlink" href="#multiplication-assignment-operator" title="Permalink to this headline">¶</a></h3>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">column1</span> <span class="pre">*=</span> <span class="pre">column2</span></code>.</p>
<p>The operator performs multiplication assignment operation on column1 by column2.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score *= n_likes'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 5
# ],
# [
# [
# "_key",
# "ShortText"
# ],
# [
# "n_likes",
# "UInt32"
# ],
# [
# "_score",
# "Int32"
# ]
# ],
# [
# "Good-bye Senna",
# 3,
# 3
# ],
# [
# "Good-bye Tritonn",
# 3,
# 3
# ],
# [
# "Groonga",
# 10,
# 10
# ],
# [
# "Mroonga",
# 15,
# 15
# ],
# [
# "The first post!",
# 5,
# 5
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The value of <code class="docutils literal notranslate"><span class="pre">_score</span></code> by <code class="docutils literal notranslate"><span class="pre">--filter</span></code> is always 1 in this case,
then performs subtraction assignment operation such as ‘_score = _score * n_likes’ for each records.</p>
<p>For example, the value of <code class="docutils literal notranslate"><span class="pre">_score</span></code> about the record which stores “Good-bye Senna” as the <code class="docutils literal notranslate"><span class="pre">_key</span></code>
is 3.</p>
<p>So the expression <code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre">*</span> <span class="pre">3</span></code> is evaluated and stored to <code class="docutils literal notranslate"><span class="pre">_score</span></code> column as the execution result.</p>
</div>
<div class="section" id="division-assignment-operator">
<h3><span class="section-number">7.13.2.8.4. </span>Division assignment operator<a class="headerlink" href="#division-assignment-operator" title="Permalink to this headline">¶</a></h3>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">column1</span> <span class="pre">/=</span> <span class="pre">column2</span></code>.</p>
<p>The operator performs division assignment operation on column1 by column2.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score /= n_likes'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 5
# ],
# [
# [
# "_key",
# "ShortText"
# ],
# [
# "n_likes",
# "UInt32"
# ],
# [
# "_score",
# "Int32"
# ]
# ],
# [
# "Good-bye Senna",
# 3,
# 0
# ],
# [
# "Good-bye Tritonn",
# 3,
# 0
# ],
# [
# "Groonga",
# 10,
# 0
# ],
# [
# "Mroonga",
# 15,
# 0
# ],
# [
# "The first post!",
# 5,
# 0
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The value of <code class="docutils literal notranslate"><span class="pre">_score</span></code> by <code class="docutils literal notranslate"><span class="pre">--filter</span></code> is always 1 in this case,
then performs subtraction assignment operation such as ‘_score = _score / n_likes’ for each records.</p>
<p>For example, the value of <code class="docutils literal notranslate"><span class="pre">_score</span></code> about the record which stores “Good-bye Senna” as the <code class="docutils literal notranslate"><span class="pre">_key</span></code>
is 3.</p>
<p>So the expression <code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre">/</span> <span class="pre">3</span></code> is evaluated and stored to <code class="docutils literal notranslate"><span class="pre">_score</span></code> column as the execution result.</p>
</div>
<div class="section" id="modulo-assignment-operator">
<h3><span class="section-number">7.13.2.8.5. </span>Modulo assignment operator<a class="headerlink" href="#modulo-assignment-operator" title="Permalink to this headline">¶</a></h3>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">column1</span> <span class="pre">%=</span> <span class="pre">column2</span></code>.</p>
<p>The operator performs modulo assignment operation on column1 by column2.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score %= n_likes'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 5
# ],
# [
# [
# "_key",
# "ShortText"
# ],
# [
# "n_likes",
# "UInt32"
# ],
# [
# "_score",
# "Int32"
# ]
# ],
# [
# "Good-bye Senna",
# 3,
# 1
# ],
# [
# "Good-bye Tritonn",
# 3,
# 1
# ],
# [
# "Groonga",
# 10,
# 1
# ],
# [
# "Mroonga",
# 15,
# 1
# ],
# [
# "The first post!",
# 5,
# 1
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The value of <code class="docutils literal notranslate"><span class="pre">_score</span></code> by <code class="docutils literal notranslate"><span class="pre">--filter</span></code> is always 1 in this case,
then performs subtraction assignment operation such as ‘_score = _score % n_likes’ for each records.</p>
<p>For example, the value of <code class="docutils literal notranslate"><span class="pre">_score</span></code> about the record which stores “Good-bye Senna” as the <code class="docutils literal notranslate"><span class="pre">_key</span></code>
is 3.</p>
<p>So the expression <code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre">%</span> <span class="pre">3</span></code> is evaluated and stored to <code class="docutils literal notranslate"><span class="pre">_score</span></code> column as the execution result.</p>
</div>
<div class="section" id="bitwise-left-shift-assignment-operator">
<h3><span class="section-number">7.13.2.8.6. </span>Bitwise left shift assignment operator<a class="headerlink" href="#bitwise-left-shift-assignment-operator" title="Permalink to this headline">¶</a></h3>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">column1</span> <span class="pre"><<=</span> <span class="pre">column2</span></code>.</p>
<p>The operator performs left shift assignment operation on column1 by column2.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score <<= n_likes'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 5
# ],
# [
# [
# "_key",
# "ShortText"
# ],
# [
# "n_likes",
# "UInt32"
# ],
# [
# "_score",
# "Int32"
# ]
# ],
# [
# "Good-bye Senna",
# 3,
# 8
# ],
# [
# "Good-bye Tritonn",
# 3,
# 8
# ],
# [
# "Groonga",
# 10,
# 1024
# ],
# [
# "Mroonga",
# 15,
# 32768
# ],
# [
# "The first post!",
# 5,
# 32
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The value of <code class="docutils literal notranslate"><span class="pre">_score</span></code> by <code class="docutils literal notranslate"><span class="pre">--filter</span></code> is always 1 in this case,
then performs subtraction assignment operation such as ‘_score = _score << n_likes’ for each records.</p>
<p>For example, the value of <code class="docutils literal notranslate"><span class="pre">_score</span></code> about the record which stores “Good-bye Senna” as the <code class="docutils literal notranslate"><span class="pre">_key</span></code>
is 3.</p>
<p>So the expression <code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre"><<</span> <span class="pre">3</span></code> is evaluated and stored to <code class="docutils literal notranslate"><span class="pre">_score</span></code> column as the execution result.</p>
</div>
<div class="section" id="bitwise-signed-right-shift-assignment-operator">
<h3><span class="section-number">7.13.2.8.7. </span>Bitwise signed right shift assignment operator<a class="headerlink" href="#bitwise-signed-right-shift-assignment-operator" title="Permalink to this headline">¶</a></h3>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">column2</span> <span class="pre">>>=</span> <span class="pre">column2</span></code>.</p>
<p>The operator performs signed right shift assignment operation on column1 by column2.</p>
</div>
<div class="section" id="bitwise-unsigned-right-shift-assignment-operator">
<h3><span class="section-number">7.13.2.8.8. </span>Bitwise unsigned right shift assignment operator<a class="headerlink" href="#bitwise-unsigned-right-shift-assignment-operator" title="Permalink to this headline">¶</a></h3>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">column1</span> <span class="pre">>>>=</span> <span class="pre">column2</span></code>.</p>
<p>The operator performs unsigned right shift assignment operation on column1 by column2.</p>
</div>
<div class="section" id="bitwise-and-assignment-operator">
<h3><span class="section-number">7.13.2.8.9. </span>Bitwise AND assignment operator<a class="headerlink" href="#bitwise-and-assignment-operator" title="Permalink to this headline">¶</a></h3>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">column1</span> <span class="pre">&=</span> <span class="pre">column2</span></code>.</p>
<p>The operator performs bitwise AND assignment operation on column1 by column2.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score &= n_likes'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 5
# ],
# [
# [
# "_key",
# "ShortText"
# ],
# [
# "n_likes",
# "UInt32"
# ],
# [
# "_score",
# "Int32"
# ]
# ],
# [
# "Good-bye Senna",
# 3,
# 1
# ],
# [
# "Good-bye Tritonn",
# 3,
# 1
# ],
# [
# "Groonga",
# 10,
# 0
# ],
# [
# "Mroonga",
# 15,
# 1
# ],
# [
# "The first post!",
# 5,
# 1
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The value of <code class="docutils literal notranslate"><span class="pre">_score</span></code> by <code class="docutils literal notranslate"><span class="pre">--filter</span></code> is always 1 in this case,
then performs subtraction assignment operation such as ‘_score = _score & n_likes’ for each records.</p>
<p>For example, the value of <code class="docutils literal notranslate"><span class="pre">_score</span></code> about the record which stores “Groonga” as the <code class="docutils literal notranslate"><span class="pre">_key</span></code>
is 10.</p>
<p>So the expression <code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre">&</span> <span class="pre">10</span></code> is evaluated and stored to <code class="docutils literal notranslate"><span class="pre">_score</span></code> column as the execution result.</p>
</div>
<div class="section" id="bitwise-or-assignment-operator">
<span id="script-syntax-bitwise-or-assign"></span><h3><span class="section-number">7.13.2.8.10. </span>Bitwise OR assignment operator<a class="headerlink" href="#bitwise-or-assignment-operator" title="Permalink to this headline">¶</a></h3>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">column1</span> <span class="pre">|=</span> <span class="pre">column2</span></code>.</p>
<p>The operator performs bitwise OR assignment operation on column1 by column2.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score |= n_likes'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 5
# ],
# [
# [
# "_key",
# "ShortText"
# ],
# [
# "n_likes",
# "UInt32"
# ],
# [
# "_score",
# "Int32"
# ]
# ],
# [
# "Good-bye Senna",
# 3,
# 3
# ],
# [
# "Good-bye Tritonn",
# 3,
# 3
# ],
# [
# "Groonga",
# 10,
# 11
# ],
# [
# "Mroonga",
# 15,
# 15
# ],
# [
# "The first post!",
# 5,
# 5
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The value of <code class="docutils literal notranslate"><span class="pre">_score</span></code> by <code class="docutils literal notranslate"><span class="pre">--filter</span></code> is always 1 in this case,
then performs subtraction assignment operation such as ‘_score = _score | n_likes’ for each records.</p>
<p>For example, the value of <code class="docutils literal notranslate"><span class="pre">_score</span></code> about the record which stores “Groonga” as the <code class="docutils literal notranslate"><span class="pre">_key</span></code>
is 10.</p>
<p>So the expression <code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre">|</span> <span class="pre">10</span></code> is evaluated and stored to <code class="docutils literal notranslate"><span class="pre">_score</span></code> column as the execution result.</p>
</div>
<div class="section" id="bitwise-xor-assignment-operator">
<h3><span class="section-number">7.13.2.8.11. </span>Bitwise XOR assignment operator<a class="headerlink" href="#bitwise-xor-assignment-operator" title="Permalink to this headline">¶</a></h3>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">column1</span> <span class="pre">^=</span> <span class="pre">column2</span></code>.</p>
<p>The operator performs bitwise XOR assignment operation on column1 by column2.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --output_columns _key,n_likes,_score --filter true --scorer '_score ^= n_likes'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 5
# ],
# [
# [
# "_key",
# "ShortText"
# ],
# [
# "n_likes",
# "UInt32"
# ],
# [
# "_score",
# "Int32"
# ]
# ],
# [
# "Good-bye Senna",
# 3,
# 2
# ],
# [
# "Good-bye Tritonn",
# 3,
# 2
# ],
# [
# "Groonga",
# 10,
# 11
# ],
# [
# "Mroonga",
# 15,
# 14
# ],
# [
# "The first post!",
# 5,
# 4
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The value of <code class="docutils literal notranslate"><span class="pre">_score</span></code> by <code class="docutils literal notranslate"><span class="pre">--filter</span></code> is always 1 in this case,
then performs subtraction assignment operation such as ‘_score = _score ^ n_likes’ for each records.</p>
<p>For example, the value of <code class="docutils literal notranslate"><span class="pre">_score</span></code> about the record which stores “Good-bye Senna” as the <code class="docutils literal notranslate"><span class="pre">_key</span></code>
is 3.</p>
<p>So the expression <code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre">^</span> <span class="pre">3</span></code> is evaluated and stored to <code class="docutils literal notranslate"><span class="pre">_score</span></code> column as the execution result.</p>
</div>
</div>
<div class="section" id="original-operators">
<h2><span class="section-number">7.13.2.9. </span>Original operators<a class="headerlink" href="#original-operators" title="Permalink to this headline">¶</a></h2>
<p>Script syntax adds the original binary opearators to ECMAScript
syntax. They operate search specific operations. They are starts with
<code class="docutils literal notranslate"><span class="pre">@</span></code> or <code class="docutils literal notranslate"><span class="pre">*</span></code>.</p>
<div class="section" id="match-operator">
<span id="script-syntax-match-operator"></span><h3><span class="section-number">7.13.2.9.1. </span>Match operator<a class="headerlink" href="#match-operator" title="Permalink to this headline">¶</a></h3>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">column</span> <span class="pre">@</span> <span class="pre">value</span></code>.</p>
<p>The operator searches <code class="docutils literal notranslate"><span class="pre">value</span></code> by inverted index of <code class="docutils literal notranslate"><span class="pre">column</span></code>.
Normally, full text search is operated but tag search can be operated.
Because tag search is also implemented by inverted index.</p>
<p><a class="reference internal" href="query_syntax.html"><span class="doc">Query syntax</span></a> uses this operator by default.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'content @ "fast"' --output_columns content
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 2
# ],
# [
# [
# "content",
# "Text"
# ]
# ],
# [
# "I started to use Groonga. It's very fast!"
# ],
# [
# "I also started to use Mroonga. It's also very fast! Really fast!"
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that contain a word <code class="docutils literal notranslate"><span class="pre">fast</span></code> in
<code class="docutils literal notranslate"><span class="pre">content</span></code> column value.</p>
</div>
<div class="section" id="prefix-search-operator">
<span id="script-syntax-prefix-search-operator"></span><h3><span class="section-number">7.13.2.9.2. </span>Prefix search operator<a class="headerlink" href="#prefix-search-operator" title="Permalink to this headline">¶</a></h3>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">column</span> <span class="pre">@^</span> <span class="pre">value</span></code>.</p>
<p>The operator does prefix search with <code class="docutils literal notranslate"><span class="pre">value</span></code>. Prefix search searches
records that contain a word that starts with <code class="docutils literal notranslate"><span class="pre">value</span></code>.</p>
<p>You can use fast prefix search against a column. The column must be
indexed and index table must be patricia trie table
(<code class="docutils literal notranslate"><span class="pre">TABLE_PAT_KEY</span></code>) or double array trie table
(<code class="docutils literal notranslate"><span class="pre">TABLE_DAT_KEY</span></code>). You can also use fast prefix search against
<code class="docutils literal notranslate"><span class="pre">_key</span></code> pseudo column of patricia trie table or double array trie
table. You don’t need to index <code class="docutils literal notranslate"><span class="pre">_key</span></code>.</p>
<p>Prefix search can be used with other table types but it causes all
records scan. It’s not problem for small records but it spends more
time for large records.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter '_key @^ "Goo"' --output_columns _key
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 2
# ],
# [
# [
# "_key",
# "ShortText"
# ]
# ],
# [
# "Good-bye Senna"
# ],
# [
# "Good-bye Tritonn"
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that contain a word that starts with
<code class="docutils literal notranslate"><span class="pre">Goo</span></code> in <code class="docutils literal notranslate"><span class="pre">_key</span></code> pseudo column value. <code class="docutils literal notranslate"><span class="pre">Good-bye</span> <span class="pre">Senna</span></code> and
<code class="docutils literal notranslate"><span class="pre">Good-bye</span> <span class="pre">Tritonn</span></code> are matched with the expression.</p>
</div>
<div class="section" id="suffix-search-operator">
<span id="script-syntax-suffix-search-operator"></span><h3><span class="section-number">7.13.2.9.3. </span>Suffix search operator<a class="headerlink" href="#suffix-search-operator" title="Permalink to this headline">¶</a></h3>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">column</span> <span class="pre">@$</span> <span class="pre">value</span></code>.</p>
<p>This operator does suffix search with <code class="docutils literal notranslate"><span class="pre">value</span></code>. Suffix search
searches records that contain a word that ends with <code class="docutils literal notranslate"><span class="pre">value</span></code>.</p>
<p>You can use fast suffix search against a column. The column must be
indexed and index table must be patricia trie table
(<code class="docutils literal notranslate"><span class="pre">TABLE_PAT_KEY</span></code>) with <code class="docutils literal notranslate"><span class="pre">KEY_WITH_SIS</span></code> flag. You can also use fast
suffix search against <code class="docutils literal notranslate"><span class="pre">_key</span></code> pseudo column of patricia trie table
(<code class="docutils literal notranslate"><span class="pre">TABLE_PAT_KEY</span></code>) with <code class="docutils literal notranslate"><span class="pre">KEY_WITH_SIS</span></code> flag. You don’t need to
index <code class="docutils literal notranslate"><span class="pre">_key</span></code>. We recommended that you use index column based fast
suffix search instead of <code class="docutils literal notranslate"><span class="pre">_key</span></code> based fast suffix search. <code class="docutils literal notranslate"><span class="pre">_key</span></code>
based fast suffix search returns automatically registered
substrings. (TODO: write document about suffix search and link to it
from here.)</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Fast suffix search can be used only for non-ASCII characters such
as hiragana in Japanese. You cannot use fast suffix search for
ASCII character.</p>
</div>
<p>Suffix search can be used with other table types or patricia trie
table without <code class="docutils literal notranslate"><span class="pre">KEY_WITH_SIS</span></code> flag but it causes all records
scan. It’s not problem for small records but it spends more time for
large records.</p>
<p>Here is a simple example. It uses fast suffix search for hiragana in
Japanese that is one of non-ASCII characters.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create Titles TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Titles content COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create SuffixSearchTerms TABLE_PAT_KEY|KEY_WITH_SIS ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create SuffixSearchTerms index COLUMN_INDEX Titles content
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Titles
[
{"content": "ぐるんが"},
{"content": "むるんが"},
{"content": "せな"},
{"content": "とりとん"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 4]
select Titles --query 'content:$んが'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 2
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "content",
# "ShortText"
# ]
# ],
# [
# 2,
# "むるんが"
# ],
# [
# 1,
# "ぐるんが"
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that have value that ends with <code class="docutils literal notranslate"><span class="pre">んが</span></code>
in <code class="docutils literal notranslate"><span class="pre">content</span></code> column value. <code class="docutils literal notranslate"><span class="pre">ぐるんが</span></code> and <code class="docutils literal notranslate"><span class="pre">むるんが</span></code> are matched
with the expression.</p>
</div>
<div class="section" id="near-search-operator">
<span id="script-syntax-near-search-operator"></span><h3><span class="section-number">7.13.2.9.4. </span>Near search operator<a class="headerlink" href="#near-search-operator" title="Permalink to this headline">¶</a></h3>
<p>Its syntax is one of them:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>column *N "word1 word2 ..."
column *N${MAX_INTERVAL} "word1 word2 ..."
</pre></div>
</div>
<p>Here are the examples of the second form:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>column *N29 "word1 word2 ..."
column *N-1 "word1 word2 ..."
</pre></div>
</div>
<p>The first example means that <code class="docutils literal notranslate"><span class="pre">29</span></code> is used for the max interval.</p>
<p>The second example means that <code class="docutils literal notranslate"><span class="pre">-1</span></code> is used for the max interval.
<code class="docutils literal notranslate"><span class="pre">-1</span></code> max interval means no limit.</p>
<p>The operator does near search with words <code class="docutils literal notranslate"><span class="pre">word1</span> <span class="pre">word2</span> <span class="pre">...</span></code>. Near
search searches records that contain the words and the words are
appeared in the specified order and the max interval.</p>
<p>The max interval is <code class="docutils literal notranslate"><span class="pre">10</span></code> by default. The unit of the max interval is
the number of characters in N-gram family tokenizers and the number of
words in morphological analysis family tokenizers.</p>
<p>However, <code class="docutils literal notranslate"><span class="pre">TokenBigram</span></code> doesn’t split ASCII only word into tokens.
Because <code class="docutils literal notranslate"><span class="pre">TokenBigram</span></code> uses white-space-separate like tokenize method
for ASCII characters in this case.</p>
<p>So the unit for ASCII words with <code class="docutils literal notranslate"><span class="pre">TokenBigram</span></code> is the number of
words even if <code class="docutils literal notranslate"><span class="pre">TokenBigram</span></code> is a N-gram family tokenizer.</p>
<p>Note that an index column for full text search must be defined for
<code class="docutils literal notranslate"><span class="pre">column</span></code>.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'content *N "I fast"' --output_columns content
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 1
# ],
# [
# [
# "content",
# "Text"
# ]
# ],
# [
# "I started to use Groonga. It's very fast!"
# ]
# ]
# ]
# ]
select Entries --filter 'content *N "I Really"' --output_columns content
# [[0, 1337566253.89858, 0.000355720520019531], [[[0], [["content", "Text"]]]]]
select Entries --filter 'content *N "also Really"' --output_columns content
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 1
# ],
# [
# [
# "content",
# "Text"
# ]
# ],
# [
# "I also started to use Mroonga. It's also very fast! Really fast!"
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The first expression matches records that contain <code class="docutils literal notranslate"><span class="pre">I</span></code> and <code class="docutils literal notranslate"><span class="pre">fast</span></code>
and the max interval of those words are in 10 words. So the record
that its content is <code class="docutils literal notranslate"><span class="pre">I</span> <span class="pre">also</span> <span class="pre">started</span> <span class="pre">to</span> <span class="pre">use</span> <span class="pre">mroonga.</span> <span class="pre">It's</span> <span class="pre">also</span> <span class="pre">very</span>
<span class="pre">fast!</span> <span class="pre">...</span></code> is matched. The number of words between <code class="docutils literal notranslate"><span class="pre">I</span></code> and <code class="docutils literal notranslate"><span class="pre">fast</span></code>
is just 10.</p>
<p>The second expression matches records that contain <code class="docutils literal notranslate"><span class="pre">I</span></code> and
<code class="docutils literal notranslate"><span class="pre">Really</span></code> and the max interval of those words are in 10 words. So the
record that its content is <code class="docutils literal notranslate"><span class="pre">I</span> <span class="pre">also</span> <span class="pre">started</span> <span class="pre">to</span> <span class="pre">use</span> <span class="pre">mroonga.</span> <span class="pre">It's</span> <span class="pre">also</span>
<span class="pre">very</span> <span class="pre">fast!</span> <span class="pre">Really</span> <span class="pre">fast!</span></code> is not matched. The number of words between
<code class="docutils literal notranslate"><span class="pre">I</span></code> and <code class="docutils literal notranslate"><span class="pre">Really</span></code> is 11.</p>
<p>The third expression matches records that contain <code class="docutils literal notranslate"><span class="pre">also</span></code> and
<code class="docutils literal notranslate"><span class="pre">Really</span></code> and the max interval of those words are in 10 words. So
the record that its content is <code class="docutils literal notranslate"><span class="pre">I</span> <span class="pre">also</span> <span class="pre">st</span> <span class="pre">arted</span> <span class="pre">to</span> <span class="pre">use</span> <span class="pre">mroonga.</span> <span class="pre">It's</span>
<span class="pre">also</span> <span class="pre">very</span> <span class="pre">fast!</span> <span class="pre">Really</span> <span class="pre">fast!</span></code> is matched. The number of words between
<code class="docutils literal notranslate"><span class="pre">also</span></code> and <code class="docutils literal notranslate"><span class="pre">Really</span></code> is 10.</p>
</div>
<div class="section" id="near-phrase-search-operator">
<span id="script-syntax-near-phrase-search-operator"></span><h3><span class="section-number">7.13.2.9.5. </span>Near phrase search operator<a class="headerlink" href="#near-phrase-search-operator" title="Permalink to this headline">¶</a></h3>
<p>Its syntax is one of them:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>column *NP "phrase1 phrase2 ..."
column *NP${MAX_INTERVAL} "phrase1 phrase2 ..."
</pre></div>
</div>
<p>Here are the examples of the second form:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>column *NP29 "phrase1 phrase2 ..."
column *NP-1 "phrase1 phrase2 ..."
</pre></div>
</div>
<p>The first example means that <code class="docutils literal notranslate"><span class="pre">29</span></code> is used for the max interval.</p>
<p>The second example means that <code class="docutils literal notranslate"><span class="pre">-1</span></code> is used for the max interval.
<code class="docutils literal notranslate"><span class="pre">-1</span></code> max interval means no limit.</p>
<p>The operator does near phrase search with phrases <code class="docutils literal notranslate"><span class="pre">phrase1</span> <span class="pre">phrase2</span>
<span class="pre">...</span></code>. Near phrase search searches records that contain the phrases
and the phrases are appeared in the specified order and the max
interval.</p>
<p>The max interval is <code class="docutils literal notranslate"><span class="pre">10</span></code> by default. The unit of the max interval is
the number of characters in N-gram family tokenizers and the number of
words in morphological analysis family tokenizers.</p>
<p>However, <code class="docutils literal notranslate"><span class="pre">TokenBigram</span></code> doesn’t split ASCII only word into tokens.
Because <code class="docutils literal notranslate"><span class="pre">TokenBigram</span></code> uses white-space-separate like tokenize method
for ASCII characters in this case.</p>
<p>So the unit for ASCII words with <code class="docutils literal notranslate"><span class="pre">TokenBigram</span></code> is the number of
words even if <code class="docutils literal notranslate"><span class="pre">TokenBigram</span></code> is a N-gram family tokenizer.</p>
<p>Note that an index column for full text search must be defined for
<code class="docutils literal notranslate"><span class="pre">column</span></code>.</p>
<p>TODO: Use index that has <code class="docutils literal notranslate"><span class="pre">TokenNgram("unify_alphabet",</span> <span class="pre">false)</span></code>
tokenizer to show difference with near search with English text.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'content *NP "I fast"' --output_columns content
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 1
# ],
# [
# [
# "content",
# "Text"
# ]
# ],
# [
# "I started to use Groonga. It's very fast!"
# ]
# ]
# ]
# ]
select Entries --filter 'content *NP "I Really"' --output_columns content
# [[0, 1337566253.89858, 0.000355720520019531], [[[0], [["content", "Text"]]]]]
select Entries --filter 'content *NP "also Really"' --output_columns content
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 1
# ],
# [
# [
# "content",
# "Text"
# ]
# ],
# [
# "I also started to use Mroonga. It's also very fast! Really fast!"
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The first expression matches records that contain <code class="docutils literal notranslate"><span class="pre">I</span></code> and <code class="docutils literal notranslate"><span class="pre">fast</span></code>
and the max interval of those words are in 10 words. So the record
that its content is <code class="docutils literal notranslate"><span class="pre">I</span> <span class="pre">also</span> <span class="pre">started</span> <span class="pre">to</span> <span class="pre">use</span> <span class="pre">mroonga.</span> <span class="pre">It's</span> <span class="pre">also</span> <span class="pre">very</span>
<span class="pre">fast!</span> <span class="pre">...</span></code> is matched. The number of words between <code class="docutils literal notranslate"><span class="pre">I</span></code> and <code class="docutils literal notranslate"><span class="pre">fast</span></code>
is just 10.</p>
<p>The second expression matches records that contain <code class="docutils literal notranslate"><span class="pre">I</span></code> and
<code class="docutils literal notranslate"><span class="pre">Really</span></code> and the max interval of those words are in 10 words. So the
record that its content is <code class="docutils literal notranslate"><span class="pre">I</span> <span class="pre">also</span> <span class="pre">started</span> <span class="pre">to</span> <span class="pre">use</span> <span class="pre">mroonga.</span> <span class="pre">It's</span> <span class="pre">also</span>
<span class="pre">very</span> <span class="pre">fast!</span> <span class="pre">Really</span> <span class="pre">fast!</span></code> is not matched. The number of words between
<code class="docutils literal notranslate"><span class="pre">I</span></code> and <code class="docutils literal notranslate"><span class="pre">Really</span></code> is 11.</p>
<p>The third expression matches records that contain <code class="docutils literal notranslate"><span class="pre">also</span></code> and
<code class="docutils literal notranslate"><span class="pre">Really</span></code> and the max interval of those words are in 10 words. So
the record that its content is <code class="docutils literal notranslate"><span class="pre">I</span> <span class="pre">also</span> <span class="pre">st</span> <span class="pre">arted</span> <span class="pre">to</span> <span class="pre">use</span> <span class="pre">mroonga.</span> <span class="pre">It's</span>
<span class="pre">also</span> <span class="pre">very</span> <span class="pre">fast!</span> <span class="pre">Really</span> <span class="pre">fast!</span></code> is matched. The number of words between
<code class="docutils literal notranslate"><span class="pre">also</span></code> and <code class="docutils literal notranslate"><span class="pre">Really</span></code> is 10.</p>
</div>
<div class="section" id="similar-search">
<span id="script-syntax-similar-search-operator"></span><h3><span class="section-number">7.13.2.9.6. </span>Similar search<a class="headerlink" href="#similar-search" title="Permalink to this headline">¶</a></h3>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">column</span> <span class="pre">*S</span> <span class="pre">"document"</span></code>.</p>
<p>The operator does similar search with document <code class="docutils literal notranslate"><span class="pre">document</span></code>. Similar
search searches records that have similar content to
<code class="docutils literal notranslate"><span class="pre">document</span></code>.</p>
<p>Note that an index column for full text search must be defined for
<code class="docutils literal notranslate"><span class="pre">column</span></code>.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'content *S "I migrated all Solr system!"' --output_columns content
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 2
# ],
# [
# [
# "content",
# "Text"
# ]
# ],
# [
# "I migrated all Senna system!"
# ],
# [
# "I also migrated all Tritonn system!"
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression matches records that have similar content to <code class="docutils literal notranslate"><span class="pre">I</span>
<span class="pre">migrated</span> <span class="pre">all</span> <span class="pre">Solr</span> <span class="pre">system!</span></code>. In this case, records that have <code class="docutils literal notranslate"><span class="pre">I</span>
<span class="pre">migrated</span> <span class="pre">all</span> <span class="pre">XXX</span> <span class="pre">system!</span></code> content are matched.</p>
<p>You should use <code class="docutils literal notranslate"><span class="pre">TokenMecab</span></code> tokenizer for similar search against Japanese documents.
Because <code class="docutils literal notranslate"><span class="pre">TokenMecab</span></code> will tokenize target documents to almost words, it improves similar search precision.</p>
</div>
<div class="section" id="term-extract-operator">
<span id="script-syntax-term-extract-operator"></span><h3><span class="section-number">7.13.2.9.7. </span>Term extract operator<a class="headerlink" href="#term-extract-operator" title="Permalink to this headline">¶</a></h3>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">_key</span> <span class="pre">*T</span> <span class="pre">"document"</span></code>.</p>
<p>The operator extracts terms from <code class="docutils literal notranslate"><span class="pre">document</span></code>. Terms must be
registered as keys of the table of <code class="docutils literal notranslate"><span class="pre">_key</span></code>.</p>
<p>Note that the table must be patricia trie (<code class="docutils literal notranslate"><span class="pre">TABLE_PAT_KEY</span></code>) or
double array trie (<code class="docutils literal notranslate"><span class="pre">TABLE_DAT_KEY</span></code>). You can’t use hash table
(<code class="docutils literal notranslate"><span class="pre">TABLE_HASH_KEY</span></code>) and array (<code class="docutils literal notranslate"><span class="pre">TABLE_NO_KEY</span></code>) because they don’t
support longest common prefix search. Longest common prefix search is
used to implement the operator.</p>
<p>Here is a simple example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create Words TABLE_PAT_KEY ShortText --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Words
[
{"_key": "groonga"},
{"_key": "mroonga"},
{"_key": "Senna"},
{"_key": "Tritonn"}
]
# [[0, 1337566253.89858, 0.000355720520019531], 4]
select Words --filter '_key *T "Groonga is the successor project to Senna."' --output_columns _key
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 2
# ],
# [
# [
# "_key",
# "ShortText"
# ]
# ],
# [
# "groonga"
# ],
# [
# "senna"
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>The expression extrcts terms that included in document <code class="docutils literal notranslate"><span class="pre">Groonga</span> <span class="pre">is</span>
<span class="pre">the</span> <span class="pre">successor</span> <span class="pre">project</span> <span class="pre">to</span> <span class="pre">Senna.</span></code>. In this case, <code class="docutils literal notranslate"><span class="pre">NormalizerAuto</span></code>
normalizer is specified to <code class="docutils literal notranslate"><span class="pre">Words</span></code>. So <code class="docutils literal notranslate"><span class="pre">Groonga</span></code> can be extracted
even if it is loaded as <code class="docutils literal notranslate"><span class="pre">groonga</span></code> into <code class="docutils literal notranslate"><span class="pre">Words</span></code>. All of extracted
terms are also normalized.</p>
</div>
<div class="section" id="regular-expression-operator">
<span id="script-syntax-regular-expression-operator"></span><h3><span class="section-number">7.13.2.9.8. </span>Regular expression operator<a class="headerlink" href="#regular-expression-operator" title="Permalink to this headline">¶</a></h3>
<div class="versionadded">
<p><span class="versionmodified added">New in version 5.0.1.</span></p>
</div>
<p>Its syntax is <code class="docutils literal notranslate"><span class="pre">column</span> <span class="pre">@~</span> <span class="pre">"pattern"</span></code>.</p>
<p>The operator searches records by the regular expression
<code class="docutils literal notranslate"><span class="pre">pattern</span></code>. If a record’s <code class="docutils literal notranslate"><span class="pre">column</span></code> value is matched to <code class="docutils literal notranslate"><span class="pre">pattern</span></code>,
the record is matched.</p>
<p><code class="docutils literal notranslate"><span class="pre">pattern</span></code> must be valid regular expression syntax. See
<a class="reference internal" href="../regular_expression.html"><span class="doc">Regular expression</span></a> about regular expression syntax
details.</p>
<p>The following example uses <code class="docutils literal notranslate"><span class="pre">.roonga</span></code> as pattern. It matches
<code class="docutils literal notranslate"><span class="pre">Groonga</span></code>, <code class="docutils literal notranslate"><span class="pre">Mroonga</span></code> and so on.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter 'content @~ ".roonga"'
# [
# [
# 0,
# 1337566253.89858,
# 0.000355720520019531
# ],
# [
# [
# [
# 2
# ],
# [
# [
# "_id",
# "UInt32"
# ],
# [
# "_key",
# "ShortText"
# ],
# [
# "content",
# "Text"
# ],
# [
# "n_likes",
# "UInt32"
# ]
# ],
# [
# 2,
# "Groonga",
# "I started to use Groonga. It's very fast!",
# 10
# ],
# [
# 3,
# "Mroonga",
# "I also started to use Mroonga. It's also very fast! Really fast!",
# 15
# ]
# ]
# ]
# ]
</pre></div>
</div>
<p>In most cases, regular expression is evaluated sequentially. So it may
be slow against many records.</p>
<p>In some cases, Groonga evaluates regular expression by index. It’s
very fast. See <a class="reference internal" href="../regular_expression.html"><span class="doc">Regular expression</span></a> for details.</p>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">7.13.2. Script syntax</a><ul>
<li><a class="reference internal" href="#security">7.13.2.1. Security</a></li>
<li><a class="reference internal" href="#sample-data">7.13.2.2. Sample data</a></li>
<li><a class="reference internal" href="#literals">7.13.2.3. Literals</a><ul>
<li><a class="reference internal" href="#integer">7.13.2.3.1. Integer</a></li>
<li><a class="reference internal" href="#float">7.13.2.3.2. Float</a></li>
<li><a class="reference internal" href="#string">7.13.2.3.3. String</a></li>
<li><a class="reference internal" href="#boolean">7.13.2.3.4. Boolean</a></li>
<li><a class="reference internal" href="#null">7.13.2.3.5. Null</a></li>
<li><a class="reference internal" href="#time">7.13.2.3.6. Time</a></li>
<li><a class="reference internal" href="#geo-point">7.13.2.3.7. Geo point</a></li>
<li><a class="reference internal" href="#array">7.13.2.3.8. Array</a></li>
<li><a class="reference internal" href="#object-literal">7.13.2.3.9. Object literal</a></li>
</ul>
</li>
<li><a class="reference internal" href="#control-syntaxes">7.13.2.4. Control syntaxes</a></li>
<li><a class="reference internal" href="#grouping">7.13.2.5. Grouping</a></li>
<li><a class="reference internal" href="#function-call">7.13.2.6. Function call</a></li>
<li><a class="reference internal" href="#basic-operators">7.13.2.7. Basic operators</a><ul>
<li><a class="reference internal" href="#arithmetic-operators">7.13.2.7.1. Arithmetic operators</a><ul>
<li><a class="reference internal" href="#addition-operator">7.13.2.7.1.1. Addition operator</a></li>
<li><a class="reference internal" href="#subtraction-operator">7.13.2.7.1.2. Subtraction operator</a></li>
<li><a class="reference internal" href="#multiplication-operator">7.13.2.7.1.3. Multiplication operator</a></li>
<li><a class="reference internal" href="#division-operator">7.13.2.7.1.4. Division operator</a></li>
</ul>
</li>
<li><a class="reference internal" href="#logical-operators">7.13.2.7.2. Logical operators</a><ul>
<li><a class="reference internal" href="#logical-not-operator">7.13.2.7.2.1. Logical NOT operator</a></li>
<li><a class="reference internal" href="#logical-and-operator">7.13.2.7.2.2. Logical AND operator</a></li>
<li><a class="reference internal" href="#logical-or-operator">7.13.2.7.2.3. Logical OR operator</a></li>
<li><a class="reference internal" href="#logical-and-not-operator">7.13.2.7.2.4. Logical AND NOT operator</a></li>
</ul>
</li>
<li><a class="reference internal" href="#bitwise-operators">7.13.2.7.3. Bitwise operators</a><ul>
<li><a class="reference internal" href="#bitwise-not-operator">7.13.2.7.3.1. Bitwise NOT operator</a></li>
<li><a class="reference internal" href="#bitwise-and-operator">7.13.2.7.3.2. Bitwise AND operator</a></li>
</ul>
</li>
<li><a class="reference internal" href="#bitwise-or-operator">7.13.2.7.4. Bitwise OR operator</a></li>
<li><a class="reference internal" href="#bitwise-xor-operator">7.13.2.7.5. Bitwise XOR operator</a></li>
<li><a class="reference internal" href="#shift-operators">7.13.2.7.6. Shift operators</a><ul>
<li><a class="reference internal" href="#left-shift-operator">7.13.2.7.6.1. Left shift operator</a></li>
<li><a class="reference internal" href="#signed-right-shift-operator">7.13.2.7.6.2. Signed right shift operator</a></li>
<li><a class="reference internal" href="#unsigned-right-shift-operator">7.13.2.7.6.3. Unsigned right shift operator</a></li>
</ul>
</li>
<li><a class="reference internal" href="#comparison-operators">7.13.2.7.7. Comparison operators</a><ul>
<li><a class="reference internal" href="#equal-operator">7.13.2.7.7.1. Equal operator</a></li>
<li><a class="reference internal" href="#not-equal-operator">7.13.2.7.7.2. Not equal operator</a></li>
<li><a class="reference internal" href="#less-than-operator">7.13.2.7.7.3. Less than operator</a></li>
<li><a class="reference internal" href="#less-than-or-equal-to-operator">7.13.2.7.7.4. Less than or equal to operator</a></li>
<li><a class="reference internal" href="#greater-than-operator">7.13.2.7.7.5. Greater than operator</a></li>
<li><a class="reference internal" href="#greater-than-or-equal-to-operator">7.13.2.7.7.6. Greater than or equal to operator</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#assignment-operators">7.13.2.8. Assignment operators</a><ul>
<li><a class="reference internal" href="#addition-assignment-operator">7.13.2.8.1. Addition assignment operator</a></li>
<li><a class="reference internal" href="#subtraction-assignment-operator">7.13.2.8.2. Subtraction assignment operator</a></li>
<li><a class="reference internal" href="#multiplication-assignment-operator">7.13.2.8.3. Multiplication assignment operator</a></li>
<li><a class="reference internal" href="#division-assignment-operator">7.13.2.8.4. Division assignment operator</a></li>
<li><a class="reference internal" href="#modulo-assignment-operator">7.13.2.8.5. Modulo assignment operator</a></li>
<li><a class="reference internal" href="#bitwise-left-shift-assignment-operator">7.13.2.8.6. Bitwise left shift assignment operator</a></li>
<li><a class="reference internal" href="#bitwise-signed-right-shift-assignment-operator">7.13.2.8.7. Bitwise signed right shift assignment operator</a></li>
<li><a class="reference internal" href="#bitwise-unsigned-right-shift-assignment-operator">7.13.2.8.8. Bitwise unsigned right shift assignment operator</a></li>
<li><a class="reference internal" href="#bitwise-and-assignment-operator">7.13.2.8.9. Bitwise AND assignment operator</a></li>
<li><a class="reference internal" href="#bitwise-or-assignment-operator">7.13.2.8.10. Bitwise OR assignment operator</a></li>
<li><a class="reference internal" href="#bitwise-xor-assignment-operator">7.13.2.8.11. Bitwise XOR assignment operator</a></li>
</ul>
</li>
<li><a class="reference internal" href="#original-operators">7.13.2.9. Original operators</a><ul>
<li><a class="reference internal" href="#match-operator">7.13.2.9.1. Match operator</a></li>
<li><a class="reference internal" href="#prefix-search-operator">7.13.2.9.2. Prefix search operator</a></li>
<li><a class="reference internal" href="#suffix-search-operator">7.13.2.9.3. Suffix search operator</a></li>
<li><a class="reference internal" href="#near-search-operator">7.13.2.9.4. Near search operator</a></li>
<li><a class="reference internal" href="#near-phrase-search-operator">7.13.2.9.5. Near phrase search operator</a></li>
<li><a class="reference internal" href="#similar-search">7.13.2.9.6. Similar search</a></li>
<li><a class="reference internal" href="#term-extract-operator">7.13.2.9.7. Term extract operator</a></li>
<li><a class="reference internal" href="#regular-expression-operator">7.13.2.9.8. Regular expression operator</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="query_syntax.html"
title="previous chapter"><span class="section-number">7.13.1. </span>Query syntax</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="../regular_expression.html"
title="next chapter"><span class="section-number">7.14. </span>Regular expression</a></p>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../regular_expression.html" title="7.14. Regular expression"
>next</a> |</li>
<li class="right" >
<a href="query_syntax.html" title="7.13.1. Query syntax"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> »</li>
<li class="nav-item nav-item-2"><a href="../grn_expr.html" ><span class="section-number">7.13. </span>grn_expr</a> »</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">7.13.2. </span>Script syntax</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2009-2021, Brazil, Inc.
</div>
</body>
</html>
|