/usr/share/doc/python-elasticsearch-doc/html/api.html is in python-elasticsearch-doc 1.2.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>API Documentation — Elasticsearch 1.2.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.2.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Elasticsearch 1.2.0 documentation" href="index.html" />
<link rel="next" title="Exceptions" href="exceptions.html" />
<link rel="prev" title="Python Elasticsearch Client" href="index.html" />
</head>
<body>
<div class="related">
<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="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="exceptions.html" title="Exceptions"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Python Elasticsearch Client"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Elasticsearch 1.2.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="api-documentation">
<span id="api"></span><h1>API Documentation<a class="headerlink" href="#api-documentation" title="Permalink to this headline">¶</a></h1>
<p>All the API calls map the raw REST api as closely as possible, including the
distinction between required and optional arguments to the calls. This means
that the code makes distinction between positional and keyword arguments; we,
however, recommend that people <strong>use keyword arguments for all calls for
consistency and safety</strong>.</p>
<p>An API call is considered successful (and will return a response) if
elasticsearch returns a 2XX response. Otherwise an instance of
<a class="reference internal" href="exceptions.html#elasticsearch.TransportError" title="elasticsearch.TransportError"><tt class="xref py py-class docutils literal"><span class="pre">TransportError</span></tt></a> (or a more specific subclass) will be
raised. You can see other exception and error states in <a class="reference internal" href="exceptions.html#exceptions"><em>Exceptions</em></a>. If
you do not wish an exception to be raised you can always pass in an <tt class="docutils literal"><span class="pre">ignore</span></tt>
parameter with either a single status code that should be ignored or a list of
them:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">elasticsearch</span> <span class="kn">import</span> <span class="n">Elasticsearch</span>
<span class="n">es</span> <span class="o">=</span> <span class="n">Elasticsearch</span><span class="p">()</span>
<span class="c"># ignore 400 cause by IndexAlreadyExistsException when creating an index</span>
<span class="n">es</span><span class="o">.</span><span class="n">indices</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">index</span><span class="o">=</span><span class="s">'test-index'</span><span class="p">,</span> <span class="n">ignore</span><span class="o">=</span><span class="mi">400</span><span class="p">)</span>
<span class="c"># ignore 404 and 400</span>
<span class="n">es</span><span class="o">.</span><span class="n">indices</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">index</span><span class="o">=</span><span class="s">'test-index'</span><span class="p">,</span> <span class="n">ignore</span><span class="o">=</span><span class="p">[</span><span class="mi">400</span><span class="p">,</span> <span class="mi">404</span><span class="p">])</span>
</pre></div>
</div>
<p>You can also specify <tt class="docutils literal"><span class="pre">request_timeout</span></tt> (float) as part of any API call, this
value will get passed to the <tt class="docutils literal"><span class="pre">perform_request</span></tt> method of the connection
class:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># only wait for 1 second, regardless of the client's default</span>
<span class="n">es</span><span class="o">.</span><span class="n">cluster</span><span class="o">.</span><span class="n">health</span><span class="p">(</span><span class="n">wait_for_status</span><span class="o">=</span><span class="s">'yellow'</span><span class="p">,</span> <span class="n">request_timeout</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">for compatibility with the Python ecosystem we use <tt class="docutils literal"><span class="pre">from_</span></tt> instead of
<tt class="docutils literal"><span class="pre">from</span></tt> and <tt class="docutils literal"><span class="pre">doc_type</span></tt> instead of <tt class="docutils literal"><span class="pre">type</span></tt> as parameter names.</p>
</div>
<span class="target" id="module-elasticsearch"></span><div class="section" id="elasticsearch">
<h2>Elasticsearch<a class="headerlink" href="#elasticsearch" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="elasticsearch.Elasticsearch">
<em class="property">class </em><tt class="descclassname">elasticsearch.</tt><tt class="descname">Elasticsearch</tt><big>(</big><em>hosts=None</em>, <em>transport_class=<class 'elasticsearch.transport.Transport'></em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch" title="Permalink to this definition">¶</a></dt>
<dd><p>Elasticsearch low-level client. Provides a straightforward mapping from
Python to ES REST endpoints.</p>
<p>The instance has attributes <cite>cat</cite>, <cite>cluster</cite>, <cite>indices</cite>, <cite>nodes</cite> and
<cite>snapshot</cite> that provide access to instances of
<a class="reference internal" href="#elasticsearch.client.CatClient" title="elasticsearch.client.CatClient"><tt class="xref py py-class docutils literal"><span class="pre">CatClient</span></tt></a>,
<a class="reference internal" href="#elasticsearch.client.ClusterClient" title="elasticsearch.client.ClusterClient"><tt class="xref py py-class docutils literal"><span class="pre">ClusterClient</span></tt></a>,
<a class="reference internal" href="#elasticsearch.client.IndicesClient" title="elasticsearch.client.IndicesClient"><tt class="xref py py-class docutils literal"><span class="pre">IndicesClient</span></tt></a>,
<a class="reference internal" href="#elasticsearch.client.NodesClient" title="elasticsearch.client.NodesClient"><tt class="xref py py-class docutils literal"><span class="pre">NodesClient</span></tt></a> and
<a class="reference internal" href="#elasticsearch.client.SnapshotClient" title="elasticsearch.client.SnapshotClient"><tt class="xref py py-class docutils literal"><span class="pre">SnapshotClient</span></tt></a> respectively. This is the
preferred (and only supported) way to get access to those classes and their
methods.</p>
<p>Some examples:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># create connection to localhost using the ThriftConnection and it's</span>
<span class="c"># default port (9500)</span>
<span class="n">es</span> <span class="o">=</span> <span class="n">Elasticsearch</span><span class="p">(</span><span class="n">connection_class</span><span class="o">=</span><span class="n">ThriftConnection</span><span class="p">)</span>
<span class="c"># create connection that will automatically inspect the cluster to get</span>
<span class="c"># the list of active nodes. Start with nodes 'esnode1' and 'esnode2'</span>
<span class="n">es</span> <span class="o">=</span> <span class="n">Elasticsearch</span><span class="p">(</span>
<span class="p">[</span><span class="s">'esnode1'</span><span class="p">,</span> <span class="s">'esnode2'</span><span class="p">],</span>
<span class="c"># sniff before doing anything</span>
<span class="n">sniff_on_start</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
<span class="c"># refresh nodes after a node fails to respond</span>
<span class="n">sniff_on_connection_fail</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
<span class="c"># and also every 60 seconds</span>
<span class="n">sniffer_timeout</span><span class="o">=</span><span class="mi">60</span>
<span class="p">)</span>
<span class="c"># connect to localhost directly and another node using SSL on port 443</span>
<span class="c"># and an url_prefix</span>
<span class="n">es</span> <span class="o">=</span> <span class="n">Elasticsearch</span><span class="p">([</span>
<span class="p">{</span><span class="s">'host'</span><span class="p">:</span> <span class="s">'localhost'</span><span class="p">},</span>
<span class="p">{</span><span class="s">'host'</span><span class="p">:</span> <span class="s">'othernode'</span><span class="p">,</span> <span class="s">'port'</span><span class="p">:</span> <span class="mi">443</span><span class="p">,</span> <span class="s">'url_prefix'</span><span class="p">:</span> <span class="s">'es'</span><span class="p">,</span> <span class="s">'use_ssl'</span><span class="p">:</span> <span class="bp">True</span><span class="p">},</span>
<span class="p">])</span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>hosts</strong> – list of nodes we should connect to. Node should be a
dictionary ({“host”: “localhost”, “port”: 9200}), the entire dictionary
will be passed to the <a class="reference internal" href="connection.html#elasticsearch.Connection" title="elasticsearch.Connection"><tt class="xref py py-class docutils literal"><span class="pre">Connection</span></tt></a> class as
kwargs, or a string in the format of <tt class="docutils literal"><span class="pre">host[:port]</span></tt> which will be
translated to a dictionary automatically. If no value is given the
<a class="reference internal" href="connection.html#elasticsearch.Connection" title="elasticsearch.Connection"><tt class="xref py py-class docutils literal"><span class="pre">Connection</span></tt></a> class defaults will be used.</li>
<li><strong>transport_class</strong> – <a class="reference internal" href="connection.html#elasticsearch.Transport" title="elasticsearch.Transport"><tt class="xref py py-class docutils literal"><span class="pre">Transport</span></tt></a> subclass to use.</li>
<li><strong>kwargs</strong> – any additional arguments will be passed on to the
<a class="reference internal" href="connection.html#elasticsearch.Transport" title="elasticsearch.Transport"><tt class="xref py py-class docutils literal"><span class="pre">Transport</span></tt></a> class and, subsequently, to the
<a class="reference internal" href="connection.html#elasticsearch.Connection" title="elasticsearch.Connection"><tt class="xref py py-class docutils literal"><span class="pre">Connection</span></tt></a> instances.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.abort_benchmark">
<tt class="descname">abort_benchmark</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.abort_benchmark" title="Permalink to this definition">¶</a></dt>
<dd><p>Aborts a running benchmark.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – A benchmark name</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.benchmark">
<tt class="descname">benchmark</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.benchmark" title="Permalink to this definition">¶</a></dt>
<dd><p>The benchmark API provides a standard mechanism for submitting queries
and measuring their performance relative to one another.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names; use <cite>_all</cite> or empty
string to perform the operation on all indices</li>
<li><strong>doc_type</strong> – The name of the document type</li>
<li><strong>body</strong> – The search definition using the Query DSL</li>
<li><strong>verbose</strong> – Specify whether to return verbose statistics about each
iteration (default: false)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.bulk">
<tt class="descname">bulk</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.bulk" title="Permalink to this definition">¶</a></dt>
<dd><p>Perform many index/delete operations in a single API call.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-bulk.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-bulk.html</a></p>
<p>See the <a class="reference internal" href="helpers.html#elasticsearch.helpers.bulk" title="elasticsearch.helpers.bulk"><tt class="xref py py-func docutils literal"><span class="pre">bulk()</span></tt></a> helper function for a more
friendly API.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>body</strong> – The operation definition and data (action-data pairs), as
either a newline separated string, or a sequence of dicts to
serialize (one per row).</li>
<li><strong>index</strong> – Default index for items which don’t provide one</li>
<li><strong>doc_type</strong> – Default document type for items which don’t provide one</li>
<li><strong>consistency</strong> – Explicit write consistency setting for the operation</li>
<li><strong>refresh</strong> – Refresh the index after performing the operation</li>
<li><strong>routing</strong> – Specific routing value</li>
<li><strong>replication</strong> – Explicitly set the replication type (default: sync)</li>
<li><strong>timeout</strong> – Explicit operation timeout</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.clear_scroll">
<tt class="descname">clear_scroll</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.clear_scroll" title="Permalink to this definition">¶</a></dt>
<dd><p>Clear the scroll request created by specifying the scroll parameter to
search.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-scroll.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-scroll.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>scroll_id</strong> – The scroll ID or a list of scroll IDs</li>
<li><strong>body</strong> – A comma-separated list of scroll IDs to clear if none was
specified via the scroll_id parameter</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.count">
<tt class="descname">count</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.count" title="Permalink to this definition">¶</a></dt>
<dd><p>Execute a query and get the number of matches for that query.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-count.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-count.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of indices to restrict the results</li>
<li><strong>doc_type</strong> – A comma-separated list of types to restrict the results</li>
<li><strong>body</strong> – A query to restrict the results (optional)</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite>
string or when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete
indices that are open, closed or both., default ‘open’</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be
ignored when unavailable (missing or closed)</li>
<li><strong>min_score</strong> – Include only documents with a specific <cite>_score</cite> value in the result</li>
<li><strong>preference</strong> – Specify the node or shard the operation should be
performed on (default: random)</li>
<li><strong>q</strong> – Query in the Lucene query string syntax</li>
<li><strong>routing</strong> – Specific routing value</li>
<li><strong>source</strong> – The URL-encoded query definition (instead of using the request body)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.count_percolate">
<tt class="descname">count_percolate</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.count_percolate" title="Permalink to this definition">¶</a></dt>
<dd><p>The percolator allows to register queries against an index, and then
send percolate requests which include a doc, and getting back the
queries that match on that doc out of the set of registered queries.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – The index of the document being count percolated.</li>
<li><strong>doc_type</strong> – The type of the document being count percolated.</li>
<li><strong>id</strong> – Substitute the document in the request body with a document
that is known by the specified id. On top of the id, the index and
type parameter will be used to retrieve the document from within the
cluster.</li>
<li><strong>body</strong> – The count percolator request definition using the percolate
DSL</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite>
string or when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete
indices that are open, closed or both., default ‘open’</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be
ignored when unavailable (missing or closed)</li>
<li><strong>percolate_index</strong> – The index to count percolate the document into.
Defaults to index.</li>
<li><strong>percolate_type</strong> – The type to count percolate document into. Defaults
to type.</li>
<li><strong>preference</strong> – Specify the node or shard the operation should be
performed on (default: random)</li>
<li><strong>routing</strong> – A comma-separated list of specific routing values</li>
<li><strong>version</strong> – Explicit version number for concurrency control</li>
<li><strong>version_type</strong> – Specific version type</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.create">
<tt class="descname">create</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.create" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a typed JSON document in a specific index, making it searchable.
Behind the scenes this method calls index(..., op_type=’create’)
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-index_.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-index_.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – The name of the index</li>
<li><strong>doc_type</strong> – The type of the document</li>
<li><strong>id</strong> – Document ID</li>
<li><strong>body</strong> – The document</li>
<li><strong>consistency</strong> – Explicit write consistency setting for the operation</li>
<li><strong>id</strong> – Specific document ID (when the POST method is used)</li>
<li><strong>parent</strong> – ID of the parent document</li>
<li><strong>percolate</strong> – Percolator queries to execute while indexing the document</li>
<li><strong>refresh</strong> – Refresh the index after performing the operation</li>
<li><strong>replication</strong> – Specific replication type (default: sync)</li>
<li><strong>routing</strong> – Specific routing value</li>
<li><strong>timeout</strong> – Explicit operation timeout</li>
<li><strong>timestamp</strong> – Explicit timestamp for the document</li>
<li><strong>ttl</strong> – Expiration time for the document</li>
<li><strong>version</strong> – Explicit version number for concurrency control</li>
<li><strong>version_type</strong> – Specific version type</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.delete">
<tt class="descname">delete</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.delete" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete a typed JSON document from a specific index based on its id.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – The name of the index</li>
<li><strong>doc_type</strong> – The type of the document</li>
<li><strong>id</strong> – The document ID</li>
<li><strong>consistency</strong> – Specific write consistency setting for the operation</li>
<li><strong>parent</strong> – ID of parent document</li>
<li><strong>refresh</strong> – Refresh the index after performing the operation</li>
<li><strong>replication</strong> – Specific replication type (default: sync)</li>
<li><strong>routing</strong> – Specific routing value</li>
<li><strong>timeout</strong> – Explicit operation timeout</li>
<li><strong>version</strong> – Explicit version number for concurrency control</li>
<li><strong>version_type</strong> – Specific version type</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.delete_by_query">
<tt class="descname">delete_by_query</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.delete_by_query" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete documents from one or more indices and one or more types based on a query.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete-by-query.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-delete-by-query.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of indices to restrict the operation;
use <cite>_all</cite> to perform the operation on all indices</li>
<li><strong>doc_type</strong> – A comma-separated list of types to restrict the operation</li>
<li><strong>body</strong> – A query to restrict the operation specified with the Query
DSL</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite>
string or when no indices have been specified)</li>
<li><strong>analyzer</strong> – The analyzer to use for the query string</li>
<li><strong>consistency</strong> – Specific write consistency setting for the operation</li>
<li><strong>default_operator</strong> – The default operator for query string query (AND
or OR), default u’OR’</li>
<li><strong>df</strong> – The field to use as default where no field prefix is given in
the query string</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete
indices that are open, closed or both., default u’open’</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be
ignored when unavailable (missing or closed)</li>
<li><strong>q</strong> – Query in the Lucene query string syntax</li>
<li><strong>replication</strong> – Specific replication type, default u’sync’</li>
<li><strong>routing</strong> – Specific routing value</li>
<li><strong>source</strong> – The URL-encoded query definition (instead of using the
request body)</li>
<li><strong>timeout</strong> – Explicit operation timeout</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.delete_script">
<tt class="descname">delete_script</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.delete_script" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove a stored script from elasticsearch.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-scripting.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-scripting.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>lang</strong> – Script language</li>
<li><strong>id</strong> – Script ID</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.delete_template">
<tt class="descname">delete_template</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.delete_template" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete a search template.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – Template ID</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.exists">
<tt class="descname">exists</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.exists" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a boolean indicating whether or not given document exists in Elasticsearch.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – The name of the index</li>
<li><strong>id</strong> – The document ID</li>
<li><strong>doc_type</strong> – The type of the document (uses <cite>_all</cite> by default to
fetch the first document matching the ID across all types)</li>
<li><strong>parent</strong> – The ID of the parent document</li>
<li><strong>preference</strong> – Specify the node or shard the operation should be
performed on (default: random)</li>
<li><strong>realtime</strong> – Specify whether to perform the operation in realtime or
search mode</li>
<li><strong>refresh</strong> – Refresh the shard containing the document before
performing the operation</li>
<li><strong>routing</strong> – Specific routing value</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.explain">
<tt class="descname">explain</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.explain" title="Permalink to this definition">¶</a></dt>
<dd><p>The explain api computes a score explanation for a query and a specific
document. This can give useful feedback whether a document matches or
didn’t match a specific query.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-explain.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-explain.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – The name of the index</li>
<li><strong>doc_type</strong> – The type of the document</li>
<li><strong>id</strong> – The document ID</li>
<li><strong>body</strong> – The query definition using the Query DSL</li>
<li><strong>_source</strong> – True or false to return the _source field or not, or a
list of fields to return</li>
<li><strong>_source_exclude</strong> – A list of fields to exclude from the returned
_source field</li>
<li><strong>_source_include</strong> – A list of fields to extract and return from the
_source field</li>
<li><strong>analyze_wildcard</strong> – Specify whether wildcards and prefix queries in
the query string query should be analyzed (default: false)</li>
<li><strong>analyzer</strong> – The analyzer for the query string query</li>
<li><strong>default_operator</strong> – The default operator for query string query (AND
or OR), (default: OR)</li>
<li><strong>df</strong> – The default field for query string query (default: _all)</li>
<li><strong>fields</strong> – A comma-separated list of fields to return in the response</li>
<li><strong>lenient</strong> – Specify whether format-based query failures (such as
providing text to a numeric field) should be ignored</li>
<li><strong>lowercase_expanded_terms</strong> – Specify whether query terms should be lowercased</li>
<li><strong>parent</strong> – The ID of the parent document</li>
<li><strong>preference</strong> – Specify the node or shard the operation should be
performed on (default: random)</li>
<li><strong>q</strong> – Query in the Lucene query string syntax</li>
<li><strong>routing</strong> – Specific routing value</li>
<li><strong>source</strong> – The URL-encoded query definition (instead of using the
request body)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.get">
<tt class="descname">get</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a typed JSON document from the index based on its id.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – The name of the index</li>
<li><strong>id</strong> – The document ID</li>
<li><strong>doc_type</strong> – The type of the document (uses <cite>_all</cite> by default to
fetch the first document matching the ID across all types)</li>
<li><strong>_source</strong> – True or false to return the _source field or not, or a
list of fields to return</li>
<li><strong>_source_exclude</strong> – A list of fields to exclude from the returned
_source field</li>
<li><strong>_source_include</strong> – A list of fields to extract and return from the
_source field</li>
<li><strong>fields</strong> – A comma-separated list of fields to return in the response</li>
<li><strong>parent</strong> – The ID of the parent document</li>
<li><strong>preference</strong> – Specify the node or shard the operation should be
performed on (default: random)</li>
<li><strong>realtime</strong> – Specify whether to perform the operation in realtime or
search mode</li>
<li><strong>refresh</strong> – Refresh the shard containing the document before
performing the operation</li>
<li><strong>routing</strong> – Specific routing value</li>
<li><strong>version</strong> – Explicit version number for concurrency control</li>
<li><strong>version_type</strong> – Explicit version number for concurrency control</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.get_script">
<tt class="descname">get_script</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.get_script" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve a script from the API.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-scripting.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-scripting.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>lang</strong> – Script language</li>
<li><strong>id</strong> – Script ID</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.get_source">
<tt class="descname">get_source</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.get_source" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the source of a document by it’s index, type and id.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-get.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – The name of the index</li>
<li><strong>doc_type</strong> – The type of the document (uses <cite>_all</cite> by default to
fetch the first document matching the ID across all types)</li>
<li><strong>id</strong> – The document ID</li>
<li><strong>_source</strong> – True or false to return the _source field or not, or a
list of fields to return</li>
<li><strong>_source_exclude</strong> – A list of fields to exclude from the returned
_source field</li>
<li><strong>_source_include</strong> – A list of fields to extract and return from the
_source field</li>
<li><strong>parent</strong> – The ID of the parent document</li>
<li><strong>preference</strong> – Specify the node or shard the operation should be
performed on (default: random)</li>
<li><strong>realtime</strong> – Specify whether to perform the operation in realtime or search mode</li>
<li><strong>refresh</strong> – Refresh the shard containing the document before
performing the operation</li>
<li><strong>routing</strong> – Specific routing value</li>
<li><strong>version</strong> – Explicit version number for concurrency control</li>
<li><strong>version_type</strong> – Explicit version number for concurrency control</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.get_template">
<tt class="descname">get_template</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.get_template" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve a search template.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>id</strong> – Template ID</li>
<li><strong>body</strong> – The document</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.index">
<tt class="descname">index</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.index" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds or updates a typed JSON document in a specific index, making it searchable.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-index_.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-index_.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – The name of the index</li>
<li><strong>doc_type</strong> – The type of the document</li>
<li><strong>body</strong> – The document</li>
<li><strong>id</strong> – Document ID</li>
<li><strong>consistency</strong> – Explicit write consistency setting for the operation</li>
<li><strong>op_type</strong> – Explicit operation type (default: index)</li>
<li><strong>parent</strong> – ID of the parent document</li>
<li><strong>refresh</strong> – Refresh the index after performing the operation</li>
<li><strong>replication</strong> – Specific replication type (default: sync)</li>
<li><strong>routing</strong> – Specific routing value</li>
<li><strong>timeout</strong> – Explicit operation timeout</li>
<li><strong>timestamp</strong> – Explicit timestamp for the document</li>
<li><strong>ttl</strong> – Expiration time for the document</li>
<li><strong>version</strong> – Explicit version number for concurrency control</li>
<li><strong>version_type</strong> – Specific version type</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.info">
<tt class="descname">info</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.info" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the basic info from the current cluster.</p>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.list_benchmarks">
<tt class="descname">list_benchmarks</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.list_benchmarks" title="Permalink to this definition">¶</a></dt>
<dd><p>View the progress of long-running benchmarks.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names; use <cite>_all</cite> or empty
string to perform the operation on all indices</li>
<li><strong>doc_type</strong> – The name of the document type</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.mget">
<tt class="descname">mget</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.mget" title="Permalink to this definition">¶</a></dt>
<dd><p>Get multiple documents based on an index, type (optional) and ids.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-multi-get.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-multi-get.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>body</strong> – Document identifiers; can be either <cite>docs</cite> (containing full
document information) or <cite>ids</cite> (when index and type is provided in the URL.</li>
<li><strong>index</strong> – The name of the index</li>
<li><strong>doc_type</strong> – The type of the document</li>
<li><strong>_source</strong> – True or false to return the _source field or not, or a
list of fields to return</li>
<li><strong>_source_exclude</strong> – A list of fields to exclude from the returned
_source field</li>
<li><strong>_source_include</strong> – A list of fields to extract and return from the
_source field</li>
<li><strong>fields</strong> – A comma-separated list of fields to return in the response</li>
<li><strong>parent</strong> – The ID of the parent document</li>
<li><strong>preference</strong> – Specify the node or shard the operation should be
performed on (default: random)</li>
<li><strong>realtime</strong> – Specify whether to perform the operation in realtime or search mode</li>
<li><strong>refresh</strong> – Refresh the shard containing the document before
performing the operation</li>
<li><strong>routing</strong> – Specific routing value</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.mlt">
<tt class="descname">mlt</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.mlt" title="Permalink to this definition">¶</a></dt>
<dd><p>Get documents that are “like” a specified document.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-more-like-this.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-more-like-this.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – The name of the index</li>
<li><strong>doc_type</strong> – The type of the document (use <cite>_all</cite> to fetch the first
document matching the ID across all types)</li>
<li><strong>id</strong> – The document ID</li>
<li><strong>body</strong> – A specific search request definition</li>
<li><strong>boost_terms</strong> – The boost factor</li>
<li><strong>include</strong> – Whether to include the queried document from the response</li>
<li><strong>max_doc_freq</strong> – The word occurrence frequency as count: words with
higher occurrence in the corpus will be ignored</li>
<li><strong>max_query_terms</strong> – The maximum query terms to be included in the generated query</li>
<li><strong>max_word_length</strong> – The minimum length of the word: longer words will be ignored</li>
<li><strong>min_doc_freq</strong> – The word occurrence frequency as count: words with
lower occurrence in the corpus will be ignored</li>
<li><strong>min_term_freq</strong> – The term frequency as percent: terms with lower
occurence in the source document will be ignored</li>
<li><strong>min_word_length</strong> – The minimum length of the word: shorter words will be ignored</li>
<li><strong>mlt_fields</strong> – Specific fields to perform the query against</li>
<li><strong>percent_terms_to_match</strong> – How many terms have to match in order to
consider the document a match (default: 0.3)</li>
<li><strong>routing</strong> – Specific routing value</li>
<li><strong>search_from</strong> – The offset from which to return results</li>
<li><strong>search_indices</strong> – A comma-separated list of indices to perform the
query against (default: the index containing the document)</li>
<li><strong>search_query_hint</strong> – The search query hint</li>
<li><strong>search_scroll</strong> – A scroll search request definition</li>
<li><strong>search_size</strong> – The number of documents to return (default: 10)</li>
<li><strong>search_source</strong> – A specific search request definition (instead of
using the request body)</li>
<li><strong>search_type</strong> – Specific search type (eg. <cite>dfs_then_fetch</cite>, <cite>count</cite>, etc)</li>
<li><strong>search_types</strong> – A comma-separated list of types to perform the query
against (default: the same type as the document)</li>
<li><strong>stop_words</strong> – A list of stop words to be ignored</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.mpercolate">
<tt class="descname">mpercolate</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.mpercolate" title="Permalink to this definition">¶</a></dt>
<dd><p>The percolator allows to register queries against an index, and then
send percolate requests which include a doc, and getting back the
queries that match on that doc out of the set of registered queries.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – The index of the document being count percolated to use as
default</li>
<li><strong>doc_type</strong> – The type of the document being percolated to use as
default.</li>
<li><strong>body</strong> – The percolate request definitions (header & body pair),
separated by newlines</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite>
string or when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete
indices that are open, closed or both., default ‘open’</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be
ignored when unavailable (missing or closed)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.msearch">
<tt class="descname">msearch</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.msearch" title="Permalink to this definition">¶</a></dt>
<dd><p>Execute several search requests within the same API.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-multi-search.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-multi-search.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>body</strong> – The request definitions (metadata-search request definition
pairs), as either a newline separated string, or a sequence of
dicts to serialize (one per row).</li>
<li><strong>index</strong> – A comma-separated list of index names to use as default</li>
<li><strong>doc_type</strong> – A comma-separated list of document types to use as default</li>
<li><strong>search_type</strong> – Search operation type</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.mtermvectors">
<tt class="descname">mtermvectors</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.mtermvectors" title="Permalink to this definition">¶</a></dt>
<dd><p>Multi termvectors API allows to get multiple termvectors based on an
index, type and id.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – The index in which the document resides.</li>
<li><strong>doc_type</strong> – The type of the document.</li>
<li><strong>body</strong> – Define ids, parameters or a list of parameters per document
here. You must at least provide a list of document ids. See
documentation.</li>
<li><strong>field_statistics</strong> – Specifies if document count, sum of document
frequencies and sum of total term frequencies should be returned.
Applies to all returned documents unless otherwise specified in body
“params” or “docs”., default True</li>
<li><strong>fields</strong> – A comma-separated list of fields to return. Applies to all
returned documents unless otherwise specified in body “params” or
“docs”.</li>
<li><strong>ids</strong> – A comma-separated list of documents ids. You must define ids
as parameter or set “ids” or “docs” in the request body</li>
<li><strong>offsets</strong> – Specifies if term offsets should be returned. Applies to
all returned documents unless otherwise specified in body “params”
or “docs”., default True</li>
<li><strong>parent</strong> – Parent id of documents. Applies to all returned documents
unless otherwise specified in body “params” or “docs”.</li>
<li><strong>payloads</strong> – Specifies if term payloads should be returned. Applies to
all returned documents unless otherwise specified in body “params”
or “docs”., default True</li>
<li><strong>positions</strong> – Specifies if term positions should be returned. Applies
to all returned documents unless otherwise specified in body
“params” or “docs”., default True</li>
<li><strong>preference</strong> – Specify the node or shard the operation should be
performed on (default: random) .Applies to all returned documents
unless otherwise specified in body “params” or “docs”.</li>
<li><strong>routing</strong> – Specific routing value. Applies to all returned documents
unless otherwise specified in body “params” or “docs”.</li>
<li><strong>term_statistics</strong> – Specifies if total term frequency and document
frequency should be returned. Applies to all returned documents
unless otherwise specified in body “params” or “docs”., default
False</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.percolate">
<tt class="descname">percolate</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.percolate" title="Permalink to this definition">¶</a></dt>
<dd><p>The percolator allows to register queries against an index, and then
send percolate requests which include a doc, and getting back the
queries that match on that doc out of the set of registered queries.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – The index of the document being percolated.</li>
<li><strong>doc_type</strong> – The type of the document being percolated.</li>
<li><strong>id</strong> – Substitute the document in the request body with a document
that is known by the specified id. On top of the id, the index and
type parameter will be used to retrieve the document from within the
cluster.</li>
<li><strong>body</strong> – The percolator request definition using the percolate DSL</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite>
string or when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete
indices that are open, closed or both., default ‘open’</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be
ignored when unavailable (missing or closed)</li>
<li><strong>percolate_format</strong> – Return an array of matching query IDs instead of
objects</li>
<li><strong>percolate_index</strong> – The index to percolate the document into. Defaults
to index.</li>
<li><strong>percolate_type</strong> – The type to percolate document into. Defaults to
type.</li>
<li><strong>preference</strong> – Specify the node or shard the operation should be
performed on (default: random)</li>
<li><strong>routing</strong> – A comma-separated list of specific routing values</li>
<li><strong>version</strong> – Explicit version number for concurrency control</li>
<li><strong>version_type</strong> – Specific version type</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.ping">
<tt class="descname">ping</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.ping" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns True if the cluster is up, False otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.put_script">
<tt class="descname">put_script</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.put_script" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a script in given language with specified ID.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-scripting.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-scripting.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>lang</strong> – Script language</li>
<li><strong>id</strong> – Script ID</li>
<li><strong>body</strong> – The document</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.put_template">
<tt class="descname">put_template</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.put_template" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a search template.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>id</strong> – Template ID</li>
<li><strong>body</strong> – The document</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.scroll">
<tt class="descname">scroll</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.scroll" title="Permalink to this definition">¶</a></dt>
<dd><p>Scroll a search request created by specifying the scroll parameter.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-scroll.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-scroll.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>scroll_id</strong> – The scroll ID</li>
<li><strong>scroll</strong> – Specify how long a consistent view of the index should be
maintained for scrolled search</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.search">
<tt class="descname">search</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.search" title="Permalink to this definition">¶</a></dt>
<dd><p>Execute a search query and get back search hits that match the query.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-search.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-search.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names to search; use <cite>_all</cite>
or empty string to perform the operation on all indices</li>
<li><strong>doc_type</strong> – A comma-separated list of document types to search;
leave empty to perform the operation on all types</li>
<li><strong>body</strong> – The search definition using the Query DSL</li>
<li><strong>_source</strong> – True or false to return the _source field or not, or a
list of fields to return</li>
<li><strong>_source_exclude</strong> – A list of fields to exclude from the returned
_source field</li>
<li><strong>_source_include</strong> – A list of fields to extract and return from the
_source field</li>
<li><strong>analyze_wildcard</strong> – Specify whether wildcard and prefix queries
should be analyzed (default: false)</li>
<li><strong>analyzer</strong> – The analyzer to use for the query string</li>
<li><strong>default_operator</strong> – The default operator for query string query (AND
or OR) (default: OR)</li>
<li><strong>df</strong> – The field to use as default where no field prefix is given in
the query string</li>
<li><strong>explain</strong> – Specify whether to return detailed information about
score computation as part of a hit</li>
<li><strong>fields</strong> – A comma-separated list of fields to return as part of a hit</li>
<li><strong>indices_boost</strong> – Comma-separated list of index boosts</li>
<li><strong>lenient</strong> – Specify whether format-based query failures (such as
providing text to a numeric field) should be ignored</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite>
string or when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete
indices that are open, closed or both., default ‘open’</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be
ignored when unavailable (missing or closed)</li>
<li><strong>lowercase_expanded_terms</strong> – Specify whether query terms should be lowercased</li>
<li><strong>from_</strong> – Starting offset (default: 0)</li>
<li><strong>preference</strong> – Specify the node or shard the operation should be
performed on (default: random)</li>
<li><strong>q</strong> – Query in the Lucene query string syntax</li>
<li><strong>routing</strong> – A comma-separated list of specific routing values</li>
<li><strong>scroll</strong> – Specify how long a consistent view of the index should be
maintained for scrolled search</li>
<li><strong>search_type</strong> – Search operation type</li>
<li><strong>size</strong> – Number of hits to return (default: 10)</li>
<li><strong>sort</strong> – A comma-separated list of <field>:<direction> pairs</li>
<li><strong>source</strong> – The URL-encoded request definition using the Query DSL
(instead of using request body)</li>
<li><strong>stats</strong> – Specific ‘tag’ of the request for logging and statistical purposes</li>
<li><strong>suggest_field</strong> – Specify which field to use for suggestions</li>
<li><strong>suggest_mode</strong> – Specify suggest mode (default: missing)</li>
<li><strong>suggest_size</strong> – How many suggestions to return in response</li>
<li><strong>suggest_text</strong> – The source text for which the suggestions should be returned</li>
<li><strong>timeout</strong> – Explicit operation timeout</li>
<li><strong>version</strong> – Specify whether to return document version as part of a hit</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.search_shards">
<tt class="descname">search_shards</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.search_shards" title="Permalink to this definition">¶</a></dt>
<dd><p>The search shards api returns the indices and shards that a search
request would be executed against. This can give useful feedback for working
out issues or planning optimizations with routing and shard preferences.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-shards.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-shards.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – The name of the index</li>
<li><strong>doc_type</strong> – The type of the document</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite>
string or when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete
indices that are open, closed or both. (default: ‘“open”’)</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be
ignored when unavailable (missing or closed)</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
<li><strong>preference</strong> – Specify the node or shard the operation should be
performed on (default: random)</li>
<li><strong>routing</strong> – Specific routing value</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.search_template">
<tt class="descname">search_template</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.search_template" title="Permalink to this definition">¶</a></dt>
<dd><p>A query that accepts a query template and a map of key/value pairs to
fill in template parameters.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/query-dsl-template-query.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/query-dsl-template-query.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names to search; use <cite>_all</cite>
or empty string to perform the operation on all indices</li>
<li><strong>doc_type</strong> – A comma-separated list of document types to search; leave
empty to perform the operation on all types</li>
<li><strong>body</strong> – The search definition template and its params</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite>
string or when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete
indices that are open, closed or both., default ‘open’</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be
ignored when unavailable (missing or closed)</li>
<li><strong>preference</strong> – Specify the node or shard the operation should be
performed on (default: random)</li>
<li><strong>routing</strong> – A comma-separated list of specific routing values</li>
<li><strong>scroll</strong> – Specify how long a consistent view of the index should be
maintained for scrolled search</li>
<li><strong>search_type</strong> – Search operation type</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.suggest">
<tt class="descname">suggest</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.suggest" title="Permalink to this definition">¶</a></dt>
<dd><p>The suggest feature suggests similar looking terms based on a provided
text by using a suggester.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-search.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-search.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names to restrict the operation;
use <cite>_all</cite> or empty string to perform the operation on all indices</li>
<li><strong>body</strong> – The request definition</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite>
string or when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete
indices that are open, closed or both., default ‘open’</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be
ignored when unavailable (missing or closed)</li>
<li><strong>preference</strong> – Specify the node or shard the operation should be
performed on (default: random)</li>
<li><strong>routing</strong> – Specific routing value</li>
<li><strong>source</strong> – The URL-encoded request definition (instead of using request body)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.termvector">
<tt class="descname">termvector</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.termvector" title="Permalink to this definition">¶</a></dt>
<dd><p>Added in 1.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-termvectors.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-termvectors.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – The index in which the document resides.</li>
<li><strong>doc_type</strong> – The type of the document.</li>
<li><strong>id</strong> – The id of the document.</li>
<li><strong>body</strong> – Define parameters. See documentation.</li>
<li><strong>field_statistics</strong> – Specifies if document count, sum of document
frequencies and sum of total term frequencies should be returned.,
default True</li>
<li><strong>fields</strong> – A comma-separated list of fields to return.</li>
<li><strong>offsets</strong> – Specifies if term offsets should be returned., default
True</li>
<li><strong>parent</strong> – Parent id of documents.</li>
<li><strong>payloads</strong> – Specifies if term payloads should be returned., default
True</li>
<li><strong>positions</strong> – Specifies if term positions should be returned., default
True</li>
<li><strong>preference</strong> – Specify the node or shard the operation should be
performed on (default: random).</li>
<li><strong>routing</strong> – Specific routing value.</li>
<li><strong>term_statistics</strong> – Specifies if total term frequency and document
frequency should be returned., default False</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.Elasticsearch.update">
<tt class="descname">update</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.Elasticsearch.update" title="Permalink to this definition">¶</a></dt>
<dd><p>Update a document based on a script or partial data provided.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-update.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs-update.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – The name of the index</li>
<li><strong>doc_type</strong> – The type of the document</li>
<li><strong>id</strong> – Document ID</li>
<li><strong>body</strong> – The request definition using either <cite>script</cite> or partial <cite>doc</cite></li>
<li><strong>consistency</strong> – Explicit write consistency setting for the operation</li>
<li><strong>fields</strong> – A comma-separated list of fields to return in the response</li>
<li><strong>lang</strong> – The script language (default: mvel)</li>
<li><strong>parent</strong> – ID of the parent document</li>
<li><strong>refresh</strong> – Refresh the index after performing the operation</li>
<li><strong>replication</strong> – Specific replication type (default: sync)</li>
<li><strong>retry_on_conflict</strong> – Specify how many times should the operation be
retried when a conflict occurs (default: 0)</li>
<li><strong>routing</strong> – Specific routing value</li>
<li><strong>script</strong> – The URL-encoded script definition (instead of using request body)</li>
<li><strong>timeout</strong> – Explicit operation timeout</li>
<li><strong>timestamp</strong> – Explicit timestamp for the document</li>
<li><strong>ttl</strong> – Expiration time for the document</li>
<li><strong>version</strong> – Explicit version number for concurrency control</li>
<li><strong>version_type</strong> – Explicit version number for concurrency control</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<span class="target" id="module-elasticsearch.client"></span></div>
<div class="section" id="indices">
<h2>Indices<a class="headerlink" href="#indices" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="elasticsearch.client.IndicesClient">
<em class="property">class </em><tt class="descclassname">elasticsearch.client.</tt><tt class="descname">IndicesClient</tt><big>(</big><em>client</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="elasticsearch.client.IndicesClient.analyze">
<tt class="descname">analyze</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.analyze" title="Permalink to this definition">¶</a></dt>
<dd><p>Perform the analysis process on a text and return the tokens breakdown of the text.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-analyze.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-analyze.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – The name of the index to scope the operation</li>
<li><strong>body</strong> – The text on which the analysis should be performed</li>
<li><strong>analyzer</strong> – The name of the analyzer to use</li>
<li><strong>char_filters</strong> – A comma-separated list of character filters to use
for the analysis</li>
<li><strong>field</strong> – Use the analyzer configured for this field (instead of
passing the analyzer name)</li>
<li><strong>filters</strong> – A comma-separated list of filters to use for the analysis</li>
<li><strong>format</strong> – Format of the output, default u’detailed’</li>
<li><strong>index</strong> – The name of the index to scope the operation</li>
<li><strong>prefer_local</strong> – With <cite>true</cite>, specify that a local shard should be
used if available, with <cite>false</cite>, use a random shard (default: true)</li>
<li><strong>text</strong> – The text on which the analysis should be performed (when
request body is not used)</li>
<li><strong>tokenizer</strong> – The name of the tokenizer to use for the analysis</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.clear_cache">
<tt class="descname">clear_cache</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.clear_cache" title="Permalink to this definition">¶</a></dt>
<dd><p>Clear either all caches or specific cached associated with one ore more indices.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-clearcache.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-clearcache.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index name to limit the operation</li>
<li><strong>field_data</strong> – Clear field data</li>
<li><strong>fielddata</strong> – Clear field data</li>
<li><strong>fields</strong> – A comma-separated list of fields to clear when using the
<cite>field_data</cite> parameter (default: all)</li>
<li><strong>filter</strong> – Clear filter caches</li>
<li><strong>filter_cache</strong> – Clear filter caches</li>
<li><strong>filter_keys</strong> – A comma-separated list of keys to clear when using
the <cite>filter_cache</cite> parameter (default: all)</li>
<li><strong>id</strong> – Clear ID caches for parent/child</li>
<li><strong>id_cache</strong> – Clear ID caches for parent/child</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite> string or
when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete indices
that are open, closed or both.</li>
<li><strong>ignore_indices</strong> – When performed on multiple indices, allows to
ignore <cite>missing</cite> ones (default: none)</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be ignored
when unavailable (missing or closed)</li>
<li><strong>index</strong> – A comma-separated list of index name to limit the operation</li>
<li><strong>recycler</strong> – Clear the recycler cache</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.close">
<tt class="descname">close</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.close" title="Permalink to this definition">¶</a></dt>
<dd><p>Close an index to remove it’s overhead from the cluster. Closed index
is blocked for read/write operations.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of indices to close; use <cite>_all</cite> or
‘*’ to close all indices</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite>
string or when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete
indices that are open, closed or both., default u’open’</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be
ignored when unavailable (missing or closed)</li>
<li><strong>master_timeout</strong> – Specify timeout for connection to master</li>
<li><strong>timeout</strong> – Explicit operation timeout</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.create">
<tt class="descname">create</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.create" title="Permalink to this definition">¶</a></dt>
<dd><p>Create an index in Elasticsearch.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-create-index.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-create-index.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – The name of the index</li>
<li><strong>body</strong> – The configuration for the index (<cite>settings</cite> and <cite>mappings</cite>)</li>
<li><strong>master_timeout</strong> – Specify timeout for connection to master</li>
<li><strong>timeout</strong> – Explicit operation timeout</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.delete">
<tt class="descname">delete</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.delete" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete an index in Elasticsearch
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-index.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-index.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of indices to delete; use <cite>_all</cite> or
‘*’ to delete all indices</li>
<li><strong>master_timeout</strong> – Specify timeout for connection to master</li>
<li><strong>timeout</strong> – Explicit operation timeout</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.delete_alias">
<tt class="descname">delete_alias</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.delete_alias" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete specific alias.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names (supports wildcards);
use <cite>_all</cite> for all indices</li>
<li><strong>name</strong> – A comma-separated list of aliases to delete (supports
wildcards); use <cite>_all</cite> to delete all aliases for the specified indices.</li>
<li><strong>master_timeout</strong> – Specify timeout for connection to master</li>
<li><strong>timeout</strong> – Explicit timestamp for the document</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.delete_mapping">
<tt class="descname">delete_mapping</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.delete_mapping" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete a mapping (type) along with its data.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-mapping.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-delete-mapping.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names (supports wildcard);
use <cite>_all</cite> for all indices</li>
<li><strong>doc_type</strong> – A comma-separated list of document types to delete
(supports wildcards); use <cite>_all</cite> to delete all document types in the
specified indices.</li>
<li><strong>master_timeout</strong> – Specify timeout for connection to master</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.delete_template">
<tt class="descname">delete_template</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.delete_template" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete an index template by its name.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – The name of the template</li>
<li><strong>master_timeout</strong> – Specify timeout for connection to master</li>
<li><strong>timeout</strong> – Explicit operation timeout</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.delete_warmer">
<tt class="descname">delete_warmer</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.delete_warmer" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete an index warmer.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names to delete warmers from
(supports wildcards); use <cite>_all</cite> to perform the operation on all indices.</li>
<li><strong>name</strong> – A comma-separated list of warmer names to delete (supports
wildcards); use <cite>_all</cite> to delete all warmers in the specified indices.</li>
<li><strong>master_timeout</strong> – Specify timeout for connection to master</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.exists">
<tt class="descname">exists</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.exists" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a boolean indicating whether given index exists.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-indices-exists.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-indices-exists.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A list of indices to check</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite>
string or when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete
indices that are open, closed or both., default u’open’</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be
ignored when unavailable (missing or closed)</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.exists_alias">
<tt class="descname">exists_alias</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.exists_alias" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a boolean indicating whether given alias exists.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – A comma-separated list of alias names to return</li>
<li><strong>index</strong> – A comma-separated list of index names to filter aliases</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite> string or
when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete indices
that are open, closed or both.</li>
<li><strong>ignore_indices</strong> – When performed on multiple indices, allows to
ignore <cite>missing</cite> ones (default: none)</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be ignored
when unavailable (missing or closed)</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.exists_template">
<tt class="descname">exists_template</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.exists_template" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a boolean indicating whether given template exists.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – The name of the template</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.exists_type">
<tt class="descname">exists_type</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.exists_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Check if a type/types exists in an index/indices.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-types-exists.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-types-exists.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names; use <cite>_all</cite> to check
the types across all indices</li>
<li><strong>doc_type</strong> – A comma-separated list of document types to check</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite> string or
when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete indices
that are open, closed or both.</li>
<li><strong>ignore_indices</strong> – When performed on multiple indices, allows to
ignore <cite>missing</cite> ones (default: none)</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be ignored
when unavailable (missing or closed)</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.flush">
<tt class="descname">flush</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.flush" title="Permalink to this definition">¶</a></dt>
<dd><p>Explicitly flush one or more indices.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-flush.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-flush.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names; use <cite>_all</cite> or empty
string for all indices</li>
<li><strong>force</strong> – Whether a flush should be forced even if it is not
necessarily needed ie. if no changes will be committed to the index.</li>
<li><strong>full</strong> – If set to true a new index writer is created and settings
that have been changed related to the index writer will be refreshed.</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite> string or
when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete indices
that are open, closed or both.</li>
<li><strong>ignore_indices</strong> – When performed on multiple indices, allows to
ignore <cite>missing</cite> ones (default: none)</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be ignored
when unavailable (missing or closed)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.get_alias">
<tt class="descname">get_alias</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.get_alias" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve a specified alias.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – A comma-separated list of alias names to return</li>
<li><strong>index</strong> – A comma-separated list of index names to filter aliases</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite> string or
when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete indices
that are open, closed or both.</li>
<li><strong>ignore_indices</strong> – When performed on multiple indices, allows to
ignore <cite>missing</cite> ones, default u’none’</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be ignored
when unavailable (missing or closed)</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.get_aliases">
<tt class="descname">get_aliases</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.get_aliases" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve specified aliases
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names to filter aliases</li>
<li><strong>name</strong> – A comma-separated list of alias names to filter</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
<li><strong>timeout</strong> – Explicit operation timeout</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.get_field_mapping">
<tt class="descname">get_field_mapping</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.get_field_mapping" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve mapping definition of a specific field.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-field-mapping.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-field-mapping.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names; use <cite>_all</cite> or empty
string for all indices</li>
<li><strong>doc_type</strong> – A comma-separated list of document types</li>
<li><strong>field</strong> – A comma-separated list of fields to retrieve the mapping for</li>
<li><strong>include_defaults</strong> – A boolean indicating whether to return default values</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite> string or
when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete indices
that are open, closed or both.</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be ignored
when unavailable (missing or closed)</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.get_mapping">
<tt class="descname">get_mapping</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.get_mapping" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve mapping definition of index or index/type.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-mapping.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-mapping.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names; use <cite>_all</cite> or empty
string for all indices</li>
<li><strong>doc_type</strong> – A comma-separated list of document types</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite> string or
when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete indices
that are open, closed or both.</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be ignored
when unavailable (missing or closed)</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.get_settings">
<tt class="descname">get_settings</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.get_settings" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve settings for one or more (or all) indices.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-settings.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-settings.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names; use <cite>_all</cite> or empty
string to perform the operation on all indices</li>
<li><strong>name</strong> – The name of the settings that should be included</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete indices
that are open, closed or both.</li>
<li><strong>ignore_indices</strong> – When performed on multiple indices, allows to
ignore <cite>missing</cite> ones, default u’none’</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be ignored
when unavailable (missing or closed)</li>
<li><strong>flat_settings</strong> – Return settings in flat format (default: false)</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.get_template">
<tt class="descname">get_template</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.get_template" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve an index template by its name.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – The name of the template</li>
<li><strong>flat_settings</strong> – Return settings in flat format (default: false)</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.get_warmer">
<tt class="descname">get_warmer</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.get_warmer" title="Permalink to this definition">¶</a></dt>
<dd><p>Retreieve an index warmer.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names to restrict the
operation; use <cite>_all</cite> to perform the operation on all indices</li>
<li><strong>doc_type</strong> – A comma-separated list of document types to restrict the
operation; leave empty to perform the operation on all types</li>
<li><strong>name</strong> – The name of the warmer (supports wildcards); leave empty to
get all warmers</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite>
string or when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete
indices that are open, closed or both., default u’open’</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be
ignored when unavailable (missing or closed)</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.open">
<tt class="descname">open</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.open" title="Permalink to this definition">¶</a></dt>
<dd><p>Open a closed index to make it available for search.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-open-close.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – The name of the index</li>
<li><strong>master_timeout</strong> – Specify timeout for connection to master</li>
<li><strong>timeout</strong> – Explicit operation timeout</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite> string or
when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete indices
that are open, closed or both.</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be ignored
when unavailable (missing or closed)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.optimize">
<tt class="descname">optimize</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.optimize" title="Permalink to this definition">¶</a></dt>
<dd><p>Explicitly optimize one or more indices through an API.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-optimize.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-optimize.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names; use <cite>_all</cite> or empty
string to perform the operation on all indices</li>
<li><strong>flush</strong> – Specify whether the index should be flushed after
performing the operation (default: true)</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite> string or
when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete indices
that are open, closed or both.</li>
<li><strong>ignore_indices</strong> – When performed on multiple indices, allows to
ignore <cite>missing</cite> ones, default u’none’</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be ignored
when unavailable (missing or closed)</li>
<li><strong>max_num_segments</strong> – The number of segments the index should be
merged into (default: dynamic)</li>
<li><strong>only_expunge_deletes</strong> – Specify whether the operation should only
expunge deleted documents</li>
<li><strong>operation_threading</strong> – TODO: ?</li>
<li><strong>wait_for_merge</strong> – Specify whether the request should block until the
merge process is finished (default: true)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.put_alias">
<tt class="descname">put_alias</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.put_alias" title="Permalink to this definition">¶</a></dt>
<dd><p>Create an alias for a specific index/indices.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names the alias should
point to (supports wildcards); use <cite>_all</cite> or omit to perform the
operation on all indices.</li>
<li><strong>name</strong> – The name of the alias to be created or updated</li>
<li><strong>body</strong> – The settings for the alias, such as <cite>routing</cite> or <cite>filter</cite></li>
<li><strong>master_timeout</strong> – Specify timeout for connection to master</li>
<li><strong>timeout</strong> – Explicit timestamp for the document</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.put_mapping">
<tt class="descname">put_mapping</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.put_mapping" title="Permalink to this definition">¶</a></dt>
<dd><p>Register specific mapping definition for a specific type.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-put-mapping.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-put-mapping.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names the alias should
point to (supports wildcards); use <cite>_all</cite> or omit to perform the
operation on all indices.</li>
<li><strong>doc_type</strong> – The name of the document type</li>
<li><strong>body</strong> – The mapping definition</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite>
string or when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete
indices that are open, closed or both., default u’open’</li>
<li><strong>ignore_conflicts</strong> – Specify whether to ignore conflicts while
updating the mapping (default: false)</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be
ignored when unavailable (missing or closed)</li>
<li><strong>master_timeout</strong> – Specify timeout for connection to master</li>
<li><strong>timeout</strong> – Explicit operation timeout</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.put_settings">
<tt class="descname">put_settings</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.put_settings" title="Permalink to this definition">¶</a></dt>
<dd><p>Change specific index level settings in real time.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-update-settings.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-update-settings.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>body</strong> – The index settings to be updated</li>
<li><strong>index</strong> – A comma-separated list of index names; use <cite>_all</cite> or empty
string to perform the operation on all indices</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite>
string or when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete
indices that are open, closed or both., default u’open’</li>
<li><strong>flat_settings</strong> – Return settings in flat format (default: false)</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be
ignored when unavailable (missing or closed)</li>
<li><strong>master_timeout</strong> – Specify timeout for connection to master</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.put_template">
<tt class="descname">put_template</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.put_template" title="Permalink to this definition">¶</a></dt>
<dd><p>Create an index template that will automatically be applied to new
indices created.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – The name of the template</li>
<li><strong>body</strong> – The template definition</li>
<li><strong>create</strong> – Whether the index template should only be added if new or
can also replace an existing one</li>
<li><strong>order</strong> – The order for this template when merging multiple matching
ones (higher numbers are merged later, overriding the lower numbers)</li>
<li><strong>master_timeout</strong> – Specify timeout for connection to master</li>
<li><strong>timeout</strong> – Explicit operation timeout</li>
<li><strong>flat_settings</strong> – Return settings in flat format (default: false)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.put_warmer">
<tt class="descname">put_warmer</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.put_warmer" title="Permalink to this definition">¶</a></dt>
<dd><p>Create an index warmer to run registered search requests to warm up the
index before it is available for search.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – The name of the warmer</li>
<li><strong>body</strong> – The search request definition for the warmer (query, filters,
facets, sorting, etc)</li>
<li><strong>index</strong> – A comma-separated list of index names to register the warmer
for; use <cite>_all</cite> or omit to perform the operation on all indices</li>
<li><strong>doc_type</strong> – A comma-separated list of document types to register the
warmer for; leave empty to perform the operation on all types</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices in the search request
to warm. (This includes <cite>_all</cite> string or when no indices have been
specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete
indices that are open, closed or both, in the search request to
warm., default u’open’</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be
ignored when unavailable (missing or closed) in the search request
to warm</li>
<li><strong>master_timeout</strong> – Specify timeout for connection to master</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.recovery">
<tt class="descname">recovery</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.recovery" title="Permalink to this definition">¶</a></dt>
<dd><p>The indices recovery API provides insight into on-going shard
recoveries. Recovery status may be reported for specific indices, or
cluster-wide.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-recovery.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-recovery.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names; use <cite>_all</cite> or empty
string to perform the operation on all indices</li>
<li><strong>active_only</strong> – Display only those recoveries that are currently on-
going (default: ‘false’)</li>
<li><strong>detailed</strong> – Whether to display detailed information about shard
recovery (default: ‘false’)</li>
<li><strong>human</strong> – Whether to return time and byte values in human-readable
format. (default: ‘false’)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.refresh">
<tt class="descname">refresh</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.refresh" title="Permalink to this definition">¶</a></dt>
<dd><p>Explicitly refresh one or more index, making all operations performed
since the last refresh available for search.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-refresh.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-refresh.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names; use <cite>_all</cite> or empty
string to perform the operation on all indices</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite> string or
when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete indices
that are open, closed or both.</li>
<li><strong>ignore_indices</strong> – When performed on multiple indices, allows to
ignore <cite>missing</cite> ones, default u’none’</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be ignored
when unavailable (missing or closed)</li>
<li><strong>force</strong> – Force a refresh even if not required</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.segments">
<tt class="descname">segments</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.segments" title="Permalink to this definition">¶</a></dt>
<dd><p>Provide low level segments information that a Lucene index (shard level) is built with.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-segments.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-segments.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names; use <cite>_all</cite> or empty
string to perform the operation on all indices</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite> string or
when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete indices
that are open, closed or both.</li>
<li><strong>ignore_indices</strong> – When performed on multiple indices, allows to
ignore <cite>missing</cite> ones, default u’none’</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be ignored
when unavailable (missing or closed)</li>
<li><strong>human</strong> – Whether to return time and byte values in human-readable
format (default: false)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.snapshot_index">
<tt class="descname">snapshot_index</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.snapshot_index" title="Permalink to this definition">¶</a></dt>
<dd><p>Explicitly perform a snapshot through the gateway of one or more indices (backup them).
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-gateway-snapshot.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-gateway-snapshot.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names; use <cite>_all</cite> or empty
string for all indices</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite> string or
when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete indices
that are open, closed or both.</li>
<li><strong>ignore_indices</strong> – When performed on multiple indices, allows to
ignore <cite>missing</cite> ones (default: none)</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be ignored
when unavailable (missing or closed)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.stats">
<tt class="descname">stats</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.stats" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve statistics on different operations happening on an index.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-stats.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-stats.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names; use <cite>_all</cite> or empty
string to perform the operation on all indices</li>
<li><strong>metric</strong> – A comma-separated list of metrics to display. Possible
values: “_all”, “completion”, “docs”, “fielddata”, “filter_cache”,
“flush”, “get”, “id_cache”, “indexing”, “merge”, “percolate”,
“refresh”, “search”, “segments”, “store”, “warmer”</li>
<li><strong>completion_fields</strong> – A comma-separated list of fields for
<cite>completion</cite> metric (supports wildcards)</li>
<li><strong>fielddata_fields</strong> – A comma-separated list of fields for <cite>fielddata</cite>
metric (supports wildcards)</li>
<li><strong>fields</strong> – A comma-separated list of fields for <cite>fielddata</cite> and
<cite>completion</cite> metric (supports wildcards)</li>
<li><strong>groups</strong> – A comma-separated list of search groups for <cite>search</cite> statistics</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite> string or
when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete indices
that are open, closed or both.</li>
<li><strong>ignore_indices</strong> – When performed on multiple indices, allows to
ignore <cite>missing</cite> ones (default: none)</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be ignored
when unavailable (missing or closed)</li>
<li><strong>human</strong> – Whether to return time and byte values in human-readable format.</li>
<li><strong>level</strong> – Return stats aggregated at cluster, index or shard level.
(“cluster”, “indices” or “shards”, default: “indices”)</li>
<li><strong>types</strong> – A comma-separated list of document types for the <cite>indexing</cite>
index metric</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.status">
<tt class="descname">status</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.status" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a comprehensive status information of one or more indices.
<a class="reference external" href="http://elasticsearch.org/guide/reference/api/admin-indices-_/">http://elasticsearch.org/guide/reference/api/admin-indices-_/</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names; use <cite>_all</cite> or empty
string to perform the operation on all indices</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite> string or
when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete indices
that are open, closed or both.</li>
<li><strong>ignore_indices</strong> – When performed on multiple indices, allows to
ignore <cite>missing</cite> ones, default u’none’</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be ignored
when unavailable (missing or closed)</li>
<li><strong>operation_threading</strong> – TODO: ?</li>
<li><strong>recovery</strong> – Return information about shard recovery</li>
<li><strong>snapshot</strong> – TODO: ?</li>
<li><strong>human</strong> – Whether to return time and byte values in human-readable format.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.update_aliases">
<tt class="descname">update_aliases</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.update_aliases" title="Permalink to this definition">¶</a></dt>
<dd><p>Update specified aliases.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>body</strong> – The definition of <cite>actions</cite> to perform</li>
<li><strong>master_timeout</strong> – Specify timeout for connection to master</li>
<li><strong>timeout</strong> – Request timeout</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.IndicesClient.validate_query">
<tt class="descname">validate_query</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.IndicesClient.validate_query" title="Permalink to this definition">¶</a></dt>
<dd><p>Validate a potentially expensive query without executing it.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-validate.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-validate.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names to restrict the operation;
use <cite>_all</cite> or empty string to perform the operation on all indices</li>
<li><strong>doc_type</strong> – A comma-separated list of document types to restrict the
operation; leave empty to perform the operation on all types</li>
<li><strong>body</strong> – The query definition</li>
<li><strong>explain</strong> – Return detailed information about the error</li>
<li><strong>allow_no_indices</strong> – Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes <cite>_all</cite> string or
when no indices have been specified)</li>
<li><strong>expand_wildcards</strong> – Whether to expand wildcard expression to concrete indices
that are open, closed or both.</li>
<li><strong>ignore_indices</strong> – When performed on multiple indices, allows to
ignore <cite>missing</cite> ones (default: none)</li>
<li><strong>ignore_unavailable</strong> – Whether specified concrete indices should be ignored
when unavailable (missing or closed)</li>
<li><strong>operation_threading</strong> – TODO: ?</li>
<li><strong>q</strong> – Query in the Lucene query string syntax</li>
<li><strong>source</strong> – The URL-encoded query definition (instead of using the
request body)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="cluster">
<h2>Cluster<a class="headerlink" href="#cluster" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="elasticsearch.client.ClusterClient">
<em class="property">class </em><tt class="descclassname">elasticsearch.client.</tt><tt class="descname">ClusterClient</tt><big>(</big><em>client</em><big>)</big><a class="headerlink" href="#elasticsearch.client.ClusterClient" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="elasticsearch.client.ClusterClient.get_settings">
<tt class="descname">get_settings</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.ClusterClient.get_settings" title="Permalink to this definition">¶</a></dt>
<dd><p>Get cluster settings.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-update-settings.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-update-settings.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>flat_settings</strong> – Return settings in flat format (default: false)</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master node</li>
<li><strong>timeout</strong> – Explicit operation timeout</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.ClusterClient.health">
<tt class="descname">health</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.ClusterClient.health" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a very simple status on the health of the cluster.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-health.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-health.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – Limit the information returned to a specific index</li>
<li><strong>level</strong> – Specify the level of detail for returned information, default u’cluster’</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from master node (default: false)</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master node</li>
<li><strong>timeout</strong> – Explicit operation timeout</li>
<li><strong>wait_for_active_shards</strong> – Wait until the specified number of shards is active</li>
<li><strong>wait_for_nodes</strong> – Wait until the specified number of nodes is available</li>
<li><strong>wait_for_relocating_shards</strong> – Wait until the specified number of relocating shards is finished</li>
<li><strong>wait_for_status</strong> – Wait until cluster is in a specific state, default None</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.ClusterClient.pending_tasks">
<tt class="descname">pending_tasks</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.ClusterClient.pending_tasks" title="Permalink to this definition">¶</a></dt>
<dd><p>The pending cluster tasks API returns a list of any cluster-level
changes (e.g. create index, update mapping, allocate or fail shard)
which have not yet been executed.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-pending.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-pending.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>local</strong> – Return local information, do not retrieve the state from master node (default: false)</li>
<li><strong>master_timeout</strong> – Specify timeout for connection to master</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.ClusterClient.put_settings">
<tt class="descname">put_settings</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.ClusterClient.put_settings" title="Permalink to this definition">¶</a></dt>
<dd><p>Update cluster wide specific settings.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-update-settings.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-update-settings.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>body</strong> – The settings to be updated. Can be either <cite>transient</cite> or
<cite>persistent</cite> (survives cluster restart).</li>
<li><strong>flat_settings</strong> – Return settings in flat format (default: false)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.ClusterClient.reroute">
<tt class="descname">reroute</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.ClusterClient.reroute" title="Permalink to this definition">¶</a></dt>
<dd><p>Explicitly execute a cluster reroute allocation command including specific commands.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-reroute.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-reroute.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>body</strong> – The definition of <cite>commands</cite> to perform (<cite>move</cite>, <cite>cancel</cite>, <cite>allocate</cite>)</li>
<li><strong>dry_run</strong> – Simulate the operation only and return the resulting state</li>
<li><strong>explain</strong> – Return an explanation of why the commands can or cannot be executed</li>
<li><strong>filter_metadata</strong> – Don’t return cluster state metadata (default: false)</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master node</li>
<li><strong>timeout</strong> – Explicit operation timeout</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.ClusterClient.state">
<tt class="descname">state</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.ClusterClient.state" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a comprehensive state information of the whole cluster.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-state.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-state.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>metric</strong> – Limit the information returned to the specified metrics.
Possible values: “_all”, “blocks”, “index_templates”, “metadata”,
“nodes”, “routing_table”, “master_node”, “version”</li>
<li><strong>index</strong> – A comma-separated list of index names; use <cite>_all</cite> or empty
string to perform the operation on all indices</li>
<li><strong>index_templates</strong> – A comma separated list to return specific index
templates when returning metadata.</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from master node (default: false)</li>
<li><strong>master_timeout</strong> – Specify timeout for connection to master</li>
<li><strong>flat_settings</strong> – Return settings in flat format (default: false)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.ClusterClient.stats">
<tt class="descname">stats</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.ClusterClient.stats" title="Permalink to this definition">¶</a></dt>
<dd><p>The Cluster Stats API allows to retrieve statistics from a cluster wide
perspective. The API returns basic index metrics and information about
the current nodes that form the cluster.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-stats.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-stats.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>node_id</strong> – A comma-separated list of node IDs or names to limit the
returned information; use <cite>_local</cite> to return information from the node
you’re connecting to, leave empty to get information from all nodes</li>
<li><strong>flat_settings</strong> – Return settings in flat format (default: false)</li>
<li><strong>human</strong> – Whether to return time and byte values in human-readable format.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="nodes">
<h2>Nodes<a class="headerlink" href="#nodes" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="elasticsearch.client.NodesClient">
<em class="property">class </em><tt class="descclassname">elasticsearch.client.</tt><tt class="descname">NodesClient</tt><big>(</big><em>client</em><big>)</big><a class="headerlink" href="#elasticsearch.client.NodesClient" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="elasticsearch.client.NodesClient.hot_threads">
<tt class="descname">hot_threads</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.NodesClient.hot_threads" title="Permalink to this definition">¶</a></dt>
<dd><p>An API allowing to get the current hot threads on each node in the cluster.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-hot-threads.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-hot-threads.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>node_id</strong> – A comma-separated list of node IDs or names to limit the
returned information; use <cite>_local</cite> to return information from the
node you’re connecting to, leave empty to get information from all
nodes</li>
<li><strong>type</strong> – The type to sample (default: cpu)</li>
<li><strong>interval</strong> – The interval for the second sampling of threads</li>
<li><strong>snapshots</strong> – Number of samples of thread stacktrace (default: 10)</li>
<li><strong>threads</strong> – Specify the number of threads to provide information for
(default: 3)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.NodesClient.info">
<tt class="descname">info</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.NodesClient.info" title="Permalink to this definition">¶</a></dt>
<dd><p>The cluster nodes info API allows to retrieve one or more (or all) of
the cluster nodes information.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-info.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-info.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>node_id</strong> – A comma-separated list of node IDs or names to limit the
returned information; use <cite>_local</cite> to return information from the
node you’re connecting to, leave empty to get information from all
nodes</li>
<li><strong>metric</strong> – A comma-separated list of metrics you wish returned. Leave
empty to return all. Choices are “settings”, “os”, “process”,
“jvm”, “thread_pool”, “network”, “transport”, “http”, “plugin”</li>
<li><strong>flat_settings</strong> – Return settings in flat format (default: false)</li>
<li><strong>human</strong> – Whether to return time and byte values in human-readable
format., default False</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.NodesClient.shutdown">
<tt class="descname">shutdown</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.NodesClient.shutdown" title="Permalink to this definition">¶</a></dt>
<dd><p>The nodes shutdown API allows to shutdown one or more (or all) nodes in
the cluster.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-shutdown.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-shutdown.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>node_id</strong> – A comma-separated list of node IDs or names to perform the
operation on; use <cite>_local</cite> to perform the operation on the node
you’re connected to, leave empty to perform the operation on all
nodes</li>
<li><strong>delay</strong> – Set the delay for the operation (default: 1s)</li>
<li><strong>exit</strong> – Exit the JVM as well (default: true)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.NodesClient.stats">
<tt class="descname">stats</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.NodesClient.stats" title="Permalink to this definition">¶</a></dt>
<dd><p>The cluster nodes stats API allows to retrieve one or more (or all) of
the cluster nodes statistics.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>node_id</strong> – A comma-separated list of node IDs or names to limit the
returned information; use <cite>_local</cite> to return information from the
node you’re connecting to, leave empty to get information from all
nodes</li>
<li><strong>metric</strong> – Limit the information returned to the specified metrics.
Possible options are: “_all”, “breaker”, “fs”, “http”, “indices”,
“jvm”, “network”, “os”, “process”, “thread_pool”, “transport”</li>
<li><strong>index_metric</strong> – Limit the information returned for <cite>indices</cite> metric
to the specific index metrics. Isn’t used if <cite>indices</cite> (or <cite>all</cite>)
metric isn’t specified. Possible options are: “_all”, “completion”,
“docs”, “fielddata”, “filter_cache”, “flush”, “get”, “id_cache”,
“indexing”, “merge”, “percolate”, “refresh”, “search”, “segments”,
“store”, “warmer”</li>
<li><strong>completion_fields</strong> – A comma-separated list of fields for <cite>fielddata</cite>
and <cite>suggest</cite> index metric (supports wildcards)</li>
<li><strong>fielddata_fields</strong> – A comma-separated list of fields for <cite>fielddata</cite>
index metric (supports wildcards)</li>
<li><strong>fields</strong> – A comma-separated list of fields for <cite>fielddata</cite> and
<cite>completion</cite> index metric (supports wildcards)</li>
<li><strong>groups</strong> – A comma-separated list of search groups for <cite>search</cite> index
metric</li>
<li><strong>human</strong> – Whether to return time and byte values in human-readable
format., default False</li>
<li><strong>level</strong> – Return indices stats aggregated at node, index or shard
level, default ‘node’</li>
<li><strong>types</strong> – A comma-separated list of document types for the <cite>indexing</cite>
index metric</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="cat">
<h2>Cat<a class="headerlink" href="#cat" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="elasticsearch.client.CatClient">
<em class="property">class </em><tt class="descclassname">elasticsearch.client.</tt><tt class="descname">CatClient</tt><big>(</big><em>client</em><big>)</big><a class="headerlink" href="#elasticsearch.client.CatClient" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="elasticsearch.client.CatClient.aliases">
<tt class="descname">aliases</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.CatClient.aliases" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-aliases.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-aliases.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – A comma-separated list of alias names to return</li>
<li><strong>h</strong> – Comma-separated list of column names to display</li>
<li><strong>help</strong> – Return help information, default False</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
<li><strong>v</strong> – Verbose mode. Display column headers, default False</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.CatClient.allocation">
<tt class="descname">allocation</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.CatClient.allocation" title="Permalink to this definition">¶</a></dt>
<dd><p>Allocation provides a snapshot of how shards have located around the
cluster and the state of disk usage.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-allocation.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-allocation.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>node_id</strong> – A comma-separated list of node IDs or names to limit the
returned information</li>
<li><strong>bytes</strong> – The unit in which to display byte values</li>
<li><strong>h</strong> – Comma-separated list of column names to display</li>
<li><strong>help</strong> – Return help information, default False</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
<li><strong>v</strong> – Verbose mode. Display column headers, default False</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.CatClient.count">
<tt class="descname">count</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.CatClient.count" title="Permalink to this definition">¶</a></dt>
<dd><p>Count provides quick access to the document count of the entire cluster,
or individual indices.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-count.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-count.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names to limit the returned
information</li>
<li><strong>h</strong> – Comma-separated list of column names to display</li>
<li><strong>help</strong> – Return help information, default False</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
<li><strong>v</strong> – Verbose mode. Display column headers, default False</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.CatClient.fielddata">
<tt class="descname">fielddata</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.CatClient.fielddata" title="Permalink to this definition">¶</a></dt>
<dd><p>Shows information about currently loaded fielddata on a per-node basis.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-fielddata.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-fielddata.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>fields</strong> – A comma-separated list of fields to return the fielddata
size</li>
<li><strong>bytes</strong> – The unit in which to display byte values</li>
<li><strong>fields</strong> – A comma-separated list of fields to return the fielddata
size</li>
<li><strong>h</strong> – Comma-separated list of column names to display</li>
<li><strong>help</strong> – Return help information (default: ‘false’)</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
<li><strong>v</strong> – Verbose mode. Display column headers (default: ‘false’)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.CatClient.health">
<tt class="descname">health</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.CatClient.health" title="Permalink to this definition">¶</a></dt>
<dd><p>health is a terse, one-line representation of the same information from
<tt class="xref py py-meth docutils literal"><span class="pre">health()</span></tt> API
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-health.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-health.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>h</strong> – Comma-separated list of column names to display</li>
<li><strong>help</strong> – Return help information, default False</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
<li><strong>ts</strong> – Set to false to disable timestamping, default True</li>
<li><strong>v</strong> – Verbose mode. Display column headers, default False</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.CatClient.help">
<tt class="descname">help</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.CatClient.help" title="Permalink to this definition">¶</a></dt>
<dd><p>A simple help for the cat api.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>help</strong> – Return help information, default False</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.CatClient.indices">
<tt class="descname">indices</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.CatClient.indices" title="Permalink to this definition">¶</a></dt>
<dd><p>The indices command provides a cross-section of each index.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-indices.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-indices.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names to limit the returned
information</li>
<li><strong>bytes</strong> – The unit in which to display byte values</li>
<li><strong>h</strong> – Comma-separated list of column names to display</li>
<li><strong>help</strong> – Return help information, default False</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
<li><strong>pri</strong> – Set to true to return stats only for primary shards, default
False</li>
<li><strong>v</strong> – Verbose mode. Display column headers, default False</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.CatClient.master">
<tt class="descname">master</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.CatClient.master" title="Permalink to this definition">¶</a></dt>
<dd><p>Displays the master’s node ID, bound IP address, and node name.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-master.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-master.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>h</strong> – Comma-separated list of column names to display</li>
<li><strong>help</strong> – Return help information, default False</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
<li><strong>v</strong> – Verbose mode. Display column headers, default False</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.CatClient.nodes">
<tt class="descname">nodes</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.CatClient.nodes" title="Permalink to this definition">¶</a></dt>
<dd><p>The nodes command shows the cluster topology.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-nodes.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-nodes.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>h</strong> – Comma-separated list of column names to display</li>
<li><strong>help</strong> – Return help information, default False</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
<li><strong>v</strong> – Verbose mode. Display column headers, default False</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.CatClient.pending_tasks">
<tt class="descname">pending_tasks</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.CatClient.pending_tasks" title="Permalink to this definition">¶</a></dt>
<dd><p>pending_tasks provides the same information as the
<tt class="xref py py-meth docutils literal"><span class="pre">pending_tasks()</span></tt> API
in a convenient tabular format.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-pending-tasks.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-pending-tasks.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>h</strong> – Comma-separated list of column names to display</li>
<li><strong>help</strong> – Return help information, default False</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
<li><strong>v</strong> – Verbose mode. Display column headers, default False</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.CatClient.plugins">
<tt class="descname">plugins</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.CatClient.plugins" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-plugins.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat-plugins.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>h</strong> – Comma-separated list of column names to display</li>
<li><strong>help</strong> – Return help information, default False</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
<li><strong>v</strong> – Verbose mode. Display column headers, default False</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.CatClient.recovery">
<tt class="descname">recovery</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.CatClient.recovery" title="Permalink to this definition">¶</a></dt>
<dd><p>recovery is a view of shard replication.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-recovery.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-recovery.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names to limit the returned
information</li>
<li><strong>bytes</strong> – The unit in which to display byte values</li>
<li><strong>h</strong> – Comma-separated list of column names to display</li>
<li><strong>help</strong> – Return help information, default False</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
<li><strong>v</strong> – Verbose mode. Display column headers, default False</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.CatClient.segments">
<tt class="descname">segments</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.CatClient.segments" title="Permalink to this definition">¶</a></dt>
<dd><p>The segments command is the detailed view of Lucene segments per index.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names to limit the returned
information</li>
<li><strong>h</strong> – Comma-separated list of column names to display</li>
<li><strong>help</strong> – Return help information, default False</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
<li><strong>v</strong> – Verbose mode. Display column headers, default False</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.CatClient.shards">
<tt class="descname">shards</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.CatClient.shards" title="Permalink to this definition">¶</a></dt>
<dd><p>The shards command is the detailed view of what nodes contain which shards.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-shards.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-shards.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>index</strong> – A comma-separated list of index names to limit the returned
information</li>
<li><strong>h</strong> – Comma-separated list of column names to display</li>
<li><strong>help</strong> – Return help information, default False</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
<li><strong>v</strong> – Verbose mode. Display column headers, default False</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.CatClient.thread_pool">
<tt class="descname">thread_pool</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.CatClient.thread_pool" title="Permalink to this definition">¶</a></dt>
<dd><p>Get information about thread pools.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-thread-pool.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-thread-pool.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>full_id</strong> – Enables displaying the complete node ids (default: ‘false’)</li>
<li><strong>h</strong> – Comma-separated list of column names to display</li>
<li><strong>help</strong> – Return help information (default: ‘false’)</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
<li><strong>v</strong> – Verbose mode. Display column headers (default: ‘false’)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<p>Snapshot
—</p>
<dl class="class">
<dt id="elasticsearch.client.SnapshotClient">
<em class="property">class </em><tt class="descclassname">elasticsearch.client.</tt><tt class="descname">SnapshotClient</tt><big>(</big><em>client</em><big>)</big><a class="headerlink" href="#elasticsearch.client.SnapshotClient" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="elasticsearch.client.SnapshotClient.create">
<tt class="descname">create</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.SnapshotClient.create" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a snapshot in repository
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>repository</strong> – A repository name</li>
<li><strong>snapshot</strong> – A snapshot name</li>
<li><strong>body</strong> – The snapshot definition</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
<li><strong>wait_for_completion</strong> – Should this request wait until the operation
has completed before returning, default False</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.SnapshotClient.create_repository">
<tt class="descname">create_repository</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.SnapshotClient.create_repository" title="Permalink to this definition">¶</a></dt>
<dd><p>Registers a shared file system repository.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>repository</strong> – A repository name</li>
<li><strong>body</strong> – The repository definition</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
<li><strong>timeout</strong> – Explicit operation timeout</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.SnapshotClient.delete">
<tt class="descname">delete</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.SnapshotClient.delete" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes a snapshot from a repository.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>repository</strong> – A repository name</li>
<li><strong>snapshot</strong> – A snapshot name</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.SnapshotClient.delete_repository">
<tt class="descname">delete_repository</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.SnapshotClient.delete_repository" title="Permalink to this definition">¶</a></dt>
<dd><p>Removes a shared file system repository.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>repository</strong> – A comma-separated list of repository names</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
<li><strong>timeout</strong> – Explicit operation timeout</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.SnapshotClient.get">
<tt class="descname">get</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.SnapshotClient.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve information about a snapshot.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>repository</strong> – A comma-separated list of repository names</li>
<li><strong>snapshot</strong> – A comma-separated list of snapshot names</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.SnapshotClient.get_repository">
<tt class="descname">get_repository</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.SnapshotClient.get_repository" title="Permalink to this definition">¶</a></dt>
<dd><p>Return information about registered repositories.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>repository</strong> – A comma-separated list of repository names</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
<li><strong>local</strong> – Return local information, do not retrieve the state from
master node (default: false)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.SnapshotClient.restore">
<tt class="descname">restore</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.SnapshotClient.restore" title="Permalink to this definition">¶</a></dt>
<dd><p>Restore a snapshot.
<a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>repository</strong> – A repository name</li>
<li><strong>snapshot</strong> – A snapshot name</li>
<li><strong>body</strong> – Details of what to restore</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
<li><strong>wait_for_completion</strong> – Should this request wait until the operation
has completed before returning, default False</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="elasticsearch.client.SnapshotClient.status">
<tt class="descname">status</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#elasticsearch.client.SnapshotClient.status" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference external" href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html">http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>repository</strong> – A repository name</li>
<li><strong>snapshot</strong> – A comma-separated list of snapshot names</li>
<li><strong>master_timeout</strong> – Explicit operation timeout for connection to master
node</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">API Documentation</a><ul>
<li><a class="reference internal" href="#elasticsearch">Elasticsearch</a></li>
<li><a class="reference internal" href="#indices">Indices</a></li>
<li><a class="reference internal" href="#cluster">Cluster</a></li>
<li><a class="reference internal" href="#nodes">Nodes</a></li>
<li><a class="reference internal" href="#cat">Cat</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Python Elasticsearch Client</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="exceptions.html"
title="next chapter">Exceptions</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/api.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<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="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="exceptions.html" title="Exceptions"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="Python Elasticsearch Client"
>previous</a> |</li>
<li><a href="index.html">Elasticsearch 1.2.0 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2013, Honza Král.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>
|