File size: 277,838 Bytes
979853c | 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 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 | import asyncio
import time
import hashlib
import json
import os
import re
import datetime
from datetime import timezone
from dataclasses import dataclass, field
from typing import Any, Awaitable, Callable, TypeVar, Union, final
import numpy as np
import configparser
import ssl
import itertools
from lightrag.types import KnowledgeGraph, KnowledgeGraphNode, KnowledgeGraphEdge
from tenacity import (
AsyncRetrying,
RetryCallState,
retry,
retry_if_exception,
retry_if_exception_type,
stop_after_attempt,
wait_exponential,
wait_fixed,
)
from ..base import (
BaseGraphStorage,
BaseKVStorage,
BaseVectorStorage,
DocProcessingStatus,
DocStatus,
DocStatusStorage,
)
from ..exceptions import DataMigrationError
from ..namespace import NameSpace, is_namespace
from ..utils import logger, _cooperative_yield, performance_timing_log
from ..kg.shared_storage import get_data_init_lock
import pipmaster as pm
if not pm.is_installed("asyncpg"):
pm.install("asyncpg")
if not pm.is_installed("pgvector"):
pm.install("pgvector")
import asyncpg # type: ignore
from asyncpg import Pool # type: ignore
from pgvector.asyncpg import register_vector # type: ignore
from dotenv import load_dotenv
# use the .env that is inside the current folder
# allows to use different .env file for each lightrag instance
# the OS environment variables take precedence over the .env file
load_dotenv(dotenv_path=".env", override=False)
T = TypeVar("T")
# PostgreSQL identifier length limit (in bytes)
PG_MAX_IDENTIFIER_LENGTH = 63
# All known vector index suffixes, used to drop conflicting indexes when switching types
_VECTOR_INDEX_SUFFIXES = [
"hnsw_cosine",
"hnsw_halfvec_cosine",
"ivfflat_cosine",
"vchordrq_cosine",
]
def _safe_index_name(table_name: str, index_suffix: str) -> str:
"""
Generate a PostgreSQL-safe index name that won't be truncated.
PostgreSQL silently truncates identifiers to 63 bytes. This function
ensures index names stay within that limit by hashing long table names.
Args:
table_name: The table name (may be long with model suffix)
index_suffix: The index type suffix (e.g., 'hnsw_cosine', 'id', 'workspace_id')
Returns:
A deterministic index name that fits within 63 bytes
"""
# Construct the full index name
full_name = f"idx_{table_name.lower()}_{index_suffix}"
# If it fits within the limit, use it as-is
if len(full_name.encode("utf-8")) <= PG_MAX_IDENTIFIER_LENGTH:
return full_name
# Otherwise, hash the table name to create a shorter unique identifier
# Keep 'idx_' prefix and suffix readable, hash the middle
hash_input = table_name.lower().encode("utf-8")
table_hash = hashlib.md5(hash_input).hexdigest()[:12] # 12 hex chars
# Format: idx_{hash}_{suffix} - guaranteed to fit
# Maximum: idx_ (4) + hash (12) + _ (1) + suffix (variable) = 17 + suffix
shortened_name = f"idx_{table_hash}_{index_suffix}"
return shortened_name
def _timing_details_suffix(**details: Any) -> str:
parts = [f"{key}={value}" for key, value in details.items()]
return f" {' '.join(parts)}" if parts else ""
def _dollar_quote(s: str, tag_prefix: str = "AGE") -> str:
"""
Generate a PostgreSQL dollar-quoted string with a unique tag.
PostgreSQL dollar-quoting uses $tag$ as delimiters. If the content contains
the same delimiter (e.g., $$ or $AGE1$), it will break the query.
This function finds a unique tag that doesn't conflict with the content.
Args:
s: The string to quote
tag_prefix: Prefix for generating unique tags (default: "AGE")
Returns:
The dollar-quoted string with a unique tag, e.g., $AGE1$content$AGE1$
Example:
>>> _dollar_quote("hello")
'$AGE1$hello$AGE1$'
>>> _dollar_quote("$AGE1$ test")
'$AGE2$$AGE1$ test$AGE2$'
>>> _dollar_quote("$$$") # Content with dollar signs
'$AGE1$$$$AGE1$'
"""
s = "" if s is None else str(s)
for i in itertools.count(1):
tag = f"{tag_prefix}{i}"
wrapper = f"${tag}$"
if wrapper not in s:
return f"{wrapper}{s}{wrapper}"
class PostgreSQLDB:
def __init__(self, config: dict[str, Any], **kwargs: Any):
self.host = config["host"]
self.port = config["port"]
self.user = config["user"]
self.password = config["password"]
self.database = config["database"]
self.workspace = config["workspace"]
self.max = int(config["max_connections"])
self.increment = 1
self.pool: Pool | None = None
# SSL configuration
self.ssl_mode = config.get("ssl_mode")
self.ssl_cert = config.get("ssl_cert")
self.ssl_key = config.get("ssl_key")
self.ssl_root_cert = config.get("ssl_root_cert")
self.ssl_crl = config.get("ssl_crl")
# Vector configuration
_ev = config.get("enable_vector", True)
self.enable_vector = (
_ev
if isinstance(_ev, bool)
else str(_ev).lower() in ("true", "1", "yes", "on")
) # True for backward compatibility, can be set to False to disable vector features
self.vector_index_type = config.get("vector_index_type")
self.hnsw_m = config.get("hnsw_m")
self.hnsw_ef = config.get("hnsw_ef")
self.ivfflat_lists = config.get("ivfflat_lists")
self.vchordrq_build_options = config.get("vchordrq_build_options")
self.vchordrq_probes = config.get("vchordrq_probes")
self.vchordrq_epsilon = config.get("vchordrq_epsilon")
# Server settings
self.server_settings = config.get("server_settings")
# Statement LRU cache size (keep as-is, allow None for optional configuration)
self.statement_cache_size = config.get("statement_cache_size")
if self.user is None or self.password is None or self.database is None:
raise ValueError("Missing database user, password, or database")
# Guard concurrent pool resets
self._pool_reconnect_lock = asyncio.Lock()
self._transient_exceptions = (
asyncio.TimeoutError,
TimeoutError,
ConnectionError,
OSError,
asyncpg.exceptions.InterfaceError,
asyncpg.exceptions.TooManyConnectionsError,
asyncpg.exceptions.CannotConnectNowError,
asyncpg.exceptions.PostgresConnectionError,
asyncpg.exceptions.ConnectionDoesNotExistError,
asyncpg.exceptions.ConnectionFailureError,
)
# Connection retry configuration
self.connection_retry_attempts = config["connection_retry_attempts"]
self.connection_retry_backoff = config["connection_retry_backoff"]
self.connection_retry_backoff_max = max(
self.connection_retry_backoff,
config["connection_retry_backoff_max"],
)
self.pool_close_timeout = config["pool_close_timeout"]
logger.info(
"PostgreSQL, Retry config: attempts=%s, backoff=%.1fs, backoff_max=%.1fs, pool_close_timeout=%.1fs",
self.connection_retry_attempts,
self.connection_retry_backoff,
self.connection_retry_backoff_max,
self.pool_close_timeout,
)
def _create_ssl_context(self) -> ssl.SSLContext | None:
"""Create SSL context based on configuration parameters."""
if not self.ssl_mode:
return None
ssl_mode = self.ssl_mode.lower()
# For simple modes that don't require custom context
if ssl_mode in ["disable", "allow", "prefer", "require"]:
if ssl_mode == "disable":
return None
elif ssl_mode in ["require", "prefer", "allow"]:
# Return None for simple SSL requirement, handled in initdb
return None
# For modes that require certificate verification
if ssl_mode in ["verify-ca", "verify-full"]:
try:
context = ssl.create_default_context(ssl.Purpose.SERVER_AUTH)
# Configure certificate verification
if ssl_mode == "verify-ca":
context.check_hostname = False
elif ssl_mode == "verify-full":
context.check_hostname = True
# Load root certificate if provided
if self.ssl_root_cert:
if os.path.exists(self.ssl_root_cert):
context.load_verify_locations(cafile=self.ssl_root_cert)
logger.info(
f"PostgreSQL, Loaded SSL root certificate: {self.ssl_root_cert}"
)
else:
logger.warning(
f"PostgreSQL, SSL root certificate file not found: {self.ssl_root_cert}"
)
# Load client certificate and key if provided
if self.ssl_cert and self.ssl_key:
if os.path.exists(self.ssl_cert) and os.path.exists(self.ssl_key):
context.load_cert_chain(self.ssl_cert, self.ssl_key)
logger.info(
f"PostgreSQL, Loaded SSL client certificate: {self.ssl_cert}"
)
else:
logger.warning(
"PostgreSQL, SSL client certificate or key file not found"
)
# Load certificate revocation list if provided
if self.ssl_crl:
if os.path.exists(self.ssl_crl):
context.load_verify_locations(crlfile=self.ssl_crl)
logger.info(f"PostgreSQL, Loaded SSL CRL: {self.ssl_crl}")
else:
logger.warning(
f"PostgreSQL, SSL CRL file not found: {self.ssl_crl}"
)
return context
except Exception as e:
logger.error(f"PostgreSQL, Failed to create SSL context: {e}")
raise ValueError(f"SSL configuration error: {e}")
# Unknown SSL mode
logger.warning(f"PostgreSQL, Unknown SSL mode: {ssl_mode}, SSL disabled")
return None
async def initdb(self):
# Prepare connection parameters
connection_params = {
"user": self.user,
"password": self.password,
"database": self.database,
"host": self.host,
"port": self.port,
"min_size": 1,
"max_size": self.max,
}
# Only add statement_cache_size if it's configured
if self.statement_cache_size is not None:
connection_params["statement_cache_size"] = int(self.statement_cache_size)
logger.info(
f"PostgreSQL, statement LRU cache size set as: {self.statement_cache_size}"
)
# Add SSL configuration if provided
ssl_context = self._create_ssl_context()
if ssl_context is not None:
connection_params["ssl"] = ssl_context
logger.info("PostgreSQL, SSL configuration applied")
elif self.ssl_mode:
# Handle simple SSL modes without custom context
if self.ssl_mode.lower() in ["require", "prefer"]:
connection_params["ssl"] = True
elif self.ssl_mode.lower() == "disable":
connection_params["ssl"] = False
logger.info(f"PostgreSQL, SSL mode set to: {self.ssl_mode}")
# Add server settings if provided
if self.server_settings:
try:
settings = {}
# The format is expected to be a query string, e.g., "key1=value1&key2=value2"
pairs = self.server_settings.split("&")
for pair in pairs:
if "=" in pair:
key, value = pair.split("=", 1)
settings[key] = value
if settings:
connection_params["server_settings"] = settings
logger.info(f"PostgreSQL, Server settings applied: {settings}")
except Exception as e:
logger.warning(
f"PostgreSQL, Failed to parse server_settings: {self.server_settings}, error: {e}"
)
wait_strategy = (
wait_exponential(
multiplier=self.connection_retry_backoff,
min=self.connection_retry_backoff,
max=self.connection_retry_backoff_max,
)
if self.connection_retry_backoff > 0
else wait_fixed(0)
)
async def _init_connection(connection: asyncpg.Connection) -> None:
"""Initialize each new connection with pgvector codec and VCHORDRQ session params.
Called once per physical connection creation (not on pool reuse).
register_vector is a Python-level codec registration that survives
asyncpg's RESET ALL; VCHORDRQ GUCs do not — they are re-applied in
_reset_connection after each pool release.
"""
if self.enable_vector:
await register_vector(connection)
if self.enable_vector and self.vector_index_type == "VCHORDRQ":
await self.configure_vchordrq(connection)
async def _reset_connection(connection: asyncpg.Connection) -> None:
"""Run the default asyncpg cleanup, then re-apply VCHORDRQ session GUCs.
When a custom reset= callback is registered with create_pool(), asyncpg
calls Connection._reset() (private — clears listeners and rolls back open
transactions if any) and then this function. It does NOT call the public
Connection.reset(), which is the method that calls _reset() and then
executes the cleanup query returned by get_reset_query() — the exact SQL
depends on detected server capabilities and typically includes
pg_advisory_unlock_all(), CLOSE ALL, UNLISTEN *, and RESET ALL.
We must therefore run that cleanup ourselves via get_reset_query() before
restoring VCHORDRQ GUCs. Skipping this step leaks session state across
pool checkouts — for example configure_age() sets search_path and that
modified path would persist into the next non-AGE connection checkout.
register_vector is NOT repeated here: it is a Python-side encoder/decoder
registration on the asyncpg Connection object and is unaffected by RESET ALL.
Note that set_type_codec() clears the statement cache, which is naturally
repopulated on subsequent queries.
"""
try:
# Run the default cleanup that asyncpg would otherwise handle.
reset_query = connection.get_reset_query()
if reset_query:
await connection.execute(reset_query)
except Exception as e:
logger.error(
f"[{self.workspace}] Pool reset cleanup query failed — connection "
f"will be terminated and removed from pool: {e}"
)
raise
# RESET ALL clears session GUCs; restore VCHORDRQ values afterward.
if self.enable_vector and self.vector_index_type == "VCHORDRQ":
try:
await self.configure_vchordrq(connection)
except asyncpg.exceptions.UndefinedObjectError:
logger.error(
f"[{self.workspace}] VCHORDRQ extension is not installed. "
"Install the extension or set vector_index_type to a supported value. "
"Connection will be terminated and removed from pool."
)
raise
except asyncpg.exceptions.InvalidParameterValueError as e:
logger.error(
f"[{self.workspace}] Invalid VCHORDRQ GUC parameter — "
f"check vchordrq_probes and vchordrq_epsilon config. "
f"Connection will be terminated: {e}"
)
raise
except Exception as e:
logger.error(
f"[{self.workspace}] VCHORDRQ session configuration failed "
f"after pool reset — connection will be terminated: {e}"
)
raise
async def _create_pool_once() -> None:
# STEP 1: Bootstrap - ensure vector extension exists BEFORE pool creation.
# On a fresh database, register_vector() in _init_connection will fail
# if the vector extension doesn't exist yet, because the 'vector' type
# won't be found in pg_catalog. We must create the extension first
# using a standalone bootstrap connection.
# Skip this step if vector support is not enabled.
if self.enable_vector:
bootstrap_conn = await asyncpg.connect(
user=self.user,
password=self.password,
database=self.database,
host=self.host,
port=self.port,
ssl=connection_params.get("ssl"),
)
try:
await self.configure_vector_extension(bootstrap_conn)
finally:
await bootstrap_conn.close()
# STEP 2: Now safe to create pool with register_vector callback.
# The vector extension is guaranteed to exist at this point (if enabled).
pool = await asyncpg.create_pool(
**connection_params,
init=_init_connection, # register pgvector codec on new connections
reset=_reset_connection, # re-apply VCHORDRQ GUCs after RESET ALL
) # type: ignore
self.pool = pool
try:
async for attempt in AsyncRetrying(
stop=stop_after_attempt(self.connection_retry_attempts),
retry=retry_if_exception_type(self._transient_exceptions),
wait=wait_strategy,
before_sleep=self._before_sleep,
reraise=True,
):
with attempt:
await _create_pool_once()
ssl_status = "with SSL" if connection_params.get("ssl") else "without SSL"
logger.info(
f"PostgreSQL, Connected to database at {self.host}:{self.port}/{self.database} {ssl_status}"
)
except Exception as e:
logger.error(
f"PostgreSQL, Failed to connect database at {self.host}:{self.port}/{self.database}, Got:{e}"
)
raise
async def _ensure_pool(self) -> None:
"""Ensure the connection pool is initialised."""
if self.pool is None:
async with self._pool_reconnect_lock:
if self.pool is None:
await self.initdb()
async def _reset_pool(self) -> None:
async with self._pool_reconnect_lock:
if self.pool is not None:
try:
await asyncio.wait_for(
self.pool.close(), timeout=self.pool_close_timeout
)
except asyncio.TimeoutError:
logger.error(
"PostgreSQL, Timed out closing connection pool after %.2fs",
self.pool_close_timeout,
)
except Exception as close_error: # pragma: no cover - defensive logging
logger.warning(
f"PostgreSQL, Failed to close existing connection pool cleanly: {close_error!r}"
)
self.pool = None
async def _before_sleep(self, retry_state: RetryCallState) -> None:
"""Hook invoked by tenacity before sleeping between retries."""
exc = retry_state.outcome.exception() if retry_state.outcome else None
logger.warning(
"PostgreSQL transient connection issue on attempt %s/%s: %r",
retry_state.attempt_number,
self.connection_retry_attempts,
exc,
)
await self._reset_pool()
async def _run_with_retry(
self,
operation: Callable[[asyncpg.Connection], Awaitable[T]],
*,
with_age: bool = False,
graph_name: str | None = None,
timing_label: str | None = None,
) -> T:
"""
Execute a database operation with automatic retry for transient failures.
Args:
operation: Async callable that receives an active connection.
with_age: Whether to configure Apache AGE on the connection.
graph_name: AGE graph name; required when with_age is True.
Returns:
The result returned by the operation.
Raises:
Exception: Propagates the last error if all retry attempts fail or a non-transient error occurs.
"""
wait_strategy = (
wait_exponential(
multiplier=self.connection_retry_backoff,
min=self.connection_retry_backoff,
max=self.connection_retry_backoff_max,
)
if self.connection_retry_backoff > 0
else wait_fixed(0)
)
async for attempt in AsyncRetrying(
stop=stop_after_attempt(self.connection_retry_attempts),
retry=retry_if_exception_type(self._transient_exceptions),
wait=wait_strategy,
before_sleep=self._before_sleep,
reraise=True,
):
with attempt:
await self._ensure_pool()
assert self.pool is not None
if timing_label:
pool_snapshot_before = self._get_pool_snapshot()
performance_timing_log(
"[%s] pool.acquire waiting %s",
timing_label,
pool_snapshot_before,
)
acquire_start = time.perf_counter()
async with self.pool.acquire() as connection: # type: ignore[arg-type]
acquire_elapsed = time.perf_counter() - acquire_start
if timing_label:
pool_snapshot_after = self._get_pool_snapshot()
performance_timing_log(
"[%s] pool.acquire completed in %.4fs %s",
timing_label,
acquire_elapsed,
pool_snapshot_after,
)
if with_age and graph_name:
await self.configure_age(connection, graph_name)
elif with_age and not graph_name:
raise ValueError("Graph name is required when with_age is True")
return await operation(connection)
def _get_pool_snapshot(self) -> str:
"""Best-effort snapshot of asyncpg pool state for diagnostics.
Uses asyncpg private attributes defensively; if a field is unavailable in the
installed asyncpg version, return '?' for that metric instead of failing.
"""
pool = self.pool
if pool is None:
return "pool_state=uninitialized"
holders = getattr(pool, "_holders", None)
queue = getattr(pool, "_queue", None)
max_size = getattr(pool, "_maxsize", None)
min_size = getattr(pool, "_minsize", None)
total_holders = len(holders) if holders is not None else "?"
idle_count: int | str = "?"
acquired_count: int | str = "?"
if holders is not None:
idle_count = 0
acquired_count = 0
for holder in holders:
# asyncpg holder uses _in_use Future/Event-like marker; treat present value as acquired
in_use_marker = getattr(holder, "_in_use", None)
if in_use_marker:
acquired_count += 1
else:
idle_count += 1
waiting_count: int | str = "?"
if queue is not None:
getters = getattr(queue, "_getters", None)
if getters is not None:
waiting_count = len(getters)
return (
f"pool_state[min={min_size}, max={max_size}, holders={total_holders}, "
f"acquired={acquired_count}, idle={idle_count}, waiting={waiting_count}]"
)
async def configure_vector_extension(self, connection: asyncpg.Connection) -> None:
"""Create VECTOR extension if it doesn't exist for vector similarity operations.
When vector_index_type is HNSW_HALFVEC, validates that pgvector >= 0.7.0
(required for halfvec support) and raises RuntimeError if older.
"""
try:
await connection.execute("CREATE EXTENSION IF NOT EXISTS vector") # type: ignore
logger.info("PostgreSQL, VECTOR extension enabled")
except Exception as e:
logger.warning(f"Could not create VECTOR extension: {e}")
# Don't raise - let the system continue without vector extension
return
if getattr(self, "vector_index_type", None) == "HNSW_HALFVEC":
row = await connection.fetchrow(
"SELECT extversion FROM pg_extension WHERE extname = 'vector'"
)
if not row or not row["extversion"]:
raise RuntimeError(
"POSTGRES_VECTOR_INDEX_TYPE=HNSW_HALFVEC requires the pgvector "
"extension. Ensure it is installed and CREATE EXTENSION vector succeeded."
)
raw_version = row["extversion"]
try:
parts = [int(p) for p in str(raw_version).split(".")[:3]]
while len(parts) < 3:
parts.append(0)
version_tuple = (parts[0], parts[1], parts[2])
except (ValueError, IndexError):
raise RuntimeError(
f"Could not parse pgvector version {raw_version!r}. "
"HNSW_HALFVEC requires pgvector >= 0.7.0."
) from None
if version_tuple < (0, 7, 0):
raise RuntimeError(
f"POSTGRES_VECTOR_INDEX_TYPE=HNSW_HALFVEC requires pgvector >= 0.7.0, "
f"but installed version is {raw_version}. Upgrade the pgvector extension "
"or use a different index type (e.g. HNSW with embeddings <= 2000 dimensions)."
)
@staticmethod
async def configure_age_extension(connection: asyncpg.Connection) -> None:
"""Create AGE extension if it doesn't exist for graph operations."""
try:
await connection.execute("CREATE EXTENSION IF NOT EXISTS AGE CASCADE") # type: ignore
logger.info("PostgreSQL, AGE extension enabled")
except Exception as e:
logger.warning(f"Could not create AGE extension: {e}")
# Don't raise - let the system continue without AGE extension
@staticmethod
async def configure_age(connection: asyncpg.Connection, graph_name: str) -> None:
"""Set the Apache AGE environment and creates a graph if it does not exist.
This method:
- Sets the PostgreSQL `search_path` to include `ag_catalog`, ensuring that Apache AGE functions can be used without specifying the schema.
- Attempts to create a new graph with the provided `graph_name` if it does not already exist.
- Silently ignores errors related to the graph already existing.
"""
try:
await connection.execute( # type: ignore
'SET search_path = ag_catalog, "$user", public'
)
await connection.execute( # type: ignore
f"select create_graph('{graph_name}')"
)
except (
asyncpg.exceptions.InvalidSchemaNameError,
asyncpg.exceptions.UniqueViolationError,
):
pass
async def configure_vchordrq(self, connection: asyncpg.Connection) -> None:
"""Configure VCHORDRQ extension for vector similarity search.
Raises:
asyncpg.exceptions.UndefinedObjectError: If VCHORDRQ extension is not installed
asyncpg.exceptions.InvalidParameterValueError: If parameter value is invalid
Note:
This method does not catch exceptions. Configuration errors will fail-fast,
while transient connection errors will be retried by _run_with_retry.
"""
# Handle probes parameter - only set if non-empty value is provided
if self.vchordrq_probes and str(self.vchordrq_probes).strip():
await connection.execute(f"SET vchordrq.probes TO '{self.vchordrq_probes}'")
logger.debug(f"PostgreSQL, VCHORDRQ probes set to: {self.vchordrq_probes}")
# Handle epsilon parameter independently - check for None to allow 0.0 as valid value
if self.vchordrq_epsilon is not None:
await connection.execute(f"SET vchordrq.epsilon TO {self.vchordrq_epsilon}")
logger.debug(
f"PostgreSQL, VCHORDRQ epsilon set to: {self.vchordrq_epsilon}"
)
async def _migrate_llm_cache_schema(self):
"""Migrate LLM cache schema: add new columns and remove deprecated mode field"""
try:
# Check if all columns exist
check_columns_sql = """
SELECT column_name
FROM information_schema.columns
WHERE table_name = 'lightrag_llm_cache'
AND column_name IN ('chunk_id', 'cache_type', 'queryparam', 'mode')
"""
existing_columns = await self.query(check_columns_sql, multirows=True)
existing_column_names = (
{col["column_name"] for col in existing_columns}
if existing_columns
else set()
)
# Add missing chunk_id column
if "chunk_id" not in existing_column_names:
logger.info("Adding chunk_id column to LIGHTRAG_LLM_CACHE table")
add_chunk_id_sql = """
ALTER TABLE LIGHTRAG_LLM_CACHE
ADD COLUMN chunk_id VARCHAR(255) NULL
"""
await self.execute(add_chunk_id_sql)
logger.info(
"Successfully added chunk_id column to LIGHTRAG_LLM_CACHE table"
)
else:
logger.info(
"chunk_id column already exists in LIGHTRAG_LLM_CACHE table"
)
# Add missing cache_type column
if "cache_type" not in existing_column_names:
logger.info("Adding cache_type column to LIGHTRAG_LLM_CACHE table")
add_cache_type_sql = """
ALTER TABLE LIGHTRAG_LLM_CACHE
ADD COLUMN cache_type VARCHAR(32) NULL
"""
await self.execute(add_cache_type_sql)
logger.info(
"Successfully added cache_type column to LIGHTRAG_LLM_CACHE table"
)
# Migrate existing data using optimized regex pattern
logger.info(
"Migrating existing LLM cache data to populate cache_type field (optimized)"
)
optimized_update_sql = """
UPDATE LIGHTRAG_LLM_CACHE
SET cache_type = CASE
WHEN id ~ '^[^:]+:[^:]+:' THEN split_part(id, ':', 2)
ELSE 'extract'
END
WHERE cache_type IS NULL
"""
await self.execute(optimized_update_sql)
logger.info("Successfully migrated existing LLM cache data")
else:
logger.info(
"cache_type column already exists in LIGHTRAG_LLM_CACHE table"
)
# Add missing queryparam column
if "queryparam" not in existing_column_names:
logger.info("Adding queryparam column to LIGHTRAG_LLM_CACHE table")
add_queryparam_sql = """
ALTER TABLE LIGHTRAG_LLM_CACHE
ADD COLUMN queryparam JSONB NULL
"""
await self.execute(add_queryparam_sql)
logger.info(
"Successfully added queryparam column to LIGHTRAG_LLM_CACHE table"
)
else:
logger.info(
"queryparam column already exists in LIGHTRAG_LLM_CACHE table"
)
# Remove deprecated mode field if it exists
if "mode" in existing_column_names:
logger.info(
"Removing deprecated mode column from LIGHTRAG_LLM_CACHE table"
)
# First, drop the primary key constraint that includes mode
drop_pk_sql = """
ALTER TABLE LIGHTRAG_LLM_CACHE
DROP CONSTRAINT IF EXISTS LIGHTRAG_LLM_CACHE_PK
"""
await self.execute(drop_pk_sql)
logger.info("Dropped old primary key constraint")
# Drop the mode column
drop_mode_sql = """
ALTER TABLE LIGHTRAG_LLM_CACHE
DROP COLUMN mode
"""
await self.execute(drop_mode_sql)
logger.info(
"Successfully removed mode column from LIGHTRAG_LLM_CACHE table"
)
# Create new primary key constraint without mode
add_pk_sql = """
ALTER TABLE LIGHTRAG_LLM_CACHE
ADD CONSTRAINT LIGHTRAG_LLM_CACHE_PK PRIMARY KEY (workspace, id)
"""
await self.execute(add_pk_sql)
logger.info("Created new primary key constraint (workspace, id)")
else:
logger.info("mode column does not exist in LIGHTRAG_LLM_CACHE table")
except Exception as e:
logger.warning(f"Failed to migrate LLM cache schema: {e}")
async def _migrate_timestamp_columns(self):
"""Migrate timestamp columns in tables to witimezone-free types, assuming original data is in UTC time"""
# Tables and columns that need migration
tables_to_migrate = {
"LIGHTRAG_VDB_ENTITY": ["create_time", "update_time"],
"LIGHTRAG_VDB_RELATION": ["create_time", "update_time"],
"LIGHTRAG_DOC_CHUNKS": ["create_time", "update_time"],
"LIGHTRAG_DOC_STATUS": ["created_at", "updated_at"],
}
try:
# Filter out tables that don't exist (e.g., legacy vector tables may not exist)
existing_tables = {}
for table_name, columns in tables_to_migrate.items():
if await self.check_table_exists(table_name):
existing_tables[table_name] = columns
else:
logger.debug(
f"Table {table_name} does not exist, skipping timestamp migration"
)
# Skip if no tables to migrate
if not existing_tables:
logger.debug("No tables found for timestamp migration")
return
# Use filtered tables for migration
tables_to_migrate = existing_tables
# Optimization: Batch check all columns in one query instead of 8 separate queries
table_names_lower = [t.lower() for t in tables_to_migrate.keys()]
all_column_names = list(
set(col for cols in tables_to_migrate.values() for col in cols)
)
check_all_columns_sql = """
SELECT table_name, column_name, data_type
FROM information_schema.columns
WHERE table_name = ANY($1)
AND column_name = ANY($2)
"""
all_columns_result = await self.query(
check_all_columns_sql,
[table_names_lower, all_column_names],
multirows=True,
)
# Build lookup dict: (table_name, column_name) -> data_type
column_types = {}
if all_columns_result:
column_types = {
(row["table_name"].upper(), row["column_name"]): row["data_type"]
for row in all_columns_result
}
# Now iterate and migrate only what's needed
for table_name, columns in tables_to_migrate.items():
for column_name in columns:
try:
data_type = column_types.get((table_name, column_name))
if not data_type:
logger.warning(
f"Column {table_name}.{column_name} does not exist, skipping migration"
)
continue
# Check column type
if data_type == "timestamp without time zone":
logger.debug(
f"Column {table_name}.{column_name} is already witimezone-free, no migration needed"
)
continue
# Execute migration, explicitly specifying UTC timezone for interpreting original data
logger.info(
f"Migrating {table_name}.{column_name} from {data_type} to TIMESTAMP(0) type"
)
migration_sql = f"""
ALTER TABLE {table_name}
ALTER COLUMN {column_name} TYPE TIMESTAMP(0),
ALTER COLUMN {column_name} SET DEFAULT CURRENT_TIMESTAMP
"""
await self.execute(migration_sql)
logger.info(
f"Successfully migrated {table_name}.{column_name} to timezone-free type"
)
except Exception as e:
# Log error but don't interrupt the process
logger.warning(
f"Failed to migrate {table_name}.{column_name}: {e}"
)
except Exception as e:
logger.error(f"Failed to batch check timestamp columns: {e}")
async def _migrate_doc_chunks_to_vdb_chunks(self):
"""
Migrate data from LIGHTRAG_DOC_CHUNKS to LIGHTRAG_VDB_CHUNKS if specific conditions are met.
This migration is intended for users who are upgrading and have an older table structure
where LIGHTRAG_DOC_CHUNKS contained a `content_vector` column.
"""
try:
# 0. Check if both tables exist before proceeding
vdb_chunks_exists = await self.check_table_exists("LIGHTRAG_VDB_CHUNKS")
doc_chunks_exists = await self.check_table_exists("LIGHTRAG_DOC_CHUNKS")
if not vdb_chunks_exists:
logger.debug(
"Skipping migration: LIGHTRAG_VDB_CHUNKS table does not exist"
)
return
if not doc_chunks_exists:
logger.debug(
"Skipping migration: LIGHTRAG_DOC_CHUNKS table does not exist"
)
return
# 1. Check if the new table LIGHTRAG_VDB_CHUNKS is empty
vdb_chunks_count_sql = "SELECT COUNT(1) as count FROM LIGHTRAG_VDB_CHUNKS"
vdb_chunks_count_result = await self.query(vdb_chunks_count_sql)
if vdb_chunks_count_result and vdb_chunks_count_result["count"] > 0:
logger.info(
"Skipping migration: LIGHTRAG_VDB_CHUNKS already contains data."
)
return
# 2. Check if `content_vector` column exists in the old table
check_column_sql = """
SELECT 1 FROM information_schema.columns
WHERE table_name = 'lightrag_doc_chunks' AND column_name = 'content_vector'
"""
column_exists = await self.query(check_column_sql)
if not column_exists:
logger.info(
"Skipping migration: `content_vector` not found in LIGHTRAG_DOC_CHUNKS"
)
return
# 3. Check if the old table LIGHTRAG_DOC_CHUNKS has data
doc_chunks_count_sql = "SELECT COUNT(1) as count FROM LIGHTRAG_DOC_CHUNKS"
doc_chunks_count_result = await self.query(doc_chunks_count_sql)
if not doc_chunks_count_result or doc_chunks_count_result["count"] == 0:
logger.info("Skipping migration: LIGHTRAG_DOC_CHUNKS is empty.")
return
# 4. Perform the migration
logger.info(
"Starting data migration from LIGHTRAG_DOC_CHUNKS to LIGHTRAG_VDB_CHUNKS..."
)
migration_sql = """
INSERT INTO LIGHTRAG_VDB_CHUNKS (
id, workspace, full_doc_id, chunk_order_index, tokens, content,
content_vector, file_path, create_time, update_time
)
SELECT
id, workspace, full_doc_id, chunk_order_index, tokens, content,
content_vector, file_path, create_time, update_time
FROM LIGHTRAG_DOC_CHUNKS
ON CONFLICT (workspace, id) DO NOTHING;
"""
await self.execute(migration_sql)
logger.info("Data migration to LIGHTRAG_VDB_CHUNKS completed successfully.")
except Exception as e:
logger.error(f"Failed during data migration to LIGHTRAG_VDB_CHUNKS: {e}")
# Do not re-raise, to allow the application to start
async def _check_llm_cache_needs_migration(self):
"""Check if LLM cache data needs migration by examining any record with old format"""
try:
# Optimized query: directly check for old format records without sorting
check_sql = """
SELECT 1 FROM LIGHTRAG_LLM_CACHE
WHERE id NOT LIKE '%:%'
LIMIT 1
"""
result = await self.query(check_sql)
# If any old format record exists, migration is needed
return result is not None
except Exception as e:
logger.warning(f"Failed to check LLM cache migration status: {e}")
return False
async def _migrate_llm_cache_to_flattened_keys(self):
"""Optimized version: directly execute single UPDATE migration to migrate old format cache keys to flattened format"""
try:
# Check if migration is needed
check_sql = """
SELECT COUNT(*) as count FROM LIGHTRAG_LLM_CACHE
WHERE id NOT LIKE '%:%'
"""
result = await self.query(check_sql)
if not result or result["count"] == 0:
logger.info("No old format LLM cache data found, skipping migration")
return
old_count = result["count"]
logger.info(f"Found {old_count} old format cache records")
# Check potential primary key conflicts (optional but recommended)
conflict_check_sql = """
WITH new_ids AS (
SELECT
workspace,
mode,
id as old_id,
mode || ':' ||
CASE WHEN mode = 'default' THEN 'extract' ELSE 'unknown' END || ':' ||
md5(original_prompt) as new_id
FROM LIGHTRAG_LLM_CACHE
WHERE id NOT LIKE '%:%'
)
SELECT COUNT(*) as conflicts
FROM new_ids n1
JOIN LIGHTRAG_LLM_CACHE existing
ON existing.workspace = n1.workspace
AND existing.mode = n1.mode
AND existing.id = n1.new_id
WHERE existing.id LIKE '%:%' -- Only check conflicts with existing new format records
"""
conflict_result = await self.query(conflict_check_sql)
if conflict_result and conflict_result["conflicts"] > 0:
logger.warning(
f"Found {conflict_result['conflicts']} potential ID conflicts with existing records"
)
# Can choose to continue or abort, here we choose to continue and log warning
# Execute single UPDATE migration
logger.info("Starting optimized LLM cache migration...")
migration_sql = """
UPDATE LIGHTRAG_LLM_CACHE
SET
id = mode || ':' ||
CASE WHEN mode = 'default' THEN 'extract' ELSE 'unknown' END || ':' ||
md5(original_prompt),
cache_type = CASE WHEN mode = 'default' THEN 'extract' ELSE 'unknown' END,
update_time = CURRENT_TIMESTAMP
WHERE id NOT LIKE '%:%'
"""
# Execute migration
await self.execute(migration_sql)
# Verify migration results
verify_sql = """
SELECT COUNT(*) as remaining_old FROM LIGHTRAG_LLM_CACHE
WHERE id NOT LIKE '%:%'
"""
verify_result = await self.query(verify_sql)
remaining = verify_result["remaining_old"] if verify_result else -1
if remaining == 0:
logger.info(
f"✅ Successfully migrated {old_count} LLM cache records to flattened format"
)
else:
logger.warning(
f"⚠️ Migration completed but {remaining} old format records remain"
)
except Exception as e:
logger.error(f"Optimized LLM cache migration failed: {e}")
raise
async def _migrate_doc_status_add_chunks_list(self):
"""Add chunks_list column to LIGHTRAG_DOC_STATUS table if it doesn't exist"""
try:
# Check if chunks_list column exists
check_column_sql = """
SELECT column_name
FROM information_schema.columns
WHERE table_name = 'lightrag_doc_status'
AND column_name = 'chunks_list'
"""
column_info = await self.query(check_column_sql)
if not column_info:
logger.info("Adding chunks_list column to LIGHTRAG_DOC_STATUS table")
add_column_sql = """
ALTER TABLE LIGHTRAG_DOC_STATUS
ADD COLUMN chunks_list JSONB NULL DEFAULT '[]'::jsonb
"""
await self.execute(add_column_sql)
logger.info(
"Successfully added chunks_list column to LIGHTRAG_DOC_STATUS table"
)
else:
logger.info(
"chunks_list column already exists in LIGHTRAG_DOC_STATUS table"
)
except Exception as e:
logger.warning(
f"Failed to add chunks_list column to LIGHTRAG_DOC_STATUS: {e}"
)
async def _migrate_text_chunks_add_llm_cache_list(self):
"""Add llm_cache_list column to LIGHTRAG_DOC_CHUNKS table if it doesn't exist"""
try:
# Check if llm_cache_list column exists
check_column_sql = """
SELECT column_name
FROM information_schema.columns
WHERE table_name = 'lightrag_doc_chunks'
AND column_name = 'llm_cache_list'
"""
column_info = await self.query(check_column_sql)
if not column_info:
logger.info("Adding llm_cache_list column to LIGHTRAG_DOC_CHUNKS table")
add_column_sql = """
ALTER TABLE LIGHTRAG_DOC_CHUNKS
ADD COLUMN llm_cache_list JSONB NULL DEFAULT '[]'::jsonb
"""
await self.execute(add_column_sql)
logger.info(
"Successfully added llm_cache_list column to LIGHTRAG_DOC_CHUNKS table"
)
else:
logger.info(
"llm_cache_list column already exists in LIGHTRAG_DOC_CHUNKS table"
)
except Exception as e:
logger.warning(
f"Failed to add llm_cache_list column to LIGHTRAG_DOC_CHUNKS: {e}"
)
async def _migrate_doc_status_add_track_id(self):
"""Add track_id column to LIGHTRAG_DOC_STATUS table if it doesn't exist and create index"""
try:
# Check if track_id column exists
check_column_sql = """
SELECT column_name
FROM information_schema.columns
WHERE table_name = 'lightrag_doc_status'
AND column_name = 'track_id'
"""
column_info = await self.query(check_column_sql)
if not column_info:
logger.info("Adding track_id column to LIGHTRAG_DOC_STATUS table")
add_column_sql = """
ALTER TABLE LIGHTRAG_DOC_STATUS
ADD COLUMN track_id VARCHAR(255) NULL
"""
await self.execute(add_column_sql)
logger.info(
"Successfully added track_id column to LIGHTRAG_DOC_STATUS table"
)
else:
logger.info(
"track_id column already exists in LIGHTRAG_DOC_STATUS table"
)
# Check if track_id index exists
check_index_sql = """
SELECT indexname
FROM pg_indexes
WHERE tablename = 'lightrag_doc_status'
AND indexname = 'idx_lightrag_doc_status_track_id'
"""
index_info = await self.query(check_index_sql)
if not index_info:
logger.info(
"Creating index on track_id column for LIGHTRAG_DOC_STATUS table"
)
create_index_sql = """
CREATE INDEX idx_lightrag_doc_status_track_id ON LIGHTRAG_DOC_STATUS (track_id)
"""
await self.execute(create_index_sql)
logger.info(
"Successfully created index on track_id column for LIGHTRAG_DOC_STATUS table"
)
else:
logger.info(
"Index on track_id column already exists for LIGHTRAG_DOC_STATUS table"
)
except Exception as e:
logger.warning(
f"Failed to add track_id column or index to LIGHTRAG_DOC_STATUS: {e}"
)
async def _migrate_doc_status_add_metadata_error_msg(self):
"""Add metadata and error_msg columns to LIGHTRAG_DOC_STATUS table if they don't exist"""
try:
# Check if metadata column exists
check_metadata_sql = """
SELECT column_name
FROM information_schema.columns
WHERE table_name = 'lightrag_doc_status'
AND column_name = 'metadata'
"""
metadata_info = await self.query(check_metadata_sql)
if not metadata_info:
logger.info("Adding metadata column to LIGHTRAG_DOC_STATUS table")
add_metadata_sql = """
ALTER TABLE LIGHTRAG_DOC_STATUS
ADD COLUMN metadata JSONB NULL DEFAULT '{}'::jsonb
"""
await self.execute(add_metadata_sql)
logger.info(
"Successfully added metadata column to LIGHTRAG_DOC_STATUS table"
)
else:
logger.info(
"metadata column already exists in LIGHTRAG_DOC_STATUS table"
)
# Check if error_msg column exists
check_error_msg_sql = """
SELECT column_name
FROM information_schema.columns
WHERE table_name = 'lightrag_doc_status'
AND column_name = 'error_msg'
"""
error_msg_info = await self.query(check_error_msg_sql)
if not error_msg_info:
logger.info("Adding error_msg column to LIGHTRAG_DOC_STATUS table")
add_error_msg_sql = """
ALTER TABLE LIGHTRAG_DOC_STATUS
ADD COLUMN error_msg TEXT NULL
"""
await self.execute(add_error_msg_sql)
logger.info(
"Successfully added error_msg column to LIGHTRAG_DOC_STATUS table"
)
else:
logger.info(
"error_msg column already exists in LIGHTRAG_DOC_STATUS table"
)
except Exception as e:
logger.warning(
f"Failed to add metadata/error_msg columns to LIGHTRAG_DOC_STATUS: {e}"
)
async def _migrate_field_lengths(self):
"""Migrate database field lengths: entity_name, source_id, target_id, and file_path"""
# Define the field changes needed
field_migrations = [
{
"table": "LIGHTRAG_VDB_ENTITY",
"column": "entity_name",
"old_type": "character varying(255)",
"new_type": "VARCHAR(512)",
"description": "entity_name from 255 to 512",
},
{
"table": "LIGHTRAG_VDB_RELATION",
"column": "source_id",
"old_type": "character varying(256)",
"new_type": "VARCHAR(512)",
"description": "source_id from 256 to 512",
},
{
"table": "LIGHTRAG_VDB_RELATION",
"column": "target_id",
"old_type": "character varying(256)",
"new_type": "VARCHAR(512)",
"description": "target_id from 256 to 512",
},
{
"table": "LIGHTRAG_DOC_CHUNKS",
"column": "file_path",
"old_type": "character varying(256)",
"new_type": "TEXT",
"description": "file_path to TEXT NULL",
},
{
"table": "LIGHTRAG_VDB_CHUNKS",
"column": "file_path",
"old_type": "character varying(256)",
"new_type": "TEXT",
"description": "file_path to TEXT NULL",
},
]
try:
# Filter out tables that don't exist (e.g., legacy vector tables may not exist)
existing_migrations = []
for migration in field_migrations:
if await self.check_table_exists(migration["table"]):
existing_migrations.append(migration)
else:
logger.debug(
f"Table {migration['table']} does not exist, skipping field length migration for {migration['column']}"
)
# Skip if no migrations to process
if not existing_migrations:
logger.debug("No tables found for field length migration")
return
# Use filtered migrations for processing
field_migrations = existing_migrations
# Optimization: Batch check all columns in one query instead of 5 separate queries
unique_tables = list(set(m["table"].lower() for m in field_migrations))
unique_columns = list(set(m["column"] for m in field_migrations))
check_all_columns_sql = """
SELECT table_name, column_name, data_type, character_maximum_length, is_nullable
FROM information_schema.columns
WHERE table_name = ANY($1)
AND column_name = ANY($2)
"""
all_columns_result = await self.query(
check_all_columns_sql, [unique_tables, unique_columns], multirows=True
)
# Build lookup dict: (table_name, column_name) -> column_info
column_info_map = {}
if all_columns_result:
column_info_map = {
(row["table_name"].upper(), row["column_name"]): row
for row in all_columns_result
}
# Now iterate and migrate only what's needed
for migration in field_migrations:
try:
column_info = column_info_map.get(
(migration["table"], migration["column"])
)
if not column_info:
logger.warning(
f"Column {migration['table']}.{migration['column']} does not exist, skipping migration"
)
continue
current_type = column_info.get("data_type", "").lower()
current_length = column_info.get("character_maximum_length")
# Check if migration is needed
needs_migration = False
if migration["column"] == "entity_name" and current_length == 255:
needs_migration = True
elif (
migration["column"] in ["source_id", "target_id"]
and current_length == 256
):
needs_migration = True
elif (
migration["column"] == "file_path"
and current_type == "character varying"
):
needs_migration = True
if needs_migration:
logger.info(
f"Migrating {migration['table']}.{migration['column']}: {migration['description']}"
)
# Execute the migration
alter_sql = f"""
ALTER TABLE {migration["table"]}
ALTER COLUMN {migration["column"]} TYPE {migration["new_type"]}
"""
await self.execute(alter_sql)
logger.info(
f"Successfully migrated {migration['table']}.{migration['column']}"
)
else:
logger.debug(
f"Column {migration['table']}.{migration['column']} already has correct type, no migration needed"
)
except Exception as e:
# Log error but don't interrupt the process
logger.warning(
f"Failed to migrate {migration['table']}.{migration['column']}: {e}"
)
except Exception as e:
logger.error(f"Failed to batch check field lengths: {e}")
async def check_tables(self):
# Vector tables that should be skipped - they are created by PGVectorStorage.setup_table()
# with proper embedding model and dimension suffix for data isolation
vector_tables_to_skip = {
"LIGHTRAG_VDB_CHUNKS",
"LIGHTRAG_VDB_ENTITY",
"LIGHTRAG_VDB_RELATION",
}
# First create all tables (except vector tables)
for k, v in TABLES.items():
# Skip vector tables - they are created by PGVectorStorage.setup_table()
if k in vector_tables_to_skip:
continue
try:
await self.query(f"SELECT 1 FROM {k} LIMIT 1")
except Exception:
try:
logger.info(f"PostgreSQL, Try Creating table {k} in database")
await self.execute(v["ddl"])
logger.info(
f"PostgreSQL, Creation success table {k} in PostgreSQL database"
)
except Exception as e:
logger.error(
f"PostgreSQL, Failed to create table {k} in database, Please verify the connection with PostgreSQL database, Got: {e}"
)
raise e
# Batch check all indexes at once (optimization: single query instead of N queries)
try:
# Exclude vector tables from index creation since they are created by PGVectorStorage.setup_table()
table_names = [k for k in TABLES.keys() if k not in vector_tables_to_skip]
table_names_lower = [t.lower() for t in table_names]
# Get all existing indexes for our tables in one query
check_all_indexes_sql = """
SELECT indexname, tablename
FROM pg_indexes
WHERE tablename = ANY($1)
"""
existing_indexes_result = await self.query(
check_all_indexes_sql, [table_names_lower], multirows=True
)
# Build a set of existing index names for fast lookup
existing_indexes = set()
if existing_indexes_result:
existing_indexes = {row["indexname"] for row in existing_indexes_result}
# Create missing indexes
for k in table_names:
# Create index for id column if missing
index_name = f"idx_{k.lower()}_id"
if index_name not in existing_indexes:
try:
create_index_sql = f"CREATE INDEX {index_name} ON {k}(id)"
logger.info(
f"PostgreSQL, Creating index {index_name} on table {k}"
)
await self.execute(create_index_sql)
except Exception as e:
logger.error(
f"PostgreSQL, Failed to create index {index_name}, Got: {e}"
)
# Create composite index for (workspace, id) if missing
composite_index_name = f"idx_{k.lower()}_workspace_id"
if composite_index_name not in existing_indexes:
try:
create_composite_index_sql = (
f"CREATE INDEX {composite_index_name} ON {k}(workspace, id)"
)
logger.info(
f"PostgreSQL, Creating composite index {composite_index_name} on table {k}"
)
await self.execute(create_composite_index_sql)
except Exception as e:
logger.error(
f"PostgreSQL, Failed to create composite index {composite_index_name}, Got: {e}"
)
except Exception as e:
logger.error(f"PostgreSQL, Failed to batch check/create indexes: {e}")
# NOTE: Vector index creation moved to PGVectorStorage.setup_table()
# Each vector storage instance creates its own index with correct embedding_dim
# After all tables are created, attempt to migrate timestamp fields
try:
await self._migrate_timestamp_columns()
except Exception as e:
logger.error(f"PostgreSQL, Failed to migrate timestamp columns: {e}")
# Don't throw an exception, allow the initialization process to continue
# Migrate LLM cache schema: add new columns and remove deprecated mode field
try:
await self._migrate_llm_cache_schema()
except Exception as e:
logger.error(f"PostgreSQL, Failed to migrate LLM cache schema: {e}")
# Don't throw an exception, allow the initialization process to continue
# Finally, attempt to migrate old doc chunks data if needed
try:
await self._migrate_doc_chunks_to_vdb_chunks()
except Exception as e:
logger.error(f"PostgreSQL, Failed to migrate doc_chunks to vdb_chunks: {e}")
# Check and migrate LLM cache to flattened keys if needed
try:
if await self._check_llm_cache_needs_migration():
await self._migrate_llm_cache_to_flattened_keys()
except Exception as e:
logger.error(f"PostgreSQL, LLM cache migration failed: {e}")
# Migrate doc status to add chunks_list field if needed
try:
await self._migrate_doc_status_add_chunks_list()
except Exception as e:
logger.error(
f"PostgreSQL, Failed to migrate doc status chunks_list field: {e}"
)
# Migrate text chunks to add llm_cache_list field if needed
try:
await self._migrate_text_chunks_add_llm_cache_list()
except Exception as e:
logger.error(
f"PostgreSQL, Failed to migrate text chunks llm_cache_list field: {e}"
)
# Migrate field lengths for entity_name, source_id, target_id, and file_path
try:
await self._migrate_field_lengths()
except Exception as e:
logger.error(f"PostgreSQL, Failed to migrate field lengths: {e}")
# Migrate doc status to add track_id field if needed
try:
await self._migrate_doc_status_add_track_id()
except Exception as e:
logger.error(
f"PostgreSQL, Failed to migrate doc status track_id field: {e}"
)
# Migrate doc status to add metadata and error_msg fields if needed
try:
await self._migrate_doc_status_add_metadata_error_msg()
except Exception as e:
logger.error(
f"PostgreSQL, Failed to migrate doc status metadata/error_msg fields: {e}"
)
# Create pagination optimization indexes for LIGHTRAG_DOC_STATUS
try:
await self._create_pagination_indexes()
except Exception as e:
logger.error(f"PostgreSQL, Failed to create pagination indexes: {e}")
# Migrate to ensure new tables LIGHTRAG_FULL_ENTITIES and LIGHTRAG_FULL_RELATIONS exist
try:
await self._migrate_create_full_entities_relations_tables()
except Exception as e:
logger.error(
f"PostgreSQL, Failed to create full entities/relations tables: {e}"
)
async def _migrate_create_full_entities_relations_tables(self):
"""Create LIGHTRAG_FULL_ENTITIES and LIGHTRAG_FULL_RELATIONS tables if they don't exist"""
tables_to_check = [
{
"name": "LIGHTRAG_FULL_ENTITIES",
"ddl": TABLES["LIGHTRAG_FULL_ENTITIES"]["ddl"],
"description": "Full entities storage table",
},
{
"name": "LIGHTRAG_FULL_RELATIONS",
"ddl": TABLES["LIGHTRAG_FULL_RELATIONS"]["ddl"],
"description": "Full relations storage table",
},
]
for table_info in tables_to_check:
table_name = table_info["name"]
try:
# Check if table exists
check_table_sql = """
SELECT table_name
FROM information_schema.tables
WHERE table_name = $1
AND table_schema = 'public'
"""
params = {"table_name": table_name.lower()}
table_exists = await self.query(check_table_sql, list(params.values()))
if not table_exists:
logger.info(f"Creating table {table_name}")
await self.execute(table_info["ddl"])
logger.info(
f"Successfully created {table_info['description']}: {table_name}"
)
# Create basic indexes for the new table
try:
# Create index for id column
index_name = f"idx_{table_name.lower()}_id"
create_index_sql = (
f"CREATE INDEX {index_name} ON {table_name}(id)"
)
await self.execute(create_index_sql)
logger.info(f"Created index {index_name} on table {table_name}")
# Create composite index for (workspace, id) columns
composite_index_name = f"idx_{table_name.lower()}_workspace_id"
create_composite_index_sql = f"CREATE INDEX {composite_index_name} ON {table_name}(workspace, id)"
await self.execute(create_composite_index_sql)
logger.info(
f"Created composite index {composite_index_name} on table {table_name}"
)
except Exception as e:
logger.warning(
f"Failed to create indexes for table {table_name}: {e}"
)
else:
logger.debug(f"Table {table_name} already exists")
except Exception as e:
logger.error(f"Failed to create table {table_name}: {e}")
async def _create_pagination_indexes(self):
"""Create indexes to optimize pagination queries for LIGHTRAG_DOC_STATUS"""
indexes = [
{
"name": "idx_lightrag_doc_status_workspace_status_updated_at",
"sql": "CREATE INDEX CONCURRENTLY IF NOT EXISTS idx_lightrag_doc_status_workspace_status_updated_at ON LIGHTRAG_DOC_STATUS (workspace, status, updated_at DESC)",
"description": "Composite index for workspace + status + updated_at pagination",
},
{
"name": "idx_lightrag_doc_status_workspace_status_created_at",
"sql": "CREATE INDEX CONCURRENTLY IF NOT EXISTS idx_lightrag_doc_status_workspace_status_created_at ON LIGHTRAG_DOC_STATUS (workspace, status, created_at DESC)",
"description": "Composite index for workspace + status + created_at pagination",
},
{
"name": "idx_lightrag_doc_status_workspace_updated_at",
"sql": "CREATE INDEX CONCURRENTLY IF NOT EXISTS idx_lightrag_doc_status_workspace_updated_at ON LIGHTRAG_DOC_STATUS (workspace, updated_at DESC)",
"description": "Index for workspace + updated_at pagination (all statuses)",
},
{
"name": "idx_lightrag_doc_status_workspace_created_at",
"sql": "CREATE INDEX CONCURRENTLY IF NOT EXISTS idx_lightrag_doc_status_workspace_created_at ON LIGHTRAG_DOC_STATUS (workspace, created_at DESC)",
"description": "Index for workspace + created_at pagination (all statuses)",
},
{
"name": "idx_lightrag_doc_status_workspace_id",
"sql": "CREATE INDEX CONCURRENTLY IF NOT EXISTS idx_lightrag_doc_status_workspace_id ON LIGHTRAG_DOC_STATUS (workspace, id)",
"description": "Index for workspace + id sorting",
},
{
"name": "idx_lightrag_doc_status_workspace_file_path",
"sql": "CREATE INDEX CONCURRENTLY IF NOT EXISTS idx_lightrag_doc_status_workspace_file_path ON LIGHTRAG_DOC_STATUS (workspace, file_path)",
"description": "Index for workspace + file_path sorting",
},
]
# Fetch all existing index names in one query instead of N separate checks.
index_names = [idx["name"] for idx in indexes]
check_sql = """
SELECT indexname FROM pg_indexes
WHERE tablename = 'lightrag_doc_status'
AND indexname = ANY($1)
"""
try:
rows = await self.query(check_sql, [index_names], multirows=True)
existing_names = {row["indexname"] for row in (rows or [])}
except asyncpg.PostgresError as e:
logger.warning(
f"[{self.workspace}] Failed to query existing pagination indexes "
f"({type(e).__name__}), will attempt to create all: {e}"
)
existing_names = set()
for index in indexes:
if index["name"] in existing_names:
logger.debug(f"Index already exists: {index['name']}")
continue
try:
logger.info(f"Creating pagination index: {index['description']}")
await self.execute(index["sql"])
logger.info(f"Successfully created index: {index['name']}")
except asyncpg.PostgresError as e:
logger.warning(
f"Failed to create index {index['name']} ({type(e).__name__}): {e}"
)
async def _create_vector_index(self, table_name: str, embedding_dim: int):
"""
Create vector index for a specific table.
Args:
table_name: Name of the table to create index on
embedding_dim: Embedding dimension for the vector column
"""
if not self.vector_index_type:
return
create_sql = {
"HNSW": f"""
CREATE INDEX {{vector_index_name}}
ON {{table_name}} USING hnsw (content_vector vector_cosine_ops)
WITH (m = {self.hnsw_m}, ef_construction = {self.hnsw_ef})
""",
"HNSW_HALFVEC": f"""
CREATE INDEX {{vector_index_name}}
ON {{table_name}} USING hnsw (content_vector halfvec_cosine_ops)
WITH (m = {self.hnsw_m}, ef_construction = {self.hnsw_ef})
""",
"IVFFLAT": f"""
CREATE INDEX {{vector_index_name}}
ON {{table_name}} USING ivfflat (content_vector vector_cosine_ops)
WITH (lists = {self.ivfflat_lists})
""",
"VCHORDRQ": f"""
CREATE INDEX {{vector_index_name}}
ON {{table_name}} USING vchordrq (content_vector vector_cosine_ops)
{f"WITH (options = $${self.vchordrq_build_options}$$)" if self.vchordrq_build_options else ""}
""",
}
if self.vector_index_type not in create_sql:
logger.warning(
f"Unsupported vector index type: {self.vector_index_type}. "
"Supported types: HNSW, HNSW_HALFVEC, IVFFLAT, VCHORDRQ"
)
return
k = table_name
# Use _safe_index_name to avoid PostgreSQL's 63-byte identifier truncation
index_suffix = f"{self.vector_index_type.lower()}_cosine"
vector_index_name = _safe_index_name(k, index_suffix)
check_vector_index_sql = f"""
SELECT 1 FROM pg_indexes
WHERE indexname = '{vector_index_name}' AND tablename = '{k.lower()}'
"""
if self.vector_index_type == "HNSW_HALFVEC":
column_type = "HALFVEC"
else:
column_type = "VECTOR"
try:
vector_index_exists = await self.query(check_vector_index_sql)
if not vector_index_exists:
for suffix in _VECTOR_INDEX_SUFFIXES:
if suffix == index_suffix:
continue
old_name = _safe_index_name(k, suffix)
await self.execute(f"DROP INDEX IF EXISTS {old_name}")
alter_sql = f"ALTER TABLE {k} ALTER COLUMN content_vector TYPE {column_type}({embedding_dim})"
await self.execute(alter_sql)
logger.debug(f"Ensured vector dimension for {k}")
logger.info(
f"Creating {self.vector_index_type} index {vector_index_name} on table {k}"
)
await self.execute(
create_sql[self.vector_index_type].format(
vector_index_name=vector_index_name, table_name=k
)
)
logger.info(
f"Successfully created vector index {vector_index_name} on table {k}"
)
else:
logger.info(
f"{self.vector_index_type} vector index {vector_index_name} already exists on table {k}"
)
except Exception as e:
logger.error(f"Failed to create vector index on table {k}, Got: {e}")
async def query(
self,
sql: str,
params: list[Any] | None = None,
multirows: bool = False,
with_age: bool = False,
graph_name: str | None = None,
timing_label: str | None = None,
) -> dict[str, Any] | None | list[dict[str, Any]]:
async def _operation(connection: asyncpg.Connection) -> Any:
prepared_params = tuple(params) if params else ()
fetch_start = time.perf_counter()
if prepared_params:
rows = await connection.fetch(sql, *prepared_params)
else:
rows = await connection.fetch(sql)
fetch_elapsed = time.perf_counter() - fetch_start
if timing_label:
performance_timing_log(
"[%s] connection.fetch completed in %.4fs row_count=%s",
timing_label,
fetch_elapsed,
len(rows),
)
conversion_start = time.perf_counter()
if multirows:
if rows:
columns = [col for col in rows[0].keys()]
converted_rows = [dict(zip(columns, row)) for row in rows]
else:
converted_rows = []
if timing_label:
conversion_elapsed = time.perf_counter() - conversion_start
performance_timing_log(
"[%s] result conversion completed in %.4fs multirows=%s",
timing_label,
conversion_elapsed,
True,
)
return converted_rows
if rows:
columns = rows[0].keys()
converted_row = dict(zip(columns, rows[0]))
else:
converted_row = None
if timing_label:
conversion_elapsed = time.perf_counter() - conversion_start
performance_timing_log(
"[%s] result conversion completed in %.4fs multirows=%s",
timing_label,
conversion_elapsed,
False,
)
if converted_row is not None:
return converted_row
return None
try:
return await self._run_with_retry(
_operation,
with_age=with_age,
graph_name=graph_name,
timing_label=timing_label,
)
except Exception as e:
logger.error(f"PostgreSQL database, error:{e}")
raise
async def check_table_exists(self, table_name: str) -> bool:
"""Check if a table exists in PostgreSQL database
Args:
table_name: Name of the table to check
Returns:
bool: True if table exists, False otherwise
"""
query = """
SELECT EXISTS (
SELECT FROM information_schema.tables
WHERE table_name = $1
)
"""
result = await self.query(query, [table_name.lower()])
return result.get("exists", False) if result else False
async def execute(
self,
sql: str,
data: dict[str, Any] | None = None,
upsert: bool = False,
ignore_if_exists: bool = False,
with_age: bool = False,
graph_name: str | None = None,
timing_label: str | None = None,
):
async def _operation(connection: asyncpg.Connection) -> Any:
prepared_values = tuple(data.values()) if data else ()
execute_start = time.perf_counter()
try:
if not data:
result = await connection.execute(sql)
else:
result = await connection.execute(sql, *prepared_values)
except (
asyncpg.exceptions.UniqueViolationError,
asyncpg.exceptions.DuplicateTableError,
asyncpg.exceptions.DuplicateObjectError,
asyncpg.exceptions.InvalidSchemaNameError,
) as e:
if ignore_if_exists:
logger.debug("PostgreSQL, ignoring duplicate during execute: %r", e)
result = None
elif upsert:
logger.info(
"PostgreSQL, duplicate detected but treated as upsert success: %r",
e,
)
result = None
else:
raise
except Exception:
if timing_label:
performance_timing_log(
"[%s] connection.execute failed after %.4fs",
timing_label,
time.perf_counter() - execute_start,
)
raise
if timing_label:
performance_timing_log(
"[%s] connection.execute completed in %.4fs result=%s",
timing_label,
time.perf_counter() - execute_start,
result,
)
return result
try:
await self._run_with_retry(
_operation,
with_age=with_age,
graph_name=graph_name,
timing_label=timing_label,
)
except Exception as e:
logger.error(f"PostgreSQL database,\nsql:{sql},\ndata:{data},\nerror:{e}")
raise
class ClientManager:
_instances: dict[str, Any] = {"db": None, "ref_count": 0}
_lock = asyncio.Lock()
@staticmethod
def get_config() -> dict[str, Any]:
config = configparser.ConfigParser()
config.read("config.ini", "utf-8")
return {
"host": os.environ.get(
"POSTGRES_HOST",
config.get("postgres", "host", fallback="localhost"),
),
"port": os.environ.get(
"POSTGRES_PORT", config.get("postgres", "port", fallback=5432)
),
"user": os.environ.get(
"POSTGRES_USER", config.get("postgres", "user", fallback="postgres")
),
"password": os.environ.get(
"POSTGRES_PASSWORD",
config.get("postgres", "password", fallback=None),
),
"database": os.environ.get(
"POSTGRES_DATABASE",
config.get("postgres", "database", fallback="postgres"),
),
"workspace": os.environ.get(
"POSTGRES_WORKSPACE",
config.get("postgres", "workspace", fallback=None),
),
"max_connections": os.environ.get(
"POSTGRES_MAX_CONNECTIONS",
config.get("postgres", "max_connections", fallback=50),
),
# SSL configuration
"ssl_mode": os.environ.get(
"POSTGRES_SSL_MODE",
config.get("postgres", "ssl_mode", fallback=None),
),
"ssl_cert": os.environ.get(
"POSTGRES_SSL_CERT",
config.get("postgres", "ssl_cert", fallback=None),
),
"ssl_key": os.environ.get(
"POSTGRES_SSL_KEY",
config.get("postgres", "ssl_key", fallback=None),
),
"ssl_root_cert": os.environ.get(
"POSTGRES_SSL_ROOT_CERT",
config.get("postgres", "ssl_root_cert", fallback=None),
),
"ssl_crl": os.environ.get(
"POSTGRES_SSL_CRL",
config.get("postgres", "ssl_crl", fallback=None),
),
# Vector configuration
"enable_vector": os.environ.get(
"POSTGRES_ENABLE_VECTOR",
config.get("postgres", "enable_vector", fallback="true"),
).lower()
in ("true", "1", "yes", "on"),
"vector_index_type": os.environ.get(
"POSTGRES_VECTOR_INDEX_TYPE",
config.get("postgres", "vector_index_type", fallback="HNSW"),
),
"hnsw_m": int(
os.environ.get(
"POSTGRES_HNSW_M",
config.get("postgres", "hnsw_m", fallback="16"),
)
),
"hnsw_ef": int(
os.environ.get(
"POSTGRES_HNSW_EF",
config.get("postgres", "hnsw_ef", fallback="64"),
)
),
"ivfflat_lists": int(
os.environ.get(
"POSTGRES_IVFFLAT_LISTS",
config.get("postgres", "ivfflat_lists", fallback="100"),
)
),
"vchordrq_build_options": os.environ.get(
"POSTGRES_VCHORDRQ_BUILD_OPTIONS",
config.get("postgres", "vchordrq_build_options", fallback=""),
),
"vchordrq_probes": os.environ.get(
"POSTGRES_VCHORDRQ_PROBES",
config.get("postgres", "vchordrq_probes", fallback=""),
),
"vchordrq_epsilon": float(
os.environ.get(
"POSTGRES_VCHORDRQ_EPSILON",
config.get("postgres", "vchordrq_epsilon", fallback="1.9"),
)
),
# Server settings for Supabase
"server_settings": os.environ.get(
"POSTGRES_SERVER_SETTINGS",
config.get("postgres", "server_options", fallback=None),
),
"statement_cache_size": os.environ.get(
"POSTGRES_STATEMENT_CACHE_SIZE",
config.get("postgres", "statement_cache_size", fallback=None),
),
# Connection retry configuration
"connection_retry_attempts": min(
100, # Increased from 10 to 100 for long-running operations
int(
os.environ.get(
"POSTGRES_CONNECTION_RETRIES",
config.get("postgres", "connection_retries", fallback=10),
)
),
),
"connection_retry_backoff": min(
300.0, # Increased from 5.0 to 300.0 (5 minutes) for PG switchover scenarios
float(
os.environ.get(
"POSTGRES_CONNECTION_RETRY_BACKOFF",
config.get(
"postgres", "connection_retry_backoff", fallback=3.0
),
)
),
),
"connection_retry_backoff_max": min(
600.0, # Increased from 60.0 to 600.0 (10 minutes) for PG switchover scenarios
float(
os.environ.get(
"POSTGRES_CONNECTION_RETRY_BACKOFF_MAX",
config.get(
"postgres",
"connection_retry_backoff_max",
fallback=30.0,
),
)
),
),
"pool_close_timeout": min(
30.0,
float(
os.environ.get(
"POSTGRES_POOL_CLOSE_TIMEOUT",
config.get("postgres", "pool_close_timeout", fallback=5.0),
)
),
),
}
@classmethod
async def get_client(cls) -> PostgreSQLDB:
async with cls._lock:
if cls._instances["db"] is None:
config = ClientManager.get_config()
db = PostgreSQLDB(config)
await db.initdb()
await db.check_tables()
cls._instances["db"] = db
cls._instances["ref_count"] = 0
cls._instances["ref_count"] += 1
return cls._instances["db"]
@classmethod
async def release_client(cls, db: PostgreSQLDB):
async with cls._lock:
if db is not None:
if db is cls._instances["db"]:
cls._instances["ref_count"] -= 1
if cls._instances["ref_count"] == 0:
if db.pool is not None:
await db.pool.close()
logger.info("Closed PostgreSQL database connection pool")
cls._instances["db"] = None
else:
if db.pool is not None:
await db.pool.close()
@final
@dataclass
class PGKVStorage(BaseKVStorage):
db: PostgreSQLDB = field(default=None)
def __post_init__(self):
self._max_batch_size = 200 # DB batch size, independent of embedding batch size
async def initialize(self):
async with get_data_init_lock():
if self.db is None:
self.db = await ClientManager.get_client()
# Implement workspace priority: PostgreSQLDB.workspace > self.workspace > "default"
if self.db.workspace:
# Use PostgreSQLDB's workspace (highest priority)
logger.info(
f"Using PG_WORKSPACE environment variable: '{self.db.workspace}' (overriding '{self.workspace}/{self.namespace}')"
)
self.workspace = self.db.workspace
elif hasattr(self, "workspace") and self.workspace:
# Use storage class's workspace (medium priority)
pass
else:
# Use "default" for compatibility (lowest priority)
self.workspace = "default"
async def finalize(self):
if self.db is not None:
await ClientManager.release_client(self.db)
self.db = None
################ QUERY METHODS ################
async def get_by_id(self, id: str) -> dict[str, Any] | None:
"""Get data by id."""
sql = SQL_TEMPLATES["get_by_id_" + self.namespace]
params = {"workspace": self.workspace, "id": id}
response = await self.db.query(sql, list(params.values()))
if response and is_namespace(self.namespace, NameSpace.KV_STORE_TEXT_CHUNKS):
# Parse llm_cache_list JSON string back to list
llm_cache_list = response.get("llm_cache_list", [])
if isinstance(llm_cache_list, str):
try:
llm_cache_list = json.loads(llm_cache_list)
except json.JSONDecodeError:
llm_cache_list = []
response["llm_cache_list"] = llm_cache_list
create_time = response.get("create_time", 0)
update_time = response.get("update_time", 0)
response["create_time"] = create_time
response["update_time"] = create_time if update_time == 0 else update_time
# Special handling for LLM cache to ensure compatibility with _get_cached_extraction_results
if response and is_namespace(
self.namespace, NameSpace.KV_STORE_LLM_RESPONSE_CACHE
):
create_time = response.get("create_time", 0)
update_time = response.get("update_time", 0)
# Parse queryparam JSON string back to dict
queryparam = response.get("queryparam")
if isinstance(queryparam, str):
try:
queryparam = json.loads(queryparam)
except json.JSONDecodeError:
queryparam = None
# Map field names for compatibility (mode field removed)
response = {
**response,
"return": response.get("return_value", ""),
"cache_type": response.get("cache_type"),
"original_prompt": response.get("original_prompt", ""),
"chunk_id": response.get("chunk_id"),
"queryparam": queryparam,
"create_time": create_time,
"update_time": create_time if update_time == 0 else update_time,
}
# Special handling for FULL_ENTITIES namespace
if response and is_namespace(self.namespace, NameSpace.KV_STORE_FULL_ENTITIES):
# Parse entity_names JSON string back to list
entity_names = response.get("entity_names", [])
if isinstance(entity_names, str):
try:
entity_names = json.loads(entity_names)
except json.JSONDecodeError:
entity_names = []
response["entity_names"] = entity_names
create_time = response.get("create_time", 0)
update_time = response.get("update_time", 0)
response["create_time"] = create_time
response["update_time"] = create_time if update_time == 0 else update_time
# Special handling for FULL_RELATIONS namespace
if response and is_namespace(self.namespace, NameSpace.KV_STORE_FULL_RELATIONS):
# Parse relation_pairs JSON string back to list
relation_pairs = response.get("relation_pairs", [])
if isinstance(relation_pairs, str):
try:
relation_pairs = json.loads(relation_pairs)
except json.JSONDecodeError:
relation_pairs = []
response["relation_pairs"] = relation_pairs
create_time = response.get("create_time", 0)
update_time = response.get("update_time", 0)
response["create_time"] = create_time
response["update_time"] = create_time if update_time == 0 else update_time
# Special handling for ENTITY_CHUNKS namespace
if response and is_namespace(self.namespace, NameSpace.KV_STORE_ENTITY_CHUNKS):
# Parse chunk_ids JSON string back to list
chunk_ids = response.get("chunk_ids", [])
if isinstance(chunk_ids, str):
try:
chunk_ids = json.loads(chunk_ids)
except json.JSONDecodeError:
chunk_ids = []
response["chunk_ids"] = chunk_ids
create_time = response.get("create_time", 0)
update_time = response.get("update_time", 0)
response["create_time"] = create_time
response["update_time"] = create_time if update_time == 0 else update_time
# Special handling for RELATION_CHUNKS namespace
if response and is_namespace(
self.namespace, NameSpace.KV_STORE_RELATION_CHUNKS
):
# Parse chunk_ids JSON string back to list
chunk_ids = response.get("chunk_ids", [])
if isinstance(chunk_ids, str):
try:
chunk_ids = json.loads(chunk_ids)
except json.JSONDecodeError:
chunk_ids = []
response["chunk_ids"] = chunk_ids
create_time = response.get("create_time", 0)
update_time = response.get("update_time", 0)
response["create_time"] = create_time
response["update_time"] = create_time if update_time == 0 else update_time
return response if response else None
# Query by id
async def get_by_ids(self, ids: list[str]) -> list[dict[str, Any]]:
"""Get data by ids"""
if not ids:
return []
sql = SQL_TEMPLATES["get_by_ids_" + self.namespace]
params = {"workspace": self.workspace, "ids": ids}
results = await self.db.query(sql, list(params.values()), multirows=True)
def _order_results(
rows: list[dict[str, Any]] | None,
) -> list[dict[str, Any] | None]:
"""Preserve the caller requested ordering for bulk id lookups."""
if not rows:
return [None for _ in ids]
id_map: dict[str, dict[str, Any]] = {}
for row in rows:
if row is None:
continue
row_id = row.get("id")
if row_id is not None:
id_map[str(row_id)] = row
ordered: list[dict[str, Any] | None] = []
for requested_id in ids:
ordered.append(id_map.get(str(requested_id)))
return ordered
if results and is_namespace(self.namespace, NameSpace.KV_STORE_TEXT_CHUNKS):
# Parse llm_cache_list JSON string back to list for each result
for result in results:
llm_cache_list = result.get("llm_cache_list", [])
if isinstance(llm_cache_list, str):
try:
llm_cache_list = json.loads(llm_cache_list)
except json.JSONDecodeError:
llm_cache_list = []
result["llm_cache_list"] = llm_cache_list
create_time = result.get("create_time", 0)
update_time = result.get("update_time", 0)
result["create_time"] = create_time
result["update_time"] = create_time if update_time == 0 else update_time
# Special handling for LLM cache to ensure compatibility with _get_cached_extraction_results
if results and is_namespace(
self.namespace, NameSpace.KV_STORE_LLM_RESPONSE_CACHE
):
processed_results = []
for row in results:
create_time = row.get("create_time", 0)
update_time = row.get("update_time", 0)
# Parse queryparam JSON string back to dict
queryparam = row.get("queryparam")
if isinstance(queryparam, str):
try:
queryparam = json.loads(queryparam)
except json.JSONDecodeError:
queryparam = None
# Map field names for compatibility (mode field removed)
processed_row = {
**row,
"return": row.get("return_value", ""),
"cache_type": row.get("cache_type"),
"original_prompt": row.get("original_prompt", ""),
"chunk_id": row.get("chunk_id"),
"queryparam": queryparam,
"create_time": create_time,
"update_time": create_time if update_time == 0 else update_time,
}
processed_results.append(processed_row)
return _order_results(processed_results)
# Special handling for FULL_ENTITIES namespace
if results and is_namespace(self.namespace, NameSpace.KV_STORE_FULL_ENTITIES):
for result in results:
# Parse entity_names JSON string back to list
entity_names = result.get("entity_names", [])
if isinstance(entity_names, str):
try:
entity_names = json.loads(entity_names)
except json.JSONDecodeError:
entity_names = []
result["entity_names"] = entity_names
create_time = result.get("create_time", 0)
update_time = result.get("update_time", 0)
result["create_time"] = create_time
result["update_time"] = create_time if update_time == 0 else update_time
# Special handling for FULL_RELATIONS namespace
if results and is_namespace(self.namespace, NameSpace.KV_STORE_FULL_RELATIONS):
for result in results:
# Parse relation_pairs JSON string back to list
relation_pairs = result.get("relation_pairs", [])
if isinstance(relation_pairs, str):
try:
relation_pairs = json.loads(relation_pairs)
except json.JSONDecodeError:
relation_pairs = []
result["relation_pairs"] = relation_pairs
create_time = result.get("create_time", 0)
update_time = result.get("update_time", 0)
result["create_time"] = create_time
result["update_time"] = create_time if update_time == 0 else update_time
# Special handling for ENTITY_CHUNKS namespace
if results and is_namespace(self.namespace, NameSpace.KV_STORE_ENTITY_CHUNKS):
for result in results:
# Parse chunk_ids JSON string back to list
chunk_ids = result.get("chunk_ids", [])
if isinstance(chunk_ids, str):
try:
chunk_ids = json.loads(chunk_ids)
except json.JSONDecodeError:
chunk_ids = []
result["chunk_ids"] = chunk_ids
create_time = result.get("create_time", 0)
update_time = result.get("update_time", 0)
result["create_time"] = create_time
result["update_time"] = create_time if update_time == 0 else update_time
# Special handling for RELATION_CHUNKS namespace
if results and is_namespace(self.namespace, NameSpace.KV_STORE_RELATION_CHUNKS):
for result in results:
# Parse chunk_ids JSON string back to list
chunk_ids = result.get("chunk_ids", [])
if isinstance(chunk_ids, str):
try:
chunk_ids = json.loads(chunk_ids)
except json.JSONDecodeError:
chunk_ids = []
result["chunk_ids"] = chunk_ids
create_time = result.get("create_time", 0)
update_time = result.get("update_time", 0)
result["create_time"] = create_time
result["update_time"] = create_time if update_time == 0 else update_time
return _order_results(results)
async def filter_keys(self, keys: set[str]) -> set[str]:
"""Filter out duplicated content"""
if not keys:
return set()
table_name = namespace_to_table_name(self.namespace)
sql = f"SELECT id FROM {table_name} WHERE workspace=$1 AND id = ANY($2)"
params = {"workspace": self.workspace, "ids": list(keys)}
try:
res = await self.db.query(sql, list(params.values()), multirows=True)
if res:
exist_keys = [key["id"] for key in res]
else:
exist_keys = []
new_keys = set([s for s in keys if s not in exist_keys])
return new_keys
except Exception as e:
logger.error(
f"[{self.workspace}] PostgreSQL database,\nsql:{sql},\nparams:{params},\nerror:{e}"
)
raise
################ INSERT METHODS ################
async def upsert(self, data: dict[str, dict[str, Any]]) -> None:
logger.debug(f"[{self.workspace}] Inserting {len(data)} to {self.namespace}")
if not data:
return
timing_label = f"{self.workspace} PGKVStorage.upsert[{self.namespace}]"
total_start = time.perf_counter()
performance_timing_log(
"[%s] start records=%s max_batch_size=%s",
timing_label,
len(data),
self._max_batch_size,
)
batch_values: list[tuple] = []
upsert_sql = ""
batch_values_build_start = time.perf_counter()
if is_namespace(self.namespace, NameSpace.KV_STORE_TEXT_CHUNKS):
upsert_sql = SQL_TEMPLATES["upsert_text_chunk"]
# Get current UTC time and convert to naive datetime for database storage
current_time = datetime.datetime.now(timezone.utc).replace(tzinfo=None)
for i, (k, v) in enumerate(data.items(), start=1):
# Tuple order must match SQL: (workspace, id, tokens, chunk_order_index,
# full_doc_id, content, file_path, llm_cache_list, create_time, update_time)
batch_values.append(
(
self.workspace,
k,
v["tokens"],
v["chunk_order_index"],
v["full_doc_id"],
v["content"],
v["file_path"],
json.dumps(v.get("llm_cache_list", [])),
current_time,
current_time,
)
)
await _cooperative_yield(i)
elif is_namespace(self.namespace, NameSpace.KV_STORE_FULL_DOCS):
upsert_sql = SQL_TEMPLATES["upsert_doc_full"]
for i, (k, v) in enumerate(data.items(), start=1):
# Tuple order must match SQL: (id, content, doc_name, workspace)
batch_values.append(
(k, v["content"], v.get("file_path", ""), self.workspace)
)
await _cooperative_yield(i)
elif is_namespace(self.namespace, NameSpace.KV_STORE_LLM_RESPONSE_CACHE):
upsert_sql = SQL_TEMPLATES["upsert_llm_response_cache"]
for i, (k, v) in enumerate(data.items(), start=1):
# Tuple order must match SQL: (workspace, id, original_prompt, return_value,
# chunk_id, cache_type, queryparam)
batch_values.append(
(
self.workspace,
k,
v["original_prompt"],
v["return"],
v.get("chunk_id"),
v.get("cache_type", "extract"),
json.dumps(v.get("queryparam"))
if v.get("queryparam")
else None,
)
)
await _cooperative_yield(i)
elif is_namespace(self.namespace, NameSpace.KV_STORE_FULL_ENTITIES):
upsert_sql = SQL_TEMPLATES["upsert_full_entities"]
# Get current UTC time and convert to naive datetime for database storage
current_time = datetime.datetime.now(timezone.utc).replace(tzinfo=None)
for i, (k, v) in enumerate(data.items(), start=1):
# Tuple order must match SQL: (workspace, id, entity_names, count,
# create_time, update_time)
batch_values.append(
(
self.workspace,
k,
json.dumps(v["entity_names"]),
v["count"],
current_time,
current_time,
)
)
await _cooperative_yield(i)
elif is_namespace(self.namespace, NameSpace.KV_STORE_FULL_RELATIONS):
upsert_sql = SQL_TEMPLATES["upsert_full_relations"]
# Get current UTC time and convert to naive datetime for database storage
current_time = datetime.datetime.now(timezone.utc).replace(tzinfo=None)
for i, (k, v) in enumerate(data.items(), start=1):
# Tuple order must match SQL: (workspace, id, relation_pairs, count,
# create_time, update_time)
batch_values.append(
(
self.workspace,
k,
json.dumps(v["relation_pairs"]),
v["count"],
current_time,
current_time,
)
)
await _cooperative_yield(i)
elif is_namespace(self.namespace, NameSpace.KV_STORE_ENTITY_CHUNKS):
upsert_sql = SQL_TEMPLATES["upsert_entity_chunks"]
# Get current UTC time and convert to naive datetime for database storage
current_time = datetime.datetime.now(timezone.utc).replace(tzinfo=None)
for i, (k, v) in enumerate(data.items(), start=1):
# Tuple order must match SQL: (workspace, id, chunk_ids, count,
# create_time, update_time)
batch_values.append(
(
self.workspace,
k,
json.dumps(v["chunk_ids"]),
v["count"],
current_time,
current_time,
)
)
await _cooperative_yield(i)
elif is_namespace(self.namespace, NameSpace.KV_STORE_RELATION_CHUNKS):
upsert_sql = SQL_TEMPLATES["upsert_relation_chunks"]
# Get current UTC time and convert to naive datetime for database storage
current_time = datetime.datetime.now(timezone.utc).replace(tzinfo=None)
for i, (k, v) in enumerate(data.items(), start=1):
# Tuple order must match SQL: (workspace, id, chunk_ids, count,
# create_time, update_time)
batch_values.append(
(
self.workspace,
k,
json.dumps(v["chunk_ids"]),
v["count"],
current_time,
current_time,
)
)
await _cooperative_yield(i)
else:
logger.error(f"Unknown namespace: {self.namespace}")
raise ValueError(f"Unknown namespace: {self.namespace}")
# upsert_sql is always set here; unknown namespace raises ValueError above
performance_timing_log(
"[%s] batch_values build completed in %.4fs records=%s%s",
timing_label,
time.perf_counter() - batch_values_build_start,
len(batch_values),
_timing_details_suffix(namespace=self.namespace),
)
if batch_values:
# Split into sub-batches to prevent database overload
num_batches = (
len(batch_values) + self._max_batch_size - 1
) // self._max_batch_size
for batch_index, i in enumerate(
range(0, len(batch_values), self._max_batch_size), start=1
):
sub_batch = batch_values[i : i + self._max_batch_size]
async def _batch_upsert(
connection: asyncpg.Connection,
_sql: str = upsert_sql,
_data: list[tuple] = sub_batch,
_batch_index: int = batch_index,
_num_batches: int = num_batches,
) -> None:
execute_start = time.perf_counter()
await connection.executemany(_sql, _data)
performance_timing_log(
"[%s] sub-batch %s/%s executemany completed in %.4fs batch_size=%s",
timing_label,
_batch_index,
_num_batches,
time.perf_counter() - execute_start,
len(_data),
)
await self.db._run_with_retry(_batch_upsert, timing_label=timing_label)
logger.debug(
f"[{self.workspace}] Batch upserted {len(batch_values)} records to {self.namespace} "
f"in {num_batches} sub-batches"
)
performance_timing_log(
"[%s] total complete in %.4fs records=%s",
timing_label,
time.perf_counter() - total_start,
len(batch_values),
)
async def index_done_callback(self) -> None:
# PG handles persistence automatically
pass
async def is_empty(self) -> bool:
"""Check if the storage is empty for the current workspace and namespace
Returns:
bool: True if storage is empty, False otherwise
"""
table_name = namespace_to_table_name(self.namespace)
if not table_name:
logger.error(
f"[{self.workspace}] Unknown namespace for is_empty check: {self.namespace}"
)
return True
sql = f"SELECT EXISTS(SELECT 1 FROM {table_name} WHERE workspace=$1 LIMIT 1) as has_data"
try:
result = await self.db.query(sql, [self.workspace])
return not result.get("has_data", False) if result else True
except Exception as e:
logger.error(f"[{self.workspace}] Error checking if storage is empty: {e}")
return True
async def delete(self, ids: list[str]) -> None:
"""Delete specific records from storage by their IDs
Args:
ids (list[str]): List of document IDs to be deleted from storage
Returns:
None
"""
if not ids:
return
table_name = namespace_to_table_name(self.namespace)
if not table_name:
logger.error(
f"[{self.workspace}] Unknown namespace for deletion: {self.namespace}"
)
return
delete_sql = f"DELETE FROM {table_name} WHERE workspace=$1 AND id = ANY($2)"
try:
await self.db.execute(delete_sql, {"workspace": self.workspace, "ids": ids})
logger.debug(
f"[{self.workspace}] Successfully deleted {len(ids)} records from {self.namespace}"
)
except Exception as e:
logger.error(
f"[{self.workspace}] Error while deleting records from {self.namespace}: {e}"
)
async def drop(self) -> dict[str, str]:
"""Drop the storage"""
try:
table_name = namespace_to_table_name(self.namespace)
if not table_name:
return {
"status": "error",
"message": f"Unknown namespace: {self.namespace}",
}
drop_sql = SQL_TEMPLATES["drop_specifiy_table_workspace"].format(
table_name=table_name
)
await self.db.execute(drop_sql, {"workspace": self.workspace})
return {"status": "success", "message": "data dropped"}
except Exception as e:
return {"status": "error", "message": str(e)}
@final
@dataclass
class PGVectorStorage(BaseVectorStorage):
db: PostgreSQLDB | None = field(default=None)
def __post_init__(self):
self._validate_embedding_func()
self._max_batch_size = self.global_config["embedding_batch_num"]
config = self.global_config.get("vector_db_storage_cls_kwargs", {})
cosine_threshold = config.get("cosine_better_than_threshold")
if cosine_threshold is None:
raise ValueError(
"cosine_better_than_threshold must be specified in vector_db_storage_cls_kwargs"
)
self.cosine_better_than_threshold = cosine_threshold
# Generate model suffix for table isolation
self.model_suffix = self._generate_collection_suffix()
# Get base table name
base_table = namespace_to_table_name(self.namespace)
if not base_table:
raise ValueError(f"Unknown namespace: {self.namespace}")
# New table name (with suffix)
# Ensure model_suffix is not empty before appending
if self.model_suffix:
self.table_name = f"{base_table}_{self.model_suffix}"
logger.info(f"PostgreSQL table: {self.table_name}")
else:
# Fallback: use base table name if model_suffix is unavailable
self.table_name = base_table
logger.warning(
f"PostgreSQL table: {self.table_name} missing suffix. Pls add model_name to embedding_func for proper workspace data isolation."
)
# Legacy table name (without suffix, for migration)
self.legacy_table_name = base_table
# Validate table name length (PostgreSQL identifier limit is 63 characters)
if len(self.table_name) > PG_MAX_IDENTIFIER_LENGTH:
raise ValueError(
f"PostgreSQL table name exceeds {PG_MAX_IDENTIFIER_LENGTH} character limit: '{self.table_name}' "
f"(length: {len(self.table_name)}). "
f"Consider using a shorter embedding model name or workspace name."
)
@staticmethod
async def _pg_create_table(
db: PostgreSQLDB, table_name: str, base_table: str, embedding_dim: int
) -> None:
"""Create a new vector table by replacing the table name in DDL template,
and create indexes on id and (workspace, id) columns.
Args:
db: PostgreSQLDB instance
table_name: Name of the new table to create
base_table: Base table name for DDL template lookup
embedding_dim: Embedding dimension for vector column
"""
if base_table not in TABLES:
raise ValueError(f"No DDL template found for table: {base_table}")
ddl_template = TABLES[base_table]["ddl"]
# Determine vector column type based on configuration
# HALFVEC is used when HNSW_HALFVEC is selected
vector_type = "VECTOR"
if getattr(db, "vector_index_type", None) == "HNSW_HALFVEC":
vector_type = "HALFVEC"
# Replace embedding dimension placeholder if exists
ddl = ddl_template.replace(
"VECTOR(dimension)", f"{vector_type}({embedding_dim})"
)
# Replace table name
ddl = ddl.replace(base_table, table_name)
# Make creation idempotent to handle restarts and race conditions
ddl = ddl.replace("CREATE TABLE ", "CREATE TABLE IF NOT EXISTS ", 1)
await db.execute(ddl)
# Create indexes similar to check_tables() but with safe index names
# Create index for id column
id_index_name = _safe_index_name(table_name, "id")
try:
create_id_index_sql = (
f"CREATE INDEX IF NOT EXISTS {id_index_name} ON {table_name}(id)"
)
logger.info(
f"PostgreSQL, Creating index {id_index_name} on table {table_name}"
)
await db.execute(create_id_index_sql)
except Exception as e:
logger.error(
f"PostgreSQL, Failed to create index {id_index_name}, Got: {e}"
)
# Create composite index for (workspace, id)
workspace_id_index_name = _safe_index_name(table_name, "workspace_id")
try:
create_composite_index_sql = f"CREATE INDEX IF NOT EXISTS {workspace_id_index_name} ON {table_name}(workspace, id)"
logger.info(
f"PostgreSQL, Creating composite index {workspace_id_index_name} on table {table_name}"
)
await db.execute(create_composite_index_sql)
except Exception as e:
logger.error(
f"PostgreSQL, Failed to create composite index {workspace_id_index_name}, Got: {e}"
)
@staticmethod
async def _pg_migrate_workspace_data(
db: PostgreSQLDB,
legacy_table_name: str,
new_table_name: str,
workspace: str,
expected_count: int,
embedding_dim: int,
) -> int:
"""Migrate workspace data from legacy table to new table using batch insert.
This function uses asyncpg's executemany for efficient batch insertion,
reducing database round-trips from N to 1 per batch.
Uses keyset pagination (cursor-based) with ORDER BY id for stable ordering.
This ensures every legacy row is migrated exactly once, avoiding the
non-deterministic row ordering issues with OFFSET/LIMIT without ORDER BY.
Args:
db: PostgreSQLDB instance
legacy_table_name: Name of the legacy table to migrate from
new_table_name: Name of the new table to migrate to
workspace: Workspace to filter records for migration
expected_count: Expected number of records to migrate
embedding_dim: Embedding dimension for vector column
Returns:
Number of records migrated
"""
migrated_count = 0
last_id: str | None = None
batch_size = 500
while True:
# Use keyset pagination with ORDER BY id for deterministic ordering
# This avoids OFFSET/LIMIT without ORDER BY which can skip or duplicate rows
if workspace:
if last_id is not None:
select_query = f"SELECT * FROM {legacy_table_name} WHERE workspace = $1 AND id > $2 ORDER BY id LIMIT $3"
rows = await db.query(
select_query, [workspace, last_id, batch_size], multirows=True
)
else:
select_query = f"SELECT * FROM {legacy_table_name} WHERE workspace = $1 ORDER BY id LIMIT $2"
rows = await db.query(
select_query, [workspace, batch_size], multirows=True
)
else:
if last_id is not None:
select_query = f"SELECT * FROM {legacy_table_name} WHERE id > $1 ORDER BY id LIMIT $2"
rows = await db.query(
select_query, [last_id, batch_size], multirows=True
)
else:
select_query = (
f"SELECT * FROM {legacy_table_name} ORDER BY id LIMIT $1"
)
rows = await db.query(select_query, [batch_size], multirows=True)
if not rows:
break
# Track the last ID for keyset pagination cursor
last_id = rows[-1]["id"]
# Batch insert optimization: use executemany instead of individual inserts
# Get column names from the first row
first_row = dict(rows[0])
columns = list(first_row.keys())
columns_str = ", ".join(columns)
placeholders = ", ".join([f"${i + 1}" for i in range(len(columns))])
insert_query = f"""
INSERT INTO {new_table_name} ({columns_str})
VALUES ({placeholders})
ON CONFLICT (workspace, id) DO NOTHING
"""
# Prepare batch data: convert rows to list of tuples
batch_values = []
for row in rows:
row_dict = dict(row)
# FIX: Parse vector strings from connections without register_vector codec.
# When pgvector codec is not registered on the read connection, vector
# columns are returned as text strings like "[0.1,0.2,...]" instead of
# lists/arrays. We need to convert these to numpy arrays before passing
# to executemany, which uses a connection WITH register_vector codec
# that expects list/tuple/ndarray types.
if "content_vector" in row_dict:
vec = row_dict["content_vector"]
if isinstance(vec, str):
# pgvector text format: "[0.1,0.2,0.3,...]"
vec = vec.strip("[]")
if vec:
row_dict["content_vector"] = np.array(
[float(x) for x in vec.split(",")], dtype=np.float32
)
else:
row_dict["content_vector"] = None
# Extract values in column order to match placeholders
values_tuple = tuple(row_dict[col] for col in columns)
batch_values.append(values_tuple)
# Use executemany for batch execution - significantly reduces DB round-trips
# Note: register_vector is already called on pool init, no need to call it again
async def _batch_insert(connection: asyncpg.Connection) -> None:
await connection.executemany(insert_query, batch_values)
await db._run_with_retry(_batch_insert)
migrated_count += len(rows)
workspace_info = f" for workspace '{workspace}'" if workspace else ""
logger.info(
f"PostgreSQL: {migrated_count}/{expected_count} records migrated{workspace_info}"
)
return migrated_count
@staticmethod
async def setup_table(
db: PostgreSQLDB,
table_name: str,
workspace: str,
embedding_dim: int,
legacy_table_name: str,
base_table: str,
):
"""
Setup PostgreSQL table with migration support from legacy tables.
Ensure final table has workspace isolation index.
Check vector dimension compatibility before new table creation.
Drop legacy table if it exists and is empty.
Only migrate data from legacy table to new table when new table first created and legacy table is not empty.
This function must be call ClientManager.get_client() to legacy table is migrated to latest schema.
Args:
db: PostgreSQLDB instance
table_name: Name of the new table
workspace: Workspace to filter records for migration
legacy_table_name: Name of the legacy table to check for migration
base_table: Base table name for DDL template lookup
embedding_dim: Embedding dimension for vector column
"""
if not workspace:
raise ValueError("workspace must be provided")
new_table_exists = await db.check_table_exists(table_name)
legacy_exists = legacy_table_name and await db.check_table_exists(
legacy_table_name
)
# Case 1: Only new table exists or new table is the same as legacy table
# No data migration needed, ensuring index is created then return
if (new_table_exists and not legacy_exists) or (
new_table_exists and (table_name.lower() == legacy_table_name.lower())
):
await db._create_vector_index(table_name, embedding_dim)
workspace_count_query = (
f"SELECT COUNT(*) as count FROM {table_name} WHERE workspace = $1"
)
workspace_count_result = await db.query(workspace_count_query, [workspace])
workspace_count = (
workspace_count_result.get("count", 0) if workspace_count_result else 0
)
if workspace_count == 0 and not (
table_name.lower() == legacy_table_name.lower()
):
logger.warning(
f"PostgreSQL: workspace data in table '{table_name}' is empty. "
f"Ensure it is caused by new workspace setup and not an unexpected embedding model change."
)
return
legacy_count = None
if not new_table_exists:
# Check vector dimension compatibility before creating new table
if legacy_exists:
count_query = f"SELECT COUNT(*) as count FROM {legacy_table_name} WHERE workspace = $1"
count_result = await db.query(count_query, [workspace])
legacy_count = count_result.get("count", 0) if count_result else 0
if legacy_count > 0:
legacy_dim = None
try:
sample_query = f"SELECT content_vector FROM {legacy_table_name} WHERE workspace = $1 LIMIT 1"
sample_result = await db.query(sample_query, [workspace])
# Fix: Use 'is not None' instead of truthiness check to avoid
# NumPy array boolean ambiguity error
if (
sample_result
and sample_result.get("content_vector") is not None
):
vector_data = sample_result["content_vector"]
# pgvector returns list directly, but may also return NumPy arrays
# when register_vector codec is active on the connection
if isinstance(vector_data, (list, tuple)):
legacy_dim = len(vector_data)
elif hasattr(vector_data, "__len__") and not isinstance(
vector_data, str
):
# Handle NumPy arrays and other array-like objects
legacy_dim = len(vector_data)
elif hasattr(vector_data, "dimensions") and callable(
vector_data.dimensions
):
# pgvector HalfVector / SparseVector expose dimensions()
legacy_dim = vector_data.dimensions()
elif isinstance(vector_data, str):
import json
vector_list = json.loads(vector_data)
legacy_dim = len(vector_list)
if legacy_dim and legacy_dim != embedding_dim:
logger.error(
f"PostgreSQL: Dimension mismatch detected! "
f"Legacy table '{legacy_table_name}' has {legacy_dim}d vectors, "
f"but new embedding model expects {embedding_dim}d."
)
raise DataMigrationError(
f"Dimension mismatch between legacy table '{legacy_table_name}' "
f"and new embedding model. Expected {embedding_dim}d but got {legacy_dim}d."
)
except DataMigrationError:
# Re-raise DataMigrationError as-is to preserve specific error messages
raise
except Exception as e:
raise DataMigrationError(
f"Could not verify legacy table vector dimension: {e}. "
f"Proceeding with caution..."
)
await PGVectorStorage._pg_create_table(
db, table_name, base_table, embedding_dim
)
logger.info(f"PostgreSQL: New table '{table_name}' created successfully")
if not legacy_exists:
await db._create_vector_index(table_name, embedding_dim)
logger.info(
"Ensure this new table creation is caused by new workspace setup and not an unexpected embedding model change."
)
return
# Ensure vector index is created
await db._create_vector_index(table_name, embedding_dim)
# Case 2: Legacy table exist
if legacy_exists:
workspace_info = f" for workspace '{workspace}'"
# Only drop legacy table if entire table is empty
total_count_query = f"SELECT COUNT(*) as count FROM {legacy_table_name}"
total_count_result = await db.query(total_count_query, [])
total_count = (
total_count_result.get("count", 0) if total_count_result else 0
)
if total_count == 0:
logger.info(
f"PostgreSQL: Empty legacy table '{legacy_table_name}' deleted successfully"
)
drop_query = f"DROP TABLE {legacy_table_name}"
await db.execute(drop_query, None)
return
# No data migration needed if legacy workspace is empty
if legacy_count is None:
count_query = f"SELECT COUNT(*) as count FROM {legacy_table_name} WHERE workspace = $1"
count_result = await db.query(count_query, [workspace])
legacy_count = count_result.get("count", 0) if count_result else 0
if legacy_count == 0:
logger.info(
f"PostgreSQL: No records{workspace_info} found in legacy table. "
f"No data migration needed."
)
return
new_count_query = (
f"SELECT COUNT(*) as count FROM {table_name} WHERE workspace = $1"
)
new_count_result = await db.query(new_count_query, [workspace])
new_table_workspace_count = (
new_count_result.get("count", 0) if new_count_result else 0
)
if new_table_workspace_count > 0:
logger.warning(
f"PostgreSQL: Both new and legacy collection have data. "
f"{legacy_count} records in {legacy_table_name} require manual deletion after migration verification."
)
return
# Case 3: Legacy has workspace data and new table is empty for workspace
logger.info(
f"PostgreSQL: Found legacy table '{legacy_table_name}' with {legacy_count} records{workspace_info}."
)
logger.info(
f"PostgreSQL: Migrating data from legacy table '{legacy_table_name}' to new table '{table_name}'"
)
try:
migrated_count = await PGVectorStorage._pg_migrate_workspace_data(
db,
legacy_table_name,
table_name,
workspace,
legacy_count,
embedding_dim,
)
if migrated_count != legacy_count:
logger.warning(
"PostgreSQL: Read %s legacy records%s during migration, expected %s.",
migrated_count,
workspace_info,
legacy_count,
)
new_count_result = await db.query(new_count_query, [workspace])
new_table_count_after = (
new_count_result.get("count", 0) if new_count_result else 0
)
inserted_count = new_table_count_after - new_table_workspace_count
if inserted_count != legacy_count:
error_msg = (
"PostgreSQL: Migration verification failed, "
f"expected {legacy_count} inserted records, got {inserted_count}."
)
logger.error(error_msg)
raise DataMigrationError(error_msg)
except DataMigrationError:
# Re-raise DataMigrationError as-is to preserve specific error messages
raise
except Exception as e:
logger.error(
f"PostgreSQL: Failed to migrate data from legacy table '{legacy_table_name}' to new table '{table_name}': {e}"
)
raise DataMigrationError(
f"Failed to migrate data from legacy table '{legacy_table_name}' to new table '{table_name}'"
) from e
logger.info(
f"PostgreSQL: Migration from '{legacy_table_name}' to '{table_name}' completed successfully"
)
logger.warning(
"PostgreSQL: Manual deletion is required after data migration verification."
)
async def initialize(self):
async with get_data_init_lock():
if self.db is None:
self.db = await ClientManager.get_client()
# Implement workspace priority: PostgreSQLDB.workspace > self.workspace > "default"
if self.db.workspace:
# Use PostgreSQLDB's workspace (highest priority)
logger.info(
f"Using PG_WORKSPACE environment variable: '{self.db.workspace}' (overriding '{self.workspace}/{self.namespace}')"
)
self.workspace = self.db.workspace
elif hasattr(self, "workspace") and self.workspace:
# Use storage class's workspace (medium priority)
pass
else:
# Use "default" for compatibility (lowest priority)
self.workspace = "default"
if not self.db.enable_vector:
raise ValueError(
"Cannot use PGVectorStorage when POSTGRES_ENABLE_VECTOR=false. Configure an alternative vector backend."
)
# Setup table (create if not exists and handle migration)
await PGVectorStorage.setup_table(
self.db,
self.table_name,
self.workspace, # CRITICAL: Filter migration by workspace
embedding_dim=self.embedding_func.embedding_dim,
legacy_table_name=self.legacy_table_name,
base_table=self.legacy_table_name, # base_table for DDL template lookup
)
async def finalize(self):
if self.db is not None:
await ClientManager.release_client(self.db)
self.db = None
def _upsert_chunks(
self, item: dict[str, Any], current_time: datetime.datetime
) -> tuple[str, tuple[Any, ...]]:
"""Prepare upsert data for chunks.
Returns:
Tuple of (SQL template, values tuple for executemany)
"""
try:
upsert_sql = SQL_TEMPLATES["upsert_chunk"].format(
table_name=self.table_name
)
# Return tuple in the exact order of SQL parameters ($1, $2, ...)
values: tuple[Any, ...] = (
self.workspace, # $1
item["__id__"], # $2
item["tokens"], # $3
item["chunk_order_index"], # $4
item["full_doc_id"], # $5
item["content"], # $6
item["__vector__"], # $7 - numpy array, handled by pgvector codec
item["file_path"], # $8
current_time, # $9
current_time, # $10
)
except Exception as e:
logger.error(
f"[{self.workspace}] Error to prepare upsert,\nerror: {e}\nitem: {item}"
)
raise
return upsert_sql, values
def _upsert_entities(
self, item: dict[str, Any], current_time: datetime.datetime
) -> tuple[str, tuple[Any, ...]]:
"""Prepare upsert data for entities.
Returns:
Tuple of (SQL template, values tuple for executemany)
"""
upsert_sql = SQL_TEMPLATES["upsert_entity"].format(table_name=self.table_name)
source_id = item["source_id"]
if isinstance(source_id, str) and "<SEP>" in source_id:
chunk_ids = source_id.split("<SEP>")
else:
chunk_ids = [source_id]
# Return tuple in the exact order of SQL parameters ($1, $2, ...)
values: tuple[Any, ...] = (
self.workspace, # $1
item["__id__"], # $2
item["entity_name"], # $3
item["content"], # $4
item["__vector__"], # $5 - numpy array, handled by pgvector codec
chunk_ids, # $6
item.get("file_path", None), # $7
current_time, # $8
current_time, # $9
)
return upsert_sql, values
def _upsert_relationships(
self, item: dict[str, Any], current_time: datetime.datetime
) -> tuple[str, tuple[Any, ...]]:
"""Prepare upsert data for relationships.
Returns:
Tuple of (SQL template, values tuple for executemany)
"""
upsert_sql = SQL_TEMPLATES["upsert_relationship"].format(
table_name=self.table_name
)
source_id = item["source_id"]
if isinstance(source_id, str) and "<SEP>" in source_id:
chunk_ids = source_id.split("<SEP>")
else:
chunk_ids = [source_id]
# Return tuple in the exact order of SQL parameters ($1, $2, ...)
values: tuple[Any, ...] = (
self.workspace, # $1
item["__id__"], # $2
item["src_id"], # $3
item["tgt_id"], # $4
item["content"], # $5
item["__vector__"], # $6 - numpy array, handled by pgvector codec
chunk_ids, # $7
item.get("file_path", None), # $8
current_time, # $9
current_time, # $10
)
return upsert_sql, values
async def upsert(self, data: dict[str, dict[str, Any]]) -> None:
logger.debug(f"[{self.workspace}] Inserting {len(data)} to {self.namespace}")
if not data:
return
timing_label = f"{self.workspace} PGVectorStorage.upsert[{self.namespace}]"
total_start = time.perf_counter()
performance_timing_log(
"[%s] start records=%s max_batch_size=%s",
timing_label,
len(data),
self._max_batch_size,
)
# Get current UTC time and convert to naive datetime for database storage
current_time = datetime.datetime.now(timezone.utc).replace(tzinfo=None)
list_data = []
list_data_build_start = time.perf_counter()
for i, (k, v) in enumerate(data.items(), start=1):
list_data.append(
{
"__id__": k,
**{k1: v1 for k1, v1 in v.items()},
}
)
await _cooperative_yield(i)
performance_timing_log(
"[%s] list_data build completed in %.4fs records=%s",
timing_label,
time.perf_counter() - list_data_build_start,
len(list_data),
)
contents = [v["content"] for v in data.values()]
embedding_split_start = time.perf_counter()
batches = [
contents[i : i + self._max_batch_size]
for i in range(0, len(contents), self._max_batch_size)
]
performance_timing_log(
"[%s] embedding batch split completed in %.4fs batches=%s",
timing_label,
time.perf_counter() - embedding_split_start,
len(batches),
)
embedding_tasks = [self.embedding_func(batch) for batch in batches]
embedding_generation_start = time.perf_counter()
embeddings_list = await asyncio.gather(*embedding_tasks)
performance_timing_log(
"[%s] embedding generation completed in %.4fs batches=%s",
timing_label,
time.perf_counter() - embedding_generation_start,
len(embeddings_list),
)
embeddings = np.concatenate(embeddings_list)
assert len(embeddings) == len(
list_data
), f"Embedding count mismatch: expected {len(list_data)}, got {len(embeddings)}"
embedding_fill_start = time.perf_counter()
for i, d in enumerate(list_data, start=1):
d["__vector__"] = embeddings[i - 1]
await _cooperative_yield(i)
performance_timing_log(
"[%s] vector backfill completed in %.4fs records=%s",
timing_label,
time.perf_counter() - embedding_fill_start,
len(list_data),
)
# Prepare batch values for executemany
batch_values: list[tuple[Any, ...]] = []
upsert_sql = None
tuple_build_start = time.perf_counter()
for i, item in enumerate(list_data, start=1):
if is_namespace(self.namespace, NameSpace.VECTOR_STORE_CHUNKS):
upsert_sql, values = self._upsert_chunks(item, current_time)
elif is_namespace(self.namespace, NameSpace.VECTOR_STORE_ENTITIES):
upsert_sql, values = self._upsert_entities(item, current_time)
elif is_namespace(self.namespace, NameSpace.VECTOR_STORE_RELATIONSHIPS):
upsert_sql, values = self._upsert_relationships(item, current_time)
else:
raise ValueError(f"{self.namespace} is not supported")
batch_values.append(values)
await _cooperative_yield(i)
performance_timing_log(
"[%s] upsert tuple build completed in %.4fs records=%s",
timing_label,
time.perf_counter() - tuple_build_start,
len(batch_values),
)
# Use executemany for batch execution - significantly reduces DB round-trips
# Note: register_vector is already called on pool init, no need to call it again
if batch_values and upsert_sql:
async def _batch_upsert(connection: asyncpg.Connection) -> None:
execute_start = time.perf_counter()
await connection.executemany(upsert_sql, batch_values)
performance_timing_log(
"[%s] executemany completed in %.4fs batch_size=%s",
timing_label,
time.perf_counter() - execute_start,
len(batch_values),
)
await self.db._run_with_retry(_batch_upsert, timing_label=timing_label)
logger.debug(
f"[{self.workspace}] Batch upserted {len(batch_values)} records to {self.namespace}"
)
performance_timing_log(
"[%s] total complete in %.4fs records=%s",
timing_label,
time.perf_counter() - total_start,
len(data),
)
#################### query method ###############
async def query(
self, query: str, top_k: int, query_embedding: list[float] = None
) -> list[dict[str, Any]]:
if query_embedding is not None:
embedding = query_embedding
else:
embeddings = await self.embedding_func(
[query], _priority=5
) # higher priority for query
embedding = embeddings[0]
embedding_string = ",".join(map(str, embedding))
vector_cast = (
"halfvec"
if getattr(self.db, "vector_index_type", None) == "HNSW_HALFVEC"
else "vector"
)
sql = SQL_TEMPLATES[self.namespace].format(
embedding_string=embedding_string,
table_name=self.table_name,
vector_cast=vector_cast,
)
params = {
"workspace": self.workspace,
"closer_than_threshold": 1 - self.cosine_better_than_threshold,
"top_k": top_k,
}
results = await self.db.query(sql, params=list(params.values()), multirows=True)
return results
async def index_done_callback(self) -> None:
# PG handles persistence automatically
pass
async def delete(self, ids: list[str]) -> None:
"""Delete vectors with specified IDs from the storage.
Args:
ids: List of vector IDs to be deleted
"""
if not ids:
return
delete_sql = (
f"DELETE FROM {self.table_name} WHERE workspace=$1 AND id = ANY($2)"
)
try:
await self.db.execute(delete_sql, {"workspace": self.workspace, "ids": ids})
logger.debug(
f"[{self.workspace}] Successfully deleted {len(ids)} vectors from {self.namespace}"
)
except Exception as e:
logger.error(
f"[{self.workspace}] Error while deleting vectors from {self.namespace}: {e}"
)
async def delete_entity(self, entity_name: str) -> None:
"""Delete an entity by its name from the vector storage.
Args:
entity_name: The name of the entity to delete
"""
try:
# Construct SQL to delete the entity using dynamic table name
delete_sql = f"""DELETE FROM {self.table_name}
WHERE workspace=$1 AND entity_name=$2"""
await self.db.execute(
delete_sql, {"workspace": self.workspace, "entity_name": entity_name}
)
logger.debug(
f"[{self.workspace}] Successfully deleted entity {entity_name}"
)
except Exception as e:
logger.error(f"[{self.workspace}] Error deleting entity {entity_name}: {e}")
async def delete_entity_relation(self, entity_name: str) -> None:
"""Delete all relations associated with an entity.
Args:
entity_name: The name of the entity whose relations should be deleted
"""
try:
# Delete relations where the entity is either the source or target
delete_sql = f"""DELETE FROM {self.table_name}
WHERE workspace=$1 AND (source_id=$2 OR target_id=$2)"""
await self.db.execute(
delete_sql, {"workspace": self.workspace, "entity_name": entity_name}
)
logger.debug(
f"[{self.workspace}] Successfully deleted relations for entity {entity_name}"
)
except Exception as e:
logger.error(
f"[{self.workspace}] Error deleting relations for entity {entity_name}: {e}"
)
async def get_by_id(self, id: str) -> dict[str, Any] | None:
"""Get vector data by its ID
Args:
id: The unique identifier of the vector
Returns:
The vector data if found, or None if not found
"""
query = f"SELECT *, EXTRACT(EPOCH FROM create_time)::BIGINT as created_at FROM {self.table_name} WHERE workspace=$1 AND id=$2"
params = {"workspace": self.workspace, "id": id}
try:
result = await self.db.query(query, list(params.values()))
if result:
return dict(result)
return None
except Exception as e:
logger.error(
f"[{self.workspace}] Error retrieving vector data for ID {id}: {e}"
)
return None
async def get_by_ids(self, ids: list[str]) -> list[dict[str, Any]]:
"""Get multiple vector data by their IDs
Args:
ids: List of unique identifiers
Returns:
List of vector data objects that were found
"""
if not ids:
return []
ids_str = ",".join([f"'{id}'" for id in ids])
query = f"SELECT *, EXTRACT(EPOCH FROM create_time)::BIGINT as created_at FROM {self.table_name} WHERE workspace=$1 AND id IN ({ids_str})"
params = {"workspace": self.workspace}
try:
results = await self.db.query(query, list(params.values()), multirows=True)
if not results:
return []
# Preserve caller requested ordering while normalizing asyncpg rows to dicts.
id_map: dict[str, dict[str, Any]] = {}
for record in results:
if record is None:
continue
record_dict = dict(record)
row_id = record_dict.get("id")
if row_id is not None:
id_map[str(row_id)] = record_dict
ordered_results: list[dict[str, Any] | None] = []
for requested_id in ids:
ordered_results.append(id_map.get(str(requested_id)))
return ordered_results
except Exception as e:
logger.error(
f"[{self.workspace}] Error retrieving vector data for IDs {ids}: {e}"
)
return []
async def get_vectors_by_ids(self, ids: list[str]) -> dict[str, list[float]]:
"""Get vectors by their IDs, returning only ID and vector data for efficiency
Args:
ids: List of unique identifiers
Returns:
Dictionary mapping IDs to their vector embeddings
Format: {id: [vector_values], ...}
"""
if not ids:
return {}
ids_str = ",".join([f"'{id}'" for id in ids])
query = f"SELECT id, content_vector FROM {self.table_name} WHERE workspace=$1 AND id IN ({ids_str})"
params = {"workspace": self.workspace}
try:
results = await self.db.query(query, list(params.values()), multirows=True)
vectors_dict = {}
for result in results:
if result and "content_vector" in result and "id" in result:
try:
vector_data = result["content_vector"]
# Handle both pgvector-registered connections (returns list/tuple)
# and non-registered connections (returns JSON string)
if isinstance(vector_data, (list, tuple)):
vectors_dict[result["id"]] = list(vector_data)
elif isinstance(vector_data, str):
parsed = json.loads(vector_data)
if isinstance(parsed, list):
vectors_dict[result["id"]] = parsed
# Handle numpy arrays from pgvector
elif hasattr(vector_data, "tolist"):
vectors_dict[result["id"]] = vector_data.tolist()
elif hasattr(vector_data, "to_list") and callable(
vector_data.to_list
):
vectors_dict[result["id"]] = vector_data.to_list()
except (json.JSONDecodeError, TypeError) as e:
logger.warning(
f"[{self.workspace}] Failed to parse vector data for ID {result['id']}: {e}"
)
return vectors_dict
except Exception as e:
logger.error(
f"[{self.workspace}] Error retrieving vectors by IDs from {self.namespace}: {e}"
)
return {}
async def drop(self) -> dict[str, str]:
"""Drop the storage"""
try:
drop_sql = SQL_TEMPLATES["drop_specifiy_table_workspace"].format(
table_name=self.table_name
)
await self.db.execute(drop_sql, {"workspace": self.workspace})
return {"status": "success", "message": "data dropped"}
except Exception as e:
return {"status": "error", "message": str(e)}
def _parse_doc_status_datetime(
dt_str: Any,
context: str = "",
) -> datetime.datetime | None:
"""Convert a datetime value to a naive UTC datetime for database storage.
Accepts `datetime.datetime` objects, `datetime.date` objects, or ISO-format
strings. Returns None on failure (which may trigger a NOT NULL constraint
violation if the column does not allow nulls).
The optional context string (e.g. "[workspace] doc <id> created_at") is
included in the error log to help locate the offending record.
"""
if dt_str is None:
return None
if isinstance(dt_str, datetime.datetime):
if dt_str.tzinfo is None:
dt_str = dt_str.replace(tzinfo=timezone.utc)
return dt_str.astimezone(timezone.utc).replace(tzinfo=None)
if isinstance(dt_str, datetime.date):
return datetime.datetime(
dt_str.year, dt_str.month, dt_str.day, tzinfo=timezone.utc
).replace(tzinfo=None)
try:
dt = datetime.datetime.fromisoformat(dt_str)
if dt.tzinfo is None:
dt = dt.replace(tzinfo=timezone.utc)
return dt.astimezone(timezone.utc).replace(tzinfo=None)
except (ValueError, TypeError):
logger.error(
f"Unable to parse doc status datetime string"
f"{f' ({context})' if context else ''}: {dt_str!r}"
)
return None
@final
@dataclass
class PGDocStatusStorage(DocStatusStorage):
db: PostgreSQLDB = field(default=None)
def _format_datetime_with_timezone(self, dt):
"""Convert datetime to ISO format string with timezone info"""
if dt is None:
return None
# If no timezone info, assume it's UTC time (as stored in database)
if dt.tzinfo is None:
dt = dt.replace(tzinfo=timezone.utc)
# If datetime already has timezone info, keep it as is
return dt.isoformat()
async def initialize(self):
async with get_data_init_lock():
if self.db is None:
self.db = await ClientManager.get_client()
# Implement workspace priority: PostgreSQLDB.workspace > self.workspace > "default"
if self.db.workspace:
# Use PostgreSQLDB's workspace (highest priority)
logger.info(
f"Using PG_WORKSPACE environment variable: '{self.db.workspace}' (overriding '{self.workspace}/{self.namespace}')"
)
self.workspace = self.db.workspace
elif hasattr(self, "workspace") and self.workspace:
# Use storage class's workspace (medium priority)
pass
else:
# Use "default" for compatibility (lowest priority)
self.workspace = "default"
# NOTE: Table creation is handled by PostgreSQLDB.initdb() during initialization
# No need to create table here as it's already created in the TABLES dict
async def finalize(self):
if self.db is not None:
await ClientManager.release_client(self.db)
self.db = None
async def filter_keys(self, keys: set[str]) -> set[str]:
"""Filter out duplicated content"""
if not keys:
return set()
table_name = namespace_to_table_name(self.namespace)
sql = f"SELECT id FROM {table_name} WHERE workspace=$1 AND id = ANY($2)"
params = {"workspace": self.workspace, "ids": list(keys)}
try:
res = await self.db.query(sql, list(params.values()), multirows=True)
if res:
exist_keys = [key["id"] for key in res]
else:
exist_keys = []
new_keys = set([s for s in keys if s not in exist_keys])
# print(f"keys: {keys}")
# print(f"new_keys: {new_keys}")
return new_keys
except Exception as e:
logger.error(
f"[{self.workspace}] PostgreSQL database,\nsql:{sql},\nparams:{params},\nerror:{e}"
)
raise
async def get_by_id(self, id: str) -> Union[dict[str, Any], None]:
sql = "select * from LIGHTRAG_DOC_STATUS where workspace=$1 and id=$2"
params = {"workspace": self.workspace, "id": id}
result = await self.db.query(sql, list(params.values()), True)
if result is None or result == []:
return None
else:
# Parse chunks_list JSON string back to list
chunks_list = result[0].get("chunks_list", [])
if isinstance(chunks_list, str):
try:
chunks_list = json.loads(chunks_list)
except json.JSONDecodeError:
chunks_list = []
# Parse metadata JSON string back to dict
metadata = result[0].get("metadata", {})
if isinstance(metadata, str):
try:
metadata = json.loads(metadata)
except json.JSONDecodeError:
metadata = {}
# Convert datetime objects to ISO format strings with timezone info
created_at = self._format_datetime_with_timezone(result[0]["created_at"])
updated_at = self._format_datetime_with_timezone(result[0]["updated_at"])
return dict(
content_length=result[0]["content_length"],
content_summary=result[0]["content_summary"],
status=result[0]["status"],
chunks_count=result[0]["chunks_count"],
created_at=created_at,
updated_at=updated_at,
file_path=result[0]["file_path"],
chunks_list=chunks_list,
metadata=metadata,
error_msg=result[0].get("error_msg"),
track_id=result[0].get("track_id"),
)
async def get_by_ids(self, ids: list[str]) -> list[dict[str, Any]]:
"""Get doc_chunks data by multiple IDs."""
if not ids:
return []
sql = "SELECT * FROM LIGHTRAG_DOC_STATUS WHERE workspace=$1 AND id = ANY($2)"
params = {"workspace": self.workspace, "ids": ids}
results = await self.db.query(sql, list(params.values()), True)
if not results:
return []
processed_map: dict[str, dict[str, Any]] = {}
for row in results:
# Parse chunks_list JSON string back to list
chunks_list = row.get("chunks_list", [])
if isinstance(chunks_list, str):
try:
chunks_list = json.loads(chunks_list)
except json.JSONDecodeError:
chunks_list = []
# Parse metadata JSON string back to dict
metadata = row.get("metadata", {})
if isinstance(metadata, str):
try:
metadata = json.loads(metadata)
except json.JSONDecodeError:
metadata = {}
# Convert datetime objects to ISO format strings with timezone info
created_at = self._format_datetime_with_timezone(row["created_at"])
updated_at = self._format_datetime_with_timezone(row["updated_at"])
processed_map[str(row.get("id"))] = {
"content_length": row["content_length"],
"content_summary": row["content_summary"],
"status": row["status"],
"chunks_count": row["chunks_count"],
"created_at": created_at,
"updated_at": updated_at,
"file_path": row["file_path"],
"chunks_list": chunks_list,
"metadata": metadata,
"error_msg": row.get("error_msg"),
"track_id": row.get("track_id"),
}
ordered_results: list[dict[str, Any] | None] = []
for requested_id in ids:
ordered_results.append(processed_map.get(str(requested_id)))
return ordered_results
async def get_doc_by_file_path(self, file_path: str) -> Union[dict[str, Any], None]:
"""Get document by file path
Args:
file_path: The file path to search for
Returns:
Union[dict[str, Any], None]: Document data if found, None otherwise
Returns the same format as get_by_id method
"""
sql = "select * from LIGHTRAG_DOC_STATUS where workspace=$1 and file_path=$2"
params = {"workspace": self.workspace, "file_path": file_path}
result = await self.db.query(sql, list(params.values()), True)
if result is None or result == []:
return None
else:
# Parse chunks_list JSON string back to list
chunks_list = result[0].get("chunks_list", [])
if isinstance(chunks_list, str):
try:
chunks_list = json.loads(chunks_list)
except json.JSONDecodeError:
chunks_list = []
# Parse metadata JSON string back to dict
metadata = result[0].get("metadata", {})
if isinstance(metadata, str):
try:
metadata = json.loads(metadata)
except json.JSONDecodeError:
metadata = {}
# Convert datetime objects to ISO format strings with timezone info
created_at = self._format_datetime_with_timezone(result[0]["created_at"])
updated_at = self._format_datetime_with_timezone(result[0]["updated_at"])
return dict(
content_length=result[0]["content_length"],
content_summary=result[0]["content_summary"],
status=result[0]["status"],
chunks_count=result[0]["chunks_count"],
created_at=created_at,
updated_at=updated_at,
file_path=result[0]["file_path"],
chunks_list=chunks_list,
metadata=metadata,
error_msg=result[0].get("error_msg"),
track_id=result[0].get("track_id"),
)
async def get_status_counts(self) -> dict[str, int]:
"""Get counts of documents in each status"""
sql = """SELECT status as "status", COUNT(1) as "count"
FROM LIGHTRAG_DOC_STATUS
where workspace=$1 GROUP BY STATUS
"""
params = {"workspace": self.workspace}
result = await self.db.query(sql, list(params.values()), True)
counts = {}
for doc in result:
counts[doc["status"]] = doc["count"]
return counts
async def get_docs_by_status(
self, status: DocStatus
) -> dict[str, DocProcessingStatus]:
"""all documents with a specific status"""
sql = "select * from LIGHTRAG_DOC_STATUS where workspace=$1 and status=$2"
params = {"workspace": self.workspace, "status": status.value}
result = await self.db.query(sql, list(params.values()), True)
docs_by_status = {}
for element in result:
# Parse chunks_list JSON string back to list
chunks_list = element.get("chunks_list", [])
if isinstance(chunks_list, str):
try:
chunks_list = json.loads(chunks_list)
except json.JSONDecodeError:
chunks_list = []
# Parse metadata JSON string back to dict
metadata = element.get("metadata", {})
if isinstance(metadata, str):
try:
metadata = json.loads(metadata)
except json.JSONDecodeError:
metadata = {}
# Ensure metadata is a dict
if not isinstance(metadata, dict):
metadata = {}
# Safe handling for file_path
file_path = element.get("file_path")
if file_path is None:
file_path = "no-file-path"
# Convert datetime objects to ISO format strings with timezone info
created_at = self._format_datetime_with_timezone(element["created_at"])
updated_at = self._format_datetime_with_timezone(element["updated_at"])
docs_by_status[element["id"]] = DocProcessingStatus(
content_summary=element["content_summary"],
content_length=element["content_length"],
status=element["status"],
created_at=created_at,
updated_at=updated_at,
chunks_count=element["chunks_count"],
file_path=file_path,
chunks_list=chunks_list,
metadata=metadata,
error_msg=element.get("error_msg"),
track_id=element.get("track_id"),
)
return docs_by_status
async def get_docs_by_statuses(
self, statuses: list[DocStatus]
) -> dict[str, DocProcessingStatus]:
"""Fetch documents matching any of the given statuses in a single query.
Replaces multiple sequential/parallel get_docs_by_status() calls when the
caller needs documents across several statuses (e.g. PROCESSING + FAILED + PENDING).
Uses a single ANY($2) query instead of N separate round-trips.
"""
if not statuses:
return {}
status_values = [s.value for s in statuses]
sql = (
"SELECT * FROM LIGHTRAG_DOC_STATUS WHERE workspace=$1 AND status = ANY($2)"
)
result = await self.db.query(
sql, [self.workspace, status_values], multirows=True
)
docs: dict[str, DocProcessingStatus] = {}
for element in result or []:
try:
chunks_list = element.get("chunks_list", [])
if isinstance(chunks_list, str):
try:
chunks_list = json.loads(chunks_list)
except json.JSONDecodeError:
chunks_list = []
metadata = element.get("metadata", {})
if isinstance(metadata, str):
try:
metadata = json.loads(metadata)
except json.JSONDecodeError:
metadata = {}
if not isinstance(metadata, dict):
metadata = {}
file_path = element.get("file_path") or "no-file-path"
docs[element["id"]] = DocProcessingStatus(
content_summary=element["content_summary"],
content_length=element["content_length"],
status=element["status"],
created_at=self._format_datetime_with_timezone(
element["created_at"]
),
updated_at=self._format_datetime_with_timezone(
element["updated_at"]
),
chunks_count=element["chunks_count"],
file_path=file_path,
chunks_list=chunks_list,
metadata=metadata,
error_msg=element.get("error_msg"),
track_id=element.get("track_id"),
)
except (KeyError, TypeError) as e:
doc_id_hint = element.get("id", "<unknown>") if element else "<unknown>"
logger.error(
f"[{self.workspace}] Skipping document '{doc_id_hint}' — "
f"required field missing or wrong type while parsing DB row: {e!r}"
)
continue
return docs
async def get_docs_by_track_id(
self, track_id: str
) -> dict[str, DocProcessingStatus]:
"""Get all documents with a specific track_id"""
sql = "select * from LIGHTRAG_DOC_STATUS where workspace=$1 and track_id=$2"
params = {"workspace": self.workspace, "track_id": track_id}
result = await self.db.query(sql, list(params.values()), True)
docs_by_track_id = {}
for element in result:
# Parse chunks_list JSON string back to list
chunks_list = element.get("chunks_list", [])
if isinstance(chunks_list, str):
try:
chunks_list = json.loads(chunks_list)
except json.JSONDecodeError:
chunks_list = []
# Parse metadata JSON string back to dict
metadata = element.get("metadata", {})
if isinstance(metadata, str):
try:
metadata = json.loads(metadata)
except json.JSONDecodeError:
metadata = {}
# Ensure metadata is a dict
if not isinstance(metadata, dict):
metadata = {}
# Safe handling for file_path
file_path = element.get("file_path")
if file_path is None:
file_path = "no-file-path"
# Convert datetime objects to ISO format strings with timezone info
created_at = self._format_datetime_with_timezone(element["created_at"])
updated_at = self._format_datetime_with_timezone(element["updated_at"])
docs_by_track_id[element["id"]] = DocProcessingStatus(
content_summary=element["content_summary"],
content_length=element["content_length"],
status=element["status"],
created_at=created_at,
updated_at=updated_at,
chunks_count=element["chunks_count"],
file_path=file_path,
chunks_list=chunks_list,
track_id=element.get("track_id"),
metadata=metadata,
error_msg=element.get("error_msg"),
)
return docs_by_track_id
async def get_docs_paginated(
self,
status_filter: DocStatus | None = None,
page: int = 1,
page_size: int = 50,
sort_field: str = "updated_at",
sort_direction: str = "desc",
) -> tuple[list[tuple[str, DocProcessingStatus]], int]:
"""Get documents with pagination support
Args:
status_filter: Filter by document status, None for all statuses
page: Page number (1-based)
page_size: Number of documents per page (10-200)
sort_field: Field to sort by ('created_at', 'updated_at', 'id')
sort_direction: Sort direction ('asc' or 'desc')
Returns:
Tuple of (list of (doc_id, DocProcessingStatus) tuples, total_count)
"""
start = time.perf_counter()
status_filter_value = status_filter.value if status_filter is not None else None
performance_timing_log(
"[%s] PGDocStatusStorage.get_docs_paginated start status_filter=%s page=%s page_size=%s sort_field=%s sort_direction=%s",
self.workspace,
status_filter_value,
page,
page_size,
sort_field,
sort_direction,
)
# Validate parameters
if page < 1:
page = 1
if page_size < 10:
page_size = 10
elif page_size > 200:
page_size = 200
# Whitelist validation for sort_field to prevent SQL injection
allowed_sort_fields = {"created_at", "updated_at", "id", "file_path"}
if sort_field not in allowed_sort_fields:
sort_field = "updated_at"
# Whitelist validation for sort_direction to prevent SQL injection
if sort_direction.lower() not in ["asc", "desc"]:
sort_direction = "desc"
else:
sort_direction = sort_direction.lower()
# Calculate offset
offset = (page - 1) * page_size
# Build parameterized query components
params = {"workspace": self.workspace}
param_count = 1
# Build WHERE clause with parameterized query
if status_filter is not None:
param_count += 1
where_clause = "WHERE workspace=$1 AND status=$2"
params["status"] = status_filter.value
else:
where_clause = "WHERE workspace=$1"
# Build ORDER BY clause using validated whitelist values.
# NULLS LAST is applied in both the inner paged CTE and the outer query so
# that the LIMIT/OFFSET slice boundary and the display order are identical.
# Without it, DESC defaults to NULLS FIRST: nulls land on earlier pages but
# are re-sorted to the end by the outer ORDER BY, dropping non-null rows.
order_clause = f"ORDER BY {sort_field} {sort_direction.upper()} NULLS LAST"
# Two-CTE query: total count + page data in a single round-trip.
#
# COUNT(*) OVER () was replaced because when the LIMIT/OFFSET clause yields
# no rows (out-of-range page), there are no result rows to carry the window
# function value — so total_count would not appear in the output at all,
# making it impossible to distinguish "0 matching documents" from "non-empty
# result set, page is past the end".
#
# The LEFT JOIN pattern fixes this: the `total` CTE always produces exactly
# one row (the aggregate count over the full WHERE clause), and the outer
# LEFT JOIN emits that one row even when `paged` is empty. Python then
# skips rows where id IS NULL (the empty-page sentinel).
#
# chunks_list is intentionally excluded from the paged CTE SELECT list:
# DocStatusResponse does not expose it, so transferring the full JSONB array
# would be pure overhead. The chunks_list=[] in the constructor below is
# intentional — see the paged CTE column list above.
params["limit"] = page_size
params["offset"] = offset
cte_sql = f"""
WITH total AS (
SELECT COUNT(*) AS _total_count
FROM LIGHTRAG_DOC_STATUS
{where_clause}
),
paged AS (
SELECT id, workspace, content_summary, content_length, chunks_count,
status, file_path, track_id, metadata, error_msg,
created_at, updated_at
FROM LIGHTRAG_DOC_STATUS
{where_clause}
{order_clause}
LIMIT ${param_count + 1} OFFSET ${param_count + 2}
)
SELECT p.*, t._total_count
FROM total t
LEFT JOIN paged p ON true
ORDER BY p.{sort_field} {sort_direction.upper()} NULLS LAST
"""
query_timing_label = f"{self.workspace} PGDocStatusStorage.get_docs_paginated"
result = await self.db.query(
cte_sql,
list(params.values()),
True,
timing_label=query_timing_label,
)
total_count = result[0]["_total_count"] if result else 0
# Convert to (doc_id, DocProcessingStatus) tuples
documents = []
for element in result:
if element["id"] is None:
# Empty-page sentinel row from LEFT JOIN when paged has no rows.
continue
doc_id = element["id"]
# Parse metadata JSON string back to dict
metadata = element.get("metadata", {})
if isinstance(metadata, str):
try:
metadata = json.loads(metadata)
except json.JSONDecodeError:
metadata = {}
# Convert datetime objects to ISO format strings with timezone info
created_at = self._format_datetime_with_timezone(element["created_at"])
updated_at = self._format_datetime_with_timezone(element["updated_at"])
doc_status = DocProcessingStatus(
content_summary=element["content_summary"],
content_length=element["content_length"],
status=element["status"],
created_at=created_at,
updated_at=updated_at,
chunks_count=element["chunks_count"],
file_path=element["file_path"],
chunks_list=[], # not fetched: unused by pagination response
track_id=element.get("track_id"),
metadata=metadata,
error_msg=element.get("error_msg"),
)
documents.append((doc_id, doc_status))
elapsed = time.perf_counter() - start
performance_timing_log(
"[%s] PGDocStatusStorage.get_docs_paginated completed in %.4fs returned_rows=%s total_count=%s status_filter=%s page=%s page_size=%s sort_field=%s sort_direction=%s",
self.workspace,
elapsed,
len(documents),
total_count,
status_filter_value,
page,
page_size,
sort_field,
sort_direction,
)
return documents, total_count
async def get_all_status_counts(self) -> dict[str, int]:
"""Get counts of documents in each status for all documents
Returns:
Dictionary mapping status names to counts, including 'all' field
"""
start = time.perf_counter()
performance_timing_log(
"[%s] PGDocStatusStorage.get_all_status_counts start", self.workspace
)
sql = """
SELECT status, COUNT(*) as count
FROM LIGHTRAG_DOC_STATUS
WHERE workspace=$1
GROUP BY status
"""
params = {"workspace": self.workspace}
query_timing_label = (
f"{self.workspace} PGDocStatusStorage.get_all_status_counts"
)
result = await self.db.query(
sql,
list(params.values()),
True,
timing_label=query_timing_label,
)
counts = {}
total_count = 0
for row in result:
counts[row["status"]] = row["count"]
total_count += row["count"]
# Add 'all' field with total count
counts["all"] = total_count
elapsed = time.perf_counter() - start
performance_timing_log(
"[%s] PGDocStatusStorage.get_all_status_counts completed in %.4fs counts=%s",
self.workspace,
elapsed,
counts,
)
return counts
async def index_done_callback(self) -> None:
# PG handles persistence automatically
pass
async def is_empty(self) -> bool:
"""Check if the storage is empty for the current workspace and namespace
Returns:
bool: True if storage is empty, False otherwise
"""
table_name = namespace_to_table_name(self.namespace)
if not table_name:
logger.error(
f"[{self.workspace}] Unknown namespace for is_empty check: {self.namespace}"
)
return True
sql = f"SELECT EXISTS(SELECT 1 FROM {table_name} WHERE workspace=$1 LIMIT 1) as has_data"
try:
result = await self.db.query(sql, [self.workspace])
return not result.get("has_data", False) if result else True
except Exception as e:
logger.error(f"[{self.workspace}] Error checking if storage is empty: {e}")
return True
async def delete(self, ids: list[str]) -> None:
"""Delete specific records from storage by their IDs
Args:
ids (list[str]): List of document IDs to be deleted from storage
Returns:
None
"""
if not ids:
return
table_name = namespace_to_table_name(self.namespace)
if not table_name:
logger.error(
f"[{self.workspace}] Unknown namespace for deletion: {self.namespace}"
)
return
delete_sql = f"DELETE FROM {table_name} WHERE workspace=$1 AND id = ANY($2)"
try:
await self.db.execute(delete_sql, {"workspace": self.workspace, "ids": ids})
logger.debug(
f"[{self.workspace}] Successfully deleted {len(ids)} records from {self.namespace}"
)
except Exception as e:
logger.error(
f"[{self.workspace}] Error while deleting records from {self.namespace}: {e}"
)
async def upsert(self, data: dict[str, dict[str, Any]]) -> None:
"""Update or insert document status
Args:
data: dictionary of document IDs and their status data
"""
logger.debug(f"[{self.workspace}] Inserting {len(data)} to {self.namespace}")
if not data:
return
timing_label = f"{self.workspace} PGDocStatusStorage.upsert"
total_start = time.perf_counter()
performance_timing_log(
"[%s] start records=%s",
timing_label,
len(data),
)
sql = """insert into LIGHTRAG_DOC_STATUS(workspace,id,content_summary,content_length,chunks_count,status,file_path,chunks_list,track_id,metadata,error_msg,created_at,updated_at)
values($1,$2,$3,$4,$5,$6,$7,$8,$9,$10,$11,$12,$13)
on conflict(id,workspace) do update set
content_summary = EXCLUDED.content_summary,
content_length = EXCLUDED.content_length,
chunks_count = EXCLUDED.chunks_count,
status = EXCLUDED.status,
file_path = EXCLUDED.file_path,
chunks_list = EXCLUDED.chunks_list,
track_id = EXCLUDED.track_id,
metadata = EXCLUDED.metadata,
error_msg = EXCLUDED.error_msg,
created_at = EXCLUDED.created_at,
updated_at = EXCLUDED.updated_at"""
# Tuple order must match SQL: (workspace, id, content_summary, content_length,
# chunks_count, status, file_path, chunks_list, track_id, metadata,
# error_msg, created_at, updated_at)
batch: list[tuple] = []
skipped: list[str] = []
batch_build_start = time.perf_counter()
for i, (k, v) in enumerate(data.items(), start=1):
try:
batch.append(
(
self.workspace,
k,
v["content_summary"],
v["content_length"],
v.get("chunks_count", -1),
v["status"],
v["file_path"],
json.dumps(v.get("chunks_list", [])),
v.get("track_id"),
json.dumps(v.get("metadata", {})),
v.get("error_msg"),
_parse_doc_status_datetime(
v.get("created_at"),
f"[{self.workspace}] doc {k} created_at",
),
_parse_doc_status_datetime(
v.get("updated_at"),
f"[{self.workspace}] doc {k} updated_at",
),
)
)
except (KeyError, TypeError, ValueError) as e:
logger.error(
f"[{self.workspace}] Skipping document '{k}' in batch upsert — "
f"invalid or missing field: {e!r}"
)
skipped.append(k)
await _cooperative_yield(i)
if skipped:
logger.warning(
f"[{self.workspace}] {len(skipped)} document(s) skipped in batch upsert: {skipped}"
)
performance_timing_log(
"[%s] batch validation/assembly completed in %.4fs valid_count=%s skipped_count=%s",
timing_label,
time.perf_counter() - batch_build_start,
len(batch),
len(skipped),
)
async def _batch_upsert(
connection: asyncpg.Connection,
_sql: str = sql,
_data: list[tuple] = batch,
) -> None:
execute_start = time.perf_counter()
async with connection.transaction():
await connection.executemany(_sql, _data)
performance_timing_log(
"[%s] transaction + executemany completed in %.4fs batch_size=%s",
timing_label,
time.perf_counter() - execute_start,
len(_data),
)
await self.db._run_with_retry(_batch_upsert, timing_label=timing_label)
logger.debug(
f"[{self.workspace}] Batch upserted {len(batch)} records to {self.namespace}"
)
performance_timing_log(
"[%s] total complete in %.4fs valid_count=%s skipped_count=%s",
timing_label,
time.perf_counter() - total_start,
len(batch),
len(skipped),
)
async def drop(self) -> dict[str, str]:
"""Drop the storage"""
try:
table_name = namespace_to_table_name(self.namespace)
if not table_name:
return {
"status": "error",
"message": f"Unknown namespace: {self.namespace}",
}
drop_sql = SQL_TEMPLATES["drop_specifiy_table_workspace"].format(
table_name=table_name
)
await self.db.execute(drop_sql, {"workspace": self.workspace})
return {"status": "success", "message": "data dropped"}
except Exception as e:
return {"status": "error", "message": str(e)}
class PGGraphQueryException(Exception):
"""Exception for the AGE queries."""
def __init__(self, exception: Union[str, dict[str, Any]]) -> None:
if isinstance(exception, dict):
self.message = exception["message"] if "message" in exception else "unknown"
self.details = exception["details"] if "details" in exception else "unknown"
else:
self.message = exception
self.details = "unknown"
def get_message(self) -> str:
return self.message
def get_details(self) -> Any:
return self.details
def _is_transient_graph_write_error(exc: BaseException) -> bool:
"""Return True when a PGGraphQueryException wraps a transient write-time error.
The inner _run_with_retry already handles connection-level transient errors
(pool reset, TCP failures, etc.). This predicate covers query-level transient
errors that survive the connection layer and surface as PGGraphQueryException:
deadlocks, serialization conflicts, and lock-acquisition timeouts that can
occur under concurrent document ingestion.
"""
if not isinstance(exc, PGGraphQueryException):
return False
cause = exc.__cause__
if cause is None:
return False
return isinstance(
cause,
(
asyncpg.exceptions.DeadlockDetectedError,
asyncpg.exceptions.SerializationError,
asyncpg.exceptions.LockNotAvailableError,
asyncpg.exceptions.QueryCanceledError,
),
)
@final
@dataclass
class PGGraphStorage(BaseGraphStorage):
def __post_init__(self):
# Graph name will be dynamically generated in initialize() based on workspace
self.db: PostgreSQLDB | None = None
def _get_workspace_graph_name(self) -> str:
"""
Generate graph name based on workspace and namespace for data isolation.
Rules:
- If workspace is empty or "default": graph_name = namespace
- If workspace has other value: graph_name = workspace_namespace
Args:
None
Returns:
str: The graph name for the current workspace
"""
workspace = self.workspace
namespace = self.namespace
if workspace and workspace.strip() and workspace.strip().lower() != "default":
# Ensure names comply with PostgreSQL identifier specifications
safe_workspace = re.sub(r"[^a-zA-Z0-9_]", "_", workspace.strip())
safe_namespace = re.sub(r"[^a-zA-Z0-9_]", "_", namespace)
return f"{safe_workspace}_{safe_namespace}"
else:
# When the workspace is "default", use the namespace directly (for backward compatibility with legacy implementations)
return re.sub(r"[^a-zA-Z0-9_]", "_", namespace)
@staticmethod
def _normalize_node_id(node_id: str) -> str:
"""
Normalize node ID to ensure special characters are properly handled in Cypher queries.
Args:
node_id: The original node ID
Returns:
Normalized node ID suitable for Cypher queries
"""
# Escape backslashes
normalized_id = node_id
normalized_id = normalized_id.replace("\\", "\\\\")
normalized_id = normalized_id.replace('"', '\\"')
return normalized_id
async def initialize(self):
async with get_data_init_lock():
if self.db is None:
self.db = await ClientManager.get_client()
# Implement workspace priority: PostgreSQLDB.workspace > self.workspace > "default"
if self.db.workspace:
# Use PostgreSQLDB's workspace (highest priority)
logger.info(
f"Using PG_WORKSPACE environment variable: '{self.db.workspace}' (overriding '{self.workspace}/{self.namespace}')"
)
self.workspace = self.db.workspace
elif hasattr(self, "workspace") and self.workspace:
# Use storage class's workspace (medium priority)
pass
else:
# Use "default" for compatibility (lowest priority)
self.workspace = "default"
# Dynamically generate graph name based on workspace
self.graph_name = self._get_workspace_graph_name()
# Log the graph initialization for debugging
logger.info(
f"[{self.workspace}] PostgreSQL Graph initialized: graph_name='{self.graph_name}'"
)
# Create AGE extension and configure graph environment once at initialization
# Use _run_with_retry so transient connection errors are retried and pool=None
# is handled safely (unlike a bare pool.acquire() call).
async def _do_configure_age_extension(
connection: asyncpg.Connection,
) -> None:
await PostgreSQLDB.configure_age_extension(connection)
await self.db._run_with_retry(_do_configure_age_extension)
# Execute each statement separately and ignore errors
queries = [
f"SELECT create_graph('{self.graph_name}')",
f"SELECT create_vlabel('{self.graph_name}', 'base');",
f"SELECT create_elabel('{self.graph_name}', 'DIRECTED');",
# f'CREATE INDEX CONCURRENTLY vertex_p_idx ON {self.graph_name}."_ag_label_vertex" (id)',
f'CREATE INDEX CONCURRENTLY vertex_idx_node_id ON {self.graph_name}."_ag_label_vertex" (ag_catalog.agtype_access_operator(properties, \'"entity_id"\'::agtype))',
# f'CREATE INDEX CONCURRENTLY edge_p_idx ON {self.graph_name}."_ag_label_edge" (id)',
f'CREATE INDEX CONCURRENTLY edge_sid_idx ON {self.graph_name}."_ag_label_edge" (start_id)',
f'CREATE INDEX CONCURRENTLY edge_eid_idx ON {self.graph_name}."_ag_label_edge" (end_id)',
f'CREATE INDEX CONCURRENTLY edge_seid_idx ON {self.graph_name}."_ag_label_edge" (start_id,end_id)',
f'CREATE INDEX CONCURRENTLY directed_p_idx ON {self.graph_name}."DIRECTED" (id)',
f'CREATE INDEX CONCURRENTLY directed_eid_idx ON {self.graph_name}."DIRECTED" (end_id)',
f'CREATE INDEX CONCURRENTLY directed_sid_idx ON {self.graph_name}."DIRECTED" (start_id)',
f'CREATE INDEX CONCURRENTLY directed_seid_idx ON {self.graph_name}."DIRECTED" (start_id,end_id)',
f'CREATE INDEX CONCURRENTLY entity_p_idx ON {self.graph_name}."base" (id)',
f'CREATE INDEX CONCURRENTLY entity_idx_node_id ON {self.graph_name}."base" (ag_catalog.agtype_access_operator(properties, \'"entity_id"\'::agtype))',
f'CREATE INDEX CONCURRENTLY entity_node_id_gin_idx ON {self.graph_name}."base" using gin(properties)',
f'ALTER TABLE {self.graph_name}."DIRECTED" CLUSTER ON directed_sid_idx',
]
for query in queries:
# Use the new flag to silently ignore "already exists" errors
# at the source, preventing log spam.
await self.db.execute(
query,
upsert=True,
ignore_if_exists=True, # Pass the new flag
with_age=True,
graph_name=self.graph_name,
)
async def finalize(self):
if self.db is not None:
await ClientManager.release_client(self.db)
self.db = None
async def index_done_callback(self) -> None:
# PG handles persistence automatically
pass
@staticmethod
def _record_to_dict(record: asyncpg.Record) -> dict[str, Any]:
"""
Convert a record returned from an age query to a dictionary
Args:
record (): a record from an age query result
Returns:
dict[str, Any]: a dictionary representation of the record where
the dictionary key is the field name and the value is the
value converted to a python type
"""
@staticmethod
def parse_agtype_string(agtype_str: str) -> tuple[str, str]:
"""
Parse agtype string precisely, separating JSON content and type identifier
Args:
agtype_str: String like '{"json": "content"}::vertex'
Returns:
(json_content, type_identifier)
"""
if not isinstance(agtype_str, str) or "::" not in agtype_str:
return agtype_str, ""
# Find the last :: from the right, which is the start of type identifier
last_double_colon = agtype_str.rfind("::")
if last_double_colon == -1:
return agtype_str, ""
# Separate JSON content and type identifier
json_content = agtype_str[:last_double_colon]
type_identifier = agtype_str[last_double_colon + 2 :]
return json_content, type_identifier
@staticmethod
def safe_json_parse(json_str: str, context: str = "") -> dict:
"""
Safe JSON parsing with simplified error logging
"""
try:
return json.loads(json_str)
except json.JSONDecodeError as e:
logger.error(f"JSON parsing failed ({context}): {e}")
logger.error(f"Raw data (first 100 chars): {repr(json_str[:100])}")
logger.error(f"Error position: line {e.lineno}, column {e.colno}")
return None
# result holder
d = {}
# prebuild a mapping of vertex_id to vertex mappings to be used
# later to build edges
vertices = {}
# First pass: preprocess vertices
for k in record.keys():
v = record[k]
if isinstance(v, str) and "::" in v:
if v.startswith("[") and v.endswith("]"):
# Handle vertex arrays
json_content, type_id = parse_agtype_string(v)
if type_id == "vertex":
vertexes = safe_json_parse(
json_content, f"vertices array for {k}"
)
if vertexes:
for vertex in vertexes:
vertices[vertex["id"]] = vertex.get("properties")
else:
# Handle single vertex
json_content, type_id = parse_agtype_string(v)
if type_id == "vertex":
vertex = safe_json_parse(json_content, f"single vertex for {k}")
if vertex:
vertices[vertex["id"]] = vertex.get("properties")
# Second pass: process all fields
for k in record.keys():
v = record[k]
if isinstance(v, str) and "::" in v:
if v.startswith("[") and v.endswith("]"):
# Handle array types
json_content, type_id = parse_agtype_string(v)
if type_id in ["vertex", "edge"]:
parsed_data = safe_json_parse(
json_content, f"array {type_id} for field {k}"
)
d[k] = parsed_data if parsed_data is not None else None
else:
logger.warning(f"Unknown array type: {type_id}")
d[k] = None
else:
# Handle single objects
json_content, type_id = parse_agtype_string(v)
if type_id in ["vertex", "edge"]:
parsed_data = safe_json_parse(
json_content, f"single {type_id} for field {k}"
)
d[k] = parsed_data if parsed_data is not None else None
else:
# May be other types of agtype data, keep as is
d[k] = v
else:
d[k] = v # Keep as string
return d
@staticmethod
def _format_properties(
properties: dict[str, Any], _id: Union[str, None] = None
) -> str:
"""
Convert a dictionary of properties to a string representation that
can be used in a cypher query insert/merge statement.
Args:
properties (dict[str,str]): a dictionary containing node/edge properties
_id (Union[str, None]): the id of the node or None if none exists
Returns:
str: the properties dictionary as a properly formatted string
"""
props = []
# wrap property key in backticks to escape
for k, v in properties.items():
prop = f"`{k}`: {json.dumps(v)}"
props.append(prop)
if _id is not None and "id" not in properties:
props.append(
f"id: {json.dumps(_id)}" if isinstance(_id, str) else f"id: {_id}"
)
return "{" + ", ".join(props) + "}"
async def _query(
self,
query: str,
readonly: bool = True,
upsert: bool = False,
params: dict[str, Any] | None = None,
timing_label: str | None = None,
) -> list[dict[str, Any]]:
"""
Query the graph by taking a cypher query, converting it to an
age compatible query, executing it and converting the result
Args:
query (str): a cypher query to be executed
readonly (bool): if True, uses db.query (supports params); if False,
uses db.execute (write path) which does not yet support params.
upsert (bool): passed through to db.execute for write operations.
params (dict | None): AGE agtype parameters for parameterized Cypher
(e.g. ``{"params": json.dumps({"entity_id": "..."})}``).
Only honoured when ``readonly=True``. Write paths (upsert_node,
upsert_edge, delete_node, remove_nodes, remove_edges) still
interpolate entity IDs via _normalize_node_id; extending
parameterization to those paths is tracked as a follow-up task.
timing_label (str | None): optional label for performance logging.
Returns:
list[dict[str, Any]]: a list of dictionaries containing the result set
"""
try:
if readonly:
data = await self.db.query(
query,
list(params.values()) if params else None,
multirows=True,
with_age=True,
graph_name=self.graph_name,
timing_label=timing_label,
)
else:
age_execute_start = time.perf_counter()
data = await self.db.execute(
query,
upsert=upsert,
with_age=True,
graph_name=self.graph_name,
timing_label=timing_label,
)
if timing_label:
performance_timing_log(
"[%s] AGE execute completed in %.4fs",
timing_label,
time.perf_counter() - age_execute_start,
)
except Exception as e:
if timing_label and not readonly:
performance_timing_log(
"[%s] AGE execute failed after %.4fs",
timing_label,
time.perf_counter() - age_execute_start,
)
raise PGGraphQueryException(
{
"message": f"Error executing graph query: {query}",
"wrapped": query,
"detail": repr(e),
"error_type": e.__class__.__name__,
}
) from e
if data is None:
result = []
# decode records
else:
result = [self._record_to_dict(d) for d in data]
return result
async def has_node(self, node_id: str) -> bool:
query = f"""
SELECT EXISTS (
SELECT 1
FROM {self.graph_name}.base
WHERE ag_catalog.agtype_access_operator(
VARIADIC ARRAY[properties, '"entity_id"'::agtype]
) = (to_json($1::text)::text)::agtype
LIMIT 1
) AS node_exists;
"""
params = {"node_id": node_id}
row = (await self._query(query, params=params))[0]
return bool(row["node_exists"])
async def has_edge(self, source_node_id: str, target_node_id: str) -> bool:
query = f"""
WITH a AS (
SELECT id AS vid
FROM {self.graph_name}.base
WHERE ag_catalog.agtype_access_operator(
VARIADIC ARRAY[properties, '"entity_id"'::agtype]
) = (to_json($1::text)::text)::agtype
),
b AS (
SELECT id AS vid
FROM {self.graph_name}.base
WHERE ag_catalog.agtype_access_operator(
VARIADIC ARRAY[properties, '"entity_id"'::agtype]
) = (to_json($2::text)::text)::agtype
)
SELECT EXISTS (
SELECT 1
FROM {self.graph_name}."DIRECTED" d
JOIN a ON d.start_id = a.vid
JOIN b ON d.end_id = b.vid
LIMIT 1
)
OR EXISTS (
SELECT 1
FROM {self.graph_name}."DIRECTED" d
JOIN a ON d.end_id = a.vid
JOIN b ON d.start_id = b.vid
LIMIT 1
) AS edge_exists;
"""
params = {
"source_node_id": source_node_id,
"target_node_id": target_node_id,
}
row = (await self._query(query, params=params))[0]
return bool(row["edge_exists"])
async def get_node(self, node_id: str) -> dict[str, str] | None:
"""Get node by its label identifier, return only node properties"""
result = await self.get_nodes_batch(node_ids=[node_id])
if result and node_id in result:
return result[node_id]
return None
async def node_degree(self, node_id: str) -> int:
result = await self.node_degrees_batch(node_ids=[node_id])
if result and node_id in result:
return result[node_id]
async def edge_degree(self, src_id: str, tgt_id: str) -> int:
result = await self.edge_degrees_batch(edges=[(src_id, tgt_id)])
if result and (src_id, tgt_id) in result:
return result[(src_id, tgt_id)]
async def get_edge(
self, source_node_id: str, target_node_id: str
) -> dict[str, str] | None:
"""Get edge properties between two nodes"""
result = await self.get_edges_batch(
[{"src": source_node_id, "tgt": target_node_id}]
)
if result and (source_node_id, target_node_id) in result:
return result[(source_node_id, target_node_id)]
return None
async def get_node_edges(self, source_node_id: str) -> list[tuple[str, str]] | None:
"""
Retrieves all edges (relationships) for a particular node identified by its label.
:return: list of dictionaries containing edge information
"""
cypher_query = """MATCH (n:base {entity_id: $entity_id})
OPTIONAL MATCH (n)-[]-(connected:base)
RETURN n.entity_id AS source_id, connected.entity_id AS connected_id"""
query = f"SELECT * FROM cypher({_dollar_quote(self.graph_name)}::name, {_dollar_quote(cypher_query)}::cstring, $1::agtype) AS (source_id text, connected_id text)"
pg_params = {
"params": json.dumps({"entity_id": source_node_id}, ensure_ascii=False)
}
results = await self._query(query, params=pg_params)
edges = []
for record in results:
source_id = record["source_id"]
connected_id = record["connected_id"]
if source_id and connected_id:
edges.append((source_id, connected_id))
return edges
@retry(
stop=stop_after_attempt(3),
wait=wait_exponential(multiplier=1, min=4, max=10),
retry=retry_if_exception(_is_transient_graph_write_error),
reraise=True,
)
async def upsert_node(self, node_id: str, node_data: dict[str, str]) -> None:
"""
Upsert a node in the Neo4j database.
Args:
node_id: The unique identifier for the node (used as label)
node_data: Dictionary of node properties
"""
if "entity_id" not in node_data:
raise ValueError(
"PostgreSQL: node properties must contain an 'entity_id' field"
)
label = self._normalize_node_id(node_id)
properties = self._format_properties(node_data)
# Build Cypher query with dynamic dollar-quoting to handle content containing $$
# This prevents syntax errors when LLM-extracted descriptions contain $ sequences
cypher_query = f"""MERGE (n:base {{entity_id: "{label}"}})
SET n += {properties}
RETURN n"""
query = f"SELECT * FROM cypher({_dollar_quote(self.graph_name)}, {_dollar_quote(cypher_query)}) AS (n agtype)"
timing_label = f"{self.workspace} PGGraphStorage.upsert_node"
total_start = time.perf_counter()
performance_timing_log(
"[%s] start node_id=%s",
timing_label,
node_id,
)
try:
await self._query(
query,
readonly=False,
upsert=True,
timing_label=timing_label,
)
performance_timing_log(
"[%s] total complete in %.4fs node_id=%s",
timing_label,
time.perf_counter() - total_start,
node_id,
)
except Exception:
performance_timing_log(
"[%s] total failed after %.4fs node_id=%s",
timing_label,
time.perf_counter() - total_start,
node_id,
)
logger.error(
f"[{self.workspace}] POSTGRES, upsert_node error on node_id: `{node_id}`"
)
raise
@retry(
stop=stop_after_attempt(3),
wait=wait_exponential(multiplier=1, min=4, max=10),
retry=retry_if_exception(_is_transient_graph_write_error),
reraise=True,
)
async def upsert_edge(
self, source_node_id: str, target_node_id: str, edge_data: dict[str, str]
) -> None:
"""
Upsert an edge and its properties between two nodes identified by their labels.
Args:
source_node_id (str): Label of the source node (used as identifier)
target_node_id (str): Label of the target node (used as identifier)
edge_data (dict): dictionary of properties to set on the edge
"""
src_label = self._normalize_node_id(source_node_id)
tgt_label = self._normalize_node_id(target_node_id)
edge_properties = self._format_properties(edge_data)
# Build Cypher query with dynamic dollar-quoting to handle content containing $$
# This prevents syntax errors when LLM-extracted descriptions contain $ sequences
# See: https://github.com/HKUDS/LightRAG/issues/1438#issuecomment-2826000195
cypher_query = f"""MATCH (source:base {{entity_id: "{src_label}"}})
WITH source
MATCH (target:base {{entity_id: "{tgt_label}"}})
MERGE (source)-[r:DIRECTED]-(target)
SET r += {edge_properties}
SET r += {edge_properties}
RETURN r"""
query = f"SELECT * FROM cypher({_dollar_quote(self.graph_name)}, {_dollar_quote(cypher_query)}) AS (r agtype)"
timing_label = f"{self.workspace} PGGraphStorage.upsert_edge"
total_start = time.perf_counter()
performance_timing_log(
"[%s] start source_node_id=%s target_node_id=%s",
timing_label,
source_node_id,
target_node_id,
)
try:
await self._query(
query,
readonly=False,
upsert=True,
timing_label=timing_label,
)
performance_timing_log(
"[%s] total complete in %.4fs source_node_id=%s target_node_id=%s",
timing_label,
time.perf_counter() - total_start,
source_node_id,
target_node_id,
)
except Exception:
performance_timing_log(
"[%s] total failed after %.4fs source_node_id=%s target_node_id=%s",
timing_label,
time.perf_counter() - total_start,
source_node_id,
target_node_id,
)
logger.error(
f"[{self.workspace}] POSTGRES, upsert_edge error on edge: `{source_node_id}`-`{target_node_id}`"
)
raise
async def delete_node(self, node_id: str) -> None:
"""
Delete a node from the graph.
Args:
node_id (str): The ID of the node to delete.
"""
label = self._normalize_node_id(node_id)
# Build Cypher query with dynamic dollar-quoting to handle entity_id containing $ sequences
cypher_query = f"""MATCH (n:base {{entity_id: "{label}"}})
DETACH DELETE n"""
query = f"SELECT * FROM cypher({_dollar_quote(self.graph_name)}, {_dollar_quote(cypher_query)}) AS (n agtype)"
try:
await self._query(query, readonly=False)
except Exception as e:
logger.error(f"[{self.workspace}] Error during node deletion: {e}")
raise
async def remove_nodes(self, node_ids: list[str]) -> None:
"""
Remove multiple nodes from the graph.
Args:
node_ids (list[str]): A list of node IDs to remove.
"""
node_ids_normalized = [self._normalize_node_id(node_id) for node_id in node_ids]
node_id_list = ", ".join([f'"{node_id}"' for node_id in node_ids_normalized])
# Build Cypher query with dynamic dollar-quoting to handle entity_id containing $ sequences
cypher_query = f"""MATCH (n:base)
WHERE n.entity_id IN [{node_id_list}]
DETACH DELETE n"""
query = f"SELECT * FROM cypher({_dollar_quote(self.graph_name)}, {_dollar_quote(cypher_query)}) AS (n agtype)"
try:
await self._query(query, readonly=False)
except Exception as e:
logger.error(f"[{self.workspace}] Error during node removal: {e}")
raise
async def remove_edges(self, edges: list[tuple[str, str]]) -> None:
"""
Remove multiple edges from the graph.
Args:
edges (list[tuple[str, str]]): A list of edges to remove, where each edge is a tuple of (source_node_id, target_node_id).
"""
for source, target in edges:
src_label = self._normalize_node_id(source)
tgt_label = self._normalize_node_id(target)
# Build Cypher query with dynamic dollar-quoting to handle entity_id containing $ sequences
cypher_query = f"""MATCH (a:base {{entity_id: "{src_label}"}})-[r]-(b:base {{entity_id: "{tgt_label}"}})
DELETE r"""
query = f"SELECT * FROM cypher({_dollar_quote(self.graph_name)}, {_dollar_quote(cypher_query)}) AS (r agtype)"
try:
await self._query(query, readonly=False)
logger.debug(
f"[{self.workspace}] Deleted edge from '{source}' to '{target}'"
)
except Exception as e:
logger.error(f"[{self.workspace}] Error during edge deletion: {str(e)}")
raise
async def get_nodes_batch(
self, node_ids: list[str], batch_size: int = 1000
) -> dict[str, dict]:
"""
Retrieve multiple nodes in one query using UNWIND.
Args:
node_ids: List of node entity IDs to fetch.
batch_size: Batch size for the query
Returns:
A dictionary mapping each node_id to its node data (or None if not found).
"""
if not node_ids:
return {}
seen: set[str] = set()
unique_ids: list[str] = []
lookup: dict[str, str] = {}
requested: set[str] = set()
for nid in node_ids:
if nid not in seen:
seen.add(nid)
unique_ids.append(nid)
requested.add(nid)
lookup[nid] = nid
lookup[self._normalize_node_id(nid)] = nid
# Build result dictionary
nodes_dict = {}
for i in range(0, len(unique_ids), batch_size):
batch = unique_ids[i : i + batch_size]
query = f"""
WITH input(v, ord) AS (
SELECT v, ord
FROM unnest($1::text[]) WITH ORDINALITY AS t(v, ord)
),
ids(node_id, ord) AS (
SELECT (to_json(v)::text)::agtype AS node_id, ord
FROM input
)
SELECT i.node_id::text AS node_id,
b.properties
FROM {self.graph_name}.base AS b
JOIN ids i
ON ag_catalog.agtype_access_operator(
VARIADIC ARRAY[b.properties, '"entity_id"'::agtype]
) = i.node_id
ORDER BY i.ord;
"""
results = await self._query(query, params={"ids": batch})
for result in results:
if result["node_id"] and result["properties"]:
node_dict = result["properties"]
# Process string result, parse it to JSON dictionary
if isinstance(node_dict, str):
try:
node_dict = json.loads(node_dict)
except json.JSONDecodeError:
logger.warning(
f"[{self.workspace}] Failed to parse node string in batch: {node_dict}"
)
node_key = result["node_id"]
original_key = lookup.get(node_key)
if original_key is None:
logger.warning(
f"[{self.workspace}] Node {node_key} not found in lookup map"
)
original_key = node_key
if original_key in requested:
nodes_dict[original_key] = node_dict
return nodes_dict
async def node_degrees_batch(
self, node_ids: list[str], batch_size: int = 500
) -> dict[str, int]:
"""
Retrieve the degree for multiple nodes in a single query using UNWIND.
Calculates the total degree by counting distinct relationships.
Uses separate queries for outgoing and incoming edges.
Args:
node_ids: List of node labels (entity_id values) to look up.
batch_size: Batch size for the query
Returns:
A dictionary mapping each node_id to its degree (total number of relationships).
If a node is not found, its degree will be set to 0.
"""
if not node_ids:
return {}
seen: set[str] = set()
unique_ids: list[str] = []
lookup: dict[str, str] = {}
requested: set[str] = set()
for nid in node_ids:
if nid not in seen:
seen.add(nid)
unique_ids.append(nid)
requested.add(nid)
lookup[nid] = nid
lookup[self._normalize_node_id(nid)] = nid
out_degrees = {}
in_degrees = {}
for i in range(0, len(unique_ids), batch_size):
batch = unique_ids[i : i + batch_size]
query = f"""
WITH input(v, ord) AS (
SELECT v, ord
FROM unnest($1::text[]) WITH ORDINALITY AS t(v, ord)
),
ids(node_id, ord) AS (
SELECT (to_json(v)::text)::agtype AS node_id, ord
FROM input
),
vids AS (
SELECT b.id AS vid, i.node_id, i.ord
FROM {self.graph_name}.base AS b
JOIN ids i
ON ag_catalog.agtype_access_operator(
VARIADIC ARRAY[b.properties, '"entity_id"'::agtype]
) = i.node_id
),
deg_out AS (
SELECT d.start_id AS vid, COUNT(*)::bigint AS out_degree
FROM {self.graph_name}."DIRECTED" AS d
JOIN vids v ON v.vid = d.start_id
GROUP BY d.start_id
),
deg_in AS (
SELECT d.end_id AS vid, COUNT(*)::bigint AS in_degree
FROM {self.graph_name}."DIRECTED" AS d
JOIN vids v ON v.vid = d.end_id
GROUP BY d.end_id
)
SELECT v.node_id::text AS node_id,
COALESCE(o.out_degree, 0) AS out_degree,
COALESCE(n.in_degree, 0) AS in_degree
FROM vids v
LEFT JOIN deg_out o ON o.vid = v.vid
LEFT JOIN deg_in n ON n.vid = v.vid
ORDER BY v.ord;
"""
combined_results = await self._query(query, params={"ids": batch})
for row in combined_results:
node_id = row["node_id"]
if not node_id:
continue
node_key = node_id
original_key = lookup.get(node_key)
if original_key is None:
logger.warning(
f"[{self.workspace}] Node {node_key} not found in lookup map"
)
original_key = node_key
if original_key in requested:
out_degrees[original_key] = int(row.get("out_degree", 0) or 0)
in_degrees[original_key] = int(row.get("in_degree", 0) or 0)
degrees_dict = {}
for node_id in node_ids:
out_degree = out_degrees.get(node_id, 0)
in_degree = in_degrees.get(node_id, 0)
degrees_dict[node_id] = out_degree + in_degree
return degrees_dict
async def edge_degrees_batch(
self, edges: list[tuple[str, str]]
) -> dict[tuple[str, str], int]:
"""
Calculate the combined degree for each edge (sum of the source and target node degrees)
in batch using the already implemented node_degrees_batch.
Args:
edges: List of (source_node_id, target_node_id) tuples
Returns:
Dictionary mapping edge tuples to their combined degrees
"""
if not edges:
return {}
# Use node_degrees_batch to get all node degrees efficiently
all_nodes = set()
for src, tgt in edges:
all_nodes.add(src)
all_nodes.add(tgt)
node_degrees = await self.node_degrees_batch(list(all_nodes))
# Calculate edge degrees
edge_degrees_dict = {}
for src, tgt in edges:
src_degree = node_degrees.get(src, 0)
tgt_degree = node_degrees.get(tgt, 0)
edge_degrees_dict[(src, tgt)] = src_degree + tgt_degree
return edge_degrees_dict
async def get_edges_batch(
self, pairs: list[dict[str, str]], batch_size: int = 500
) -> dict[tuple[str, str], dict]:
"""
Retrieve edge properties for multiple (src, tgt) pairs in one query.
Get forward and backward edges separately and merge them before return
Args:
pairs: List of dictionaries, e.g. [{"src": "node1", "tgt": "node2"}, ...]
batch_size: Batch size for the query
Returns:
A dictionary mapping (src, tgt) tuples to their edge properties.
"""
if not pairs:
return {}
seen = set()
uniq_pairs: list[dict[str, str]] = []
for p in pairs:
s = self._normalize_node_id(p["src"])
t = self._normalize_node_id(p["tgt"])
key = (s, t)
if s and t and key not in seen:
seen.add(key)
uniq_pairs.append(p)
edges_dict: dict[tuple[str, str], dict] = {}
for i in range(0, len(uniq_pairs), batch_size):
batch = uniq_pairs[i : i + batch_size]
pairs = [{"src": p["src"], "tgt": p["tgt"]} for p in batch]
forward_cypher = """
UNWIND $pairs AS p
WITH p.src AS src_eid, p.tgt AS tgt_eid
MATCH (a:base {entity_id: src_eid})
MATCH (b:base {entity_id: tgt_eid})
MATCH (a)-[r]->(b)
RETURN src_eid AS source, tgt_eid AS target, properties(r) AS edge_properties"""
backward_cypher = """
UNWIND $pairs AS p
WITH p.src AS src_eid, p.tgt AS tgt_eid
MATCH (a:base {entity_id: src_eid})
MATCH (b:base {entity_id: tgt_eid})
MATCH (a)<-[r]-(b)
RETURN src_eid AS source, tgt_eid AS target, properties(r) AS edge_properties"""
sql_fwd = f"""
SELECT * FROM cypher({_dollar_quote(self.graph_name)}::name,
{_dollar_quote(forward_cypher)}::cstring,
$1::agtype)
AS (source text, target text, edge_properties agtype)
"""
sql_bwd = f"""
SELECT * FROM cypher({_dollar_quote(self.graph_name)}::name,
{_dollar_quote(backward_cypher)}::cstring,
$1::agtype)
AS (source text, target text, edge_properties agtype)
"""
pg_params = {"params": json.dumps({"pairs": pairs}, ensure_ascii=False)}
forward_results = await self._query(sql_fwd, params=pg_params)
backward_results = await self._query(sql_bwd, params=pg_params)
for result in forward_results:
if result["source"] and result["target"] and result["edge_properties"]:
edge_props = result["edge_properties"]
# Process string result, parse it to JSON dictionary
if isinstance(edge_props, str):
try:
edge_props = json.loads(edge_props)
except json.JSONDecodeError:
logger.warning(
f"[{self.workspace}]Failed to parse edge properties string: {edge_props}"
)
continue
edges_dict[(result["source"], result["target"])] = edge_props
for result in backward_results:
if result["source"] and result["target"] and result["edge_properties"]:
edge_props = result["edge_properties"]
# Process string result, parse it to JSON dictionary
if isinstance(edge_props, str):
try:
edge_props = json.loads(edge_props)
except json.JSONDecodeError:
logger.warning(
f"[{self.workspace}] Failed to parse edge properties string: {edge_props}"
)
continue
edges_dict[(result["source"], result["target"])] = edge_props
return edges_dict
async def get_nodes_edges_batch(
self, node_ids: list[str], batch_size: int = 500
) -> dict[str, list[tuple[str, str]]]:
"""
Get all edges (both outgoing and incoming) for multiple nodes in a single batch operation.
Args:
node_ids: List of node IDs to get edges for
batch_size: Batch size for the query
Returns:
Dictionary mapping node IDs to lists of (source, target) edge tuples
"""
if not node_ids:
return {}
seen = set()
unique_ids: list[str] = []
for nid in node_ids:
if nid and nid not in seen:
seen.add(nid)
unique_ids.append(nid)
edges_norm: dict[str, list[tuple[str, str]]] = {n: [] for n in unique_ids}
for i in range(0, len(unique_ids), batch_size):
batch = unique_ids[i : i + batch_size]
pg_params = {"params": json.dumps({"node_ids": batch}, ensure_ascii=False)}
outgoing_cypher = """UNWIND $node_ids AS node_id
MATCH (n:base {entity_id: node_id})
OPTIONAL MATCH (n:base)-[]->(connected:base)
RETURN node_id, connected.entity_id AS connected_id"""
incoming_cypher = """UNWIND $node_ids AS node_id
MATCH (n:base {entity_id: node_id})
OPTIONAL MATCH (n:base)<-[]-(connected:base)
RETURN node_id, connected.entity_id AS connected_id"""
outgoing_query = f"SELECT * FROM cypher({_dollar_quote(self.graph_name)}::name, {_dollar_quote(outgoing_cypher)}::cstring, $1::agtype) AS (node_id text, connected_id text)"
incoming_query = f"SELECT * FROM cypher({_dollar_quote(self.graph_name)}::name, {_dollar_quote(incoming_cypher)}::cstring, $1::agtype) AS (node_id text, connected_id text)"
outgoing_results = await self._query(outgoing_query, params=pg_params)
incoming_results = await self._query(incoming_query, params=pg_params)
for result in outgoing_results:
if result["node_id"] and result["connected_id"]:
edges_norm[result["node_id"]].append(
(result["node_id"], result["connected_id"])
)
for result in incoming_results:
if result["node_id"] and result["connected_id"]:
edges_norm[result["node_id"]].append(
(result["connected_id"], result["node_id"])
)
out: dict[str, list[tuple[str, str]]] = {}
for orig in node_ids:
out[orig] = edges_norm.get(orig, [])
return out
async def get_all_labels(self) -> list[str]:
"""
Get all labels(node IDs, entity names) in the graph.
Returns:
list[str]: A list of all labels in the graph.
"""
query = (
"""SELECT * FROM cypher('%s', $$
MATCH (n:base)
WHERE n.entity_id IS NOT NULL
RETURN DISTINCT n.entity_id AS label
ORDER BY n.entity_id
$$) AS (label text)"""
% self.graph_name
)
results = await self._query(query)
labels = []
for result in results:
if result and isinstance(result, dict) and "label" in result:
labels.append(result["label"])
return labels
async def _bfs_subgraph(
self, node_label: str, max_depth: int, max_nodes: int
) -> KnowledgeGraph:
"""
Implements a true breadth-first search algorithm for subgraph retrieval.
This method is used as a fallback when the standard Cypher query is too slow
or when we need to guarantee BFS ordering.
Args:
node_label: Label of the starting node
max_depth: Maximum depth of the subgraph
max_nodes: Maximum number of nodes to return
Returns:
KnowledgeGraph object containing nodes and edges
"""
from collections import deque
result = KnowledgeGraph()
visited_nodes = set()
visited_node_ids = set()
visited_edges = set()
visited_edge_pairs = set()
# Get starting node data
label = self._normalize_node_id(node_label)
# Build Cypher query with dynamic dollar-quoting to handle entity_id containing $ sequences
cypher_query = f"""MATCH (n:base {{entity_id: "{label}"}})
RETURN id(n) as node_id, n"""
query = f"SELECT * FROM cypher({_dollar_quote(self.graph_name)}, {_dollar_quote(cypher_query)}) AS (node_id bigint, n agtype)"
node_result = await self._query(query)
if not node_result or not node_result[0].get("n"):
return result
# Create initial KnowledgeGraphNode
start_node_data = node_result[0]["n"]
entity_id = start_node_data["properties"]["entity_id"]
internal_id = str(start_node_data["id"])
start_node = KnowledgeGraphNode(
id=internal_id,
labels=[entity_id],
properties=start_node_data["properties"],
)
# Initialize BFS queue, each element is a tuple of (node, depth)
queue = deque([(start_node, 0)])
visited_nodes.add(entity_id)
visited_node_ids.add(internal_id)
result.nodes.append(start_node)
result.is_truncated = False
# BFS search main loop
while queue:
# Get all nodes at the current depth
current_level_nodes = []
current_depth = None
# Determine current depth
if queue:
current_depth = queue[0][1]
# Extract all nodes at current depth from the queue
while queue and queue[0][1] == current_depth:
node, depth = queue.popleft()
if depth > max_depth:
continue
current_level_nodes.append(node)
if not current_level_nodes:
continue
# Check depth limit
if current_depth > max_depth:
continue
# Prepare node IDs list
node_ids = [node.labels[0] for node in current_level_nodes]
formatted_ids = ", ".join(
[f'"{self._normalize_node_id(node_id)}"' for node_id in node_ids]
)
# Build Cypher queries with dynamic dollar-quoting to handle entity_id containing $ sequences
outgoing_cypher = f"""UNWIND [{formatted_ids}] AS node_id
MATCH (n:base {{entity_id: node_id}})
OPTIONAL MATCH (n)-[r]->(neighbor:base)
RETURN node_id AS current_id,
id(n) AS current_internal_id,
id(neighbor) AS neighbor_internal_id,
neighbor.entity_id AS neighbor_id,
id(r) AS edge_id,
r,
neighbor,
true AS is_outgoing"""
incoming_cypher = f"""UNWIND [{formatted_ids}] AS node_id
MATCH (n:base {{entity_id: node_id}})
OPTIONAL MATCH (n)<-[r]-(neighbor:base)
RETURN node_id AS current_id,
id(n) AS current_internal_id,
id(neighbor) AS neighbor_internal_id,
neighbor.entity_id AS neighbor_id,
id(r) AS edge_id,
r,
neighbor,
false AS is_outgoing"""
outgoing_query = f"SELECT * FROM cypher({_dollar_quote(self.graph_name)}, {_dollar_quote(outgoing_cypher)}) AS (current_id text, current_internal_id bigint, neighbor_internal_id bigint, neighbor_id text, edge_id bigint, r agtype, neighbor agtype, is_outgoing bool)"
incoming_query = f"SELECT * FROM cypher({_dollar_quote(self.graph_name)}, {_dollar_quote(incoming_cypher)}) AS (current_id text, current_internal_id bigint, neighbor_internal_id bigint, neighbor_id text, edge_id bigint, r agtype, neighbor agtype, is_outgoing bool)"
# Execute queries
outgoing_results = await self._query(outgoing_query)
incoming_results = await self._query(incoming_query)
# Combine results
neighbors = outgoing_results + incoming_results
# Create mapping from node ID to node object
node_map = {node.labels[0]: node for node in current_level_nodes}
# Process all results in a single loop
for record in neighbors:
if not record.get("neighbor") or not record.get("r"):
continue
# Get current node information
current_entity_id = record["current_id"]
current_node = node_map[current_entity_id]
# Get neighbor node information
neighbor_entity_id = record["neighbor_id"]
neighbor_internal_id = str(record["neighbor_internal_id"])
is_outgoing = record["is_outgoing"]
# Determine edge direction
if is_outgoing:
source_id = current_node.id
target_id = neighbor_internal_id
else:
source_id = neighbor_internal_id
target_id = current_node.id
if not neighbor_entity_id:
continue
# Get edge and node information
b_node = record["neighbor"]
rel = record["r"]
edge_id = str(record["edge_id"])
# Create neighbor node object
neighbor_node = KnowledgeGraphNode(
id=neighbor_internal_id,
labels=[neighbor_entity_id],
properties=b_node["properties"],
)
# Sort entity_ids to ensure (A,B) and (B,A) are treated as the same edge
sorted_pair = tuple(sorted([current_entity_id, neighbor_entity_id]))
# Create edge object
edge = KnowledgeGraphEdge(
id=edge_id,
type=rel["label"],
source=source_id,
target=target_id,
properties=rel["properties"],
)
if neighbor_internal_id in visited_node_ids:
# Add backward edge if neighbor node is already visited
if (
edge_id not in visited_edges
and sorted_pair not in visited_edge_pairs
):
result.edges.append(edge)
visited_edges.add(edge_id)
visited_edge_pairs.add(sorted_pair)
else:
if len(visited_node_ids) < max_nodes and current_depth < max_depth:
# Add new node to result and queue
result.nodes.append(neighbor_node)
visited_nodes.add(neighbor_entity_id)
visited_node_ids.add(neighbor_internal_id)
# Add node to queue with incremented depth
queue.append((neighbor_node, current_depth + 1))
# Add forward edge
if (
edge_id not in visited_edges
and sorted_pair not in visited_edge_pairs
):
result.edges.append(edge)
visited_edges.add(edge_id)
visited_edge_pairs.add(sorted_pair)
else:
if current_depth < max_depth:
result.is_truncated = True
return result
async def get_knowledge_graph(
self,
node_label: str,
max_depth: int = 3,
max_nodes: int = None,
) -> KnowledgeGraph:
"""
Retrieve a connected subgraph of nodes where the label includes the specified `node_label`.
Args:
node_label: Label of the starting node, * means all nodes
max_depth: Maximum depth of the subgraph, Defaults to 3
max_nodes: Maximum nodes to return, Defaults to global_config max_graph_nodes
Returns:
KnowledgeGraph object containing nodes and edges, with an is_truncated flag
indicating whether the graph was truncated due to max_nodes limit
"""
# Use global_config max_graph_nodes as default if max_nodes is None
if max_nodes is None:
max_nodes = self.global_config.get("max_graph_nodes", 1000)
else:
# Limit max_nodes to not exceed global_config max_graph_nodes
max_nodes = min(max_nodes, self.global_config.get("max_graph_nodes", 1000))
kg = KnowledgeGraph()
# Handle wildcard query - get all nodes
if node_label == "*":
# First check total node count to determine if graph should be truncated
count_query = f"""SELECT * FROM cypher('{self.graph_name}', $$
MATCH (n:base)
RETURN count(distinct n) AS total_nodes
$$) AS (total_nodes bigint)"""
count_result = await self._query(count_query)
total_nodes = count_result[0]["total_nodes"] if count_result else 0
is_truncated = total_nodes > max_nodes
# Get max_nodes with highest degrees
query_nodes = f"""SELECT * FROM cypher('{self.graph_name}', $$
MATCH (n:base)
OPTIONAL MATCH (n)-[r]->()
RETURN id(n) as node_id, count(r) as degree
$$) AS (node_id BIGINT, degree BIGINT)
ORDER BY degree DESC
LIMIT {max_nodes}"""
node_results = await self._query(query_nodes)
node_ids = [str(result["node_id"]) for result in node_results]
logger.info(
f"[{self.workspace}] Total nodes: {total_nodes}, Selected nodes: {len(node_ids)}"
)
if node_ids:
formatted_ids = ", ".join(node_ids)
# Construct batch query for subgraph within max_nodes
query = f"""SELECT * FROM cypher('{self.graph_name}', $$
WITH [{formatted_ids}] AS node_ids
MATCH (a)
WHERE id(a) IN node_ids
OPTIONAL MATCH (a)-[r]->(b)
WHERE id(b) IN node_ids
RETURN a, r, b
$$) AS (a AGTYPE, r AGTYPE, b AGTYPE)"""
results = await self._query(query)
# Process query results, deduplicate nodes and edges
nodes_dict = {}
edges_dict = {}
for result in results:
# Process node a
if result.get("a") and isinstance(result["a"], dict):
node_a = result["a"]
node_id = str(node_a["id"])
if node_id not in nodes_dict and "properties" in node_a:
nodes_dict[node_id] = KnowledgeGraphNode(
id=node_id,
labels=[node_a["properties"]["entity_id"]],
properties=node_a["properties"],
)
# Process node b
if result.get("b") and isinstance(result["b"], dict):
node_b = result["b"]
node_id = str(node_b["id"])
if node_id not in nodes_dict and "properties" in node_b:
nodes_dict[node_id] = KnowledgeGraphNode(
id=node_id,
labels=[node_b["properties"]["entity_id"]],
properties=node_b["properties"],
)
# Process edge r
if result.get("r") and isinstance(result["r"], dict):
edge = result["r"]
edge_id = str(edge["id"])
if edge_id not in edges_dict:
edges_dict[edge_id] = KnowledgeGraphEdge(
id=edge_id,
type=edge["label"],
source=str(edge["start_id"]),
target=str(edge["end_id"]),
properties=edge["properties"],
)
kg = KnowledgeGraph(
nodes=list(nodes_dict.values()),
edges=list(edges_dict.values()),
is_truncated=is_truncated,
)
else:
# For single node query, use BFS algorithm
kg = await self._bfs_subgraph(node_label, max_depth, max_nodes)
logger.info(
f"[{self.workspace}] Subgraph query successful | Node count: {len(kg.nodes)} | Edge count: {len(kg.edges)}"
)
else:
# For non-wildcard queries, use the BFS algorithm
kg = await self._bfs_subgraph(node_label, max_depth, max_nodes)
logger.info(
f"[{self.workspace}] Subgraph query for '{node_label}' successful | Node count: {len(kg.nodes)} | Edge count: {len(kg.edges)}"
)
return kg
async def get_all_nodes(self) -> list[dict]:
"""Get all nodes in the graph.
Returns:
A list of all nodes, where each node is a dictionary of its properties
"""
# Use native SQL to avoid Cypher wrapper overhead
# Original: SELECT * FROM cypher(...) with MATCH (n:base)
# Optimized: Direct table access for better performance
query = f"""
SELECT properties
FROM {self.graph_name}.base
"""
results = await self._query(query)
nodes = []
for result in results:
if result.get("properties"):
node_dict = result["properties"]
# Process string result, parse it to JSON dictionary
if isinstance(node_dict, str):
try:
node_dict = json.loads(node_dict)
except json.JSONDecodeError:
logger.warning(
f"[{self.workspace}] Failed to parse node string: {node_dict}"
)
continue
# Add node id (entity_id) to the dictionary for easier access
node_dict["id"] = node_dict.get("entity_id")
nodes.append(node_dict)
return nodes
async def get_all_edges(self) -> list[dict]:
"""Get all edges in the graph.
Returns:
A list of all edges, where each edge is a dictionary of its properties
(If 2 directional edges exist between the same pair of nodes, deduplication must be handled by the caller)
"""
# Use native SQL to avoid Cartesian product (N×N) in Cypher MATCH
# Original Cypher: MATCH (a:base)-[r]-(b:base) creates ~50 billion row combinations
# Optimized: Start from edges table, join to nodes only to get entity_id
# Performance: O(E) instead of O(N²), ~50,000x faster for large graphs
query = f"""
SELECT DISTINCT
(ag_catalog.agtype_access_operator(VARIADIC ARRAY[a.properties, '"entity_id"'::agtype]))::text AS source,
(ag_catalog.agtype_access_operator(VARIADIC ARRAY[b.properties, '"entity_id"'::agtype]))::text AS target,
r.properties
FROM {self.graph_name}."DIRECTED" r
JOIN {self.graph_name}.base a ON r.start_id = a.id
JOIN {self.graph_name}.base b ON r.end_id = b.id
"""
results = await self._query(query)
edges = []
for result in results:
edge_properties = result["properties"]
# Process string result, parse it to JSON dictionary
if isinstance(edge_properties, str):
try:
edge_properties = json.loads(edge_properties)
except json.JSONDecodeError:
logger.warning(
f"[{self.workspace}] Failed to parse edge properties string: {edge_properties}"
)
edge_properties = {}
edge_properties["source"] = result["source"]
edge_properties["target"] = result["target"]
edges.append(edge_properties)
return edges
async def get_popular_labels(self, limit: int = 300) -> list[str]:
"""Get popular labels by node degree (most connected entities) using native SQL for performance."""
try:
# Native SQL query to calculate node degrees directly from AGE's underlying tables
# This is significantly faster than using the cypher() function wrapper
query = f"""
WITH node_degrees AS (
SELECT
node_id,
COUNT(*) AS degree
FROM (
SELECT start_id AS node_id FROM {self.graph_name}._ag_label_edge
UNION ALL
SELECT end_id AS node_id FROM {self.graph_name}._ag_label_edge
) AS all_edges
GROUP BY node_id
)
SELECT
(ag_catalog.agtype_access_operator(VARIADIC ARRAY[v.properties, '"entity_id"'::agtype]))::text AS label
FROM
node_degrees d
JOIN
{self.graph_name}._ag_label_vertex v ON d.node_id = v.id
WHERE
ag_catalog.agtype_access_operator(VARIADIC ARRAY[v.properties, '"entity_id"'::agtype]) IS NOT NULL
ORDER BY
d.degree DESC,
label ASC
LIMIT $1;
"""
results = await self._query(query, params={"limit": limit})
labels = [
result["label"] for result in results if result and "label" in result
]
logger.debug(
f"[{self.workspace}] Retrieved {len(labels)} popular labels (limit: {limit})"
)
return labels
except Exception as e:
logger.error(f"[{self.workspace}] Error getting popular labels: {str(e)}")
return []
async def search_labels(self, query: str, limit: int = 50) -> list[str]:
"""Search labels with fuzzy matching using native, parameterized SQL for performance and security."""
query_lower = query.lower().strip()
if not query_lower:
return []
try:
# Re-implementing with the correct agtype access operator and full scoring logic.
sql_query = f"""
WITH ranked_labels AS (
SELECT
(ag_catalog.agtype_access_operator(VARIADIC ARRAY[properties, '"entity_id"'::agtype]))::text AS label,
LOWER((ag_catalog.agtype_access_operator(VARIADIC ARRAY[properties, '"entity_id"'::agtype]))::text) AS label_lower
FROM
{self.graph_name}._ag_label_vertex
WHERE
ag_catalog.agtype_access_operator(VARIADIC ARRAY[properties, '"entity_id"'::agtype]) IS NOT NULL
AND LOWER((ag_catalog.agtype_access_operator(VARIADIC ARRAY[properties, '"entity_id"'::agtype]))::text) ILIKE $1
)
SELECT
label
FROM (
SELECT
label,
CASE
WHEN label_lower = $2 THEN 1000
WHEN label_lower LIKE $3 THEN 500
ELSE (100 - LENGTH(label))
END +
CASE
WHEN label_lower LIKE $4 OR label_lower LIKE $5 THEN 50
ELSE 0
END AS score
FROM
ranked_labels
) AS scored_labels
ORDER BY
score DESC,
label ASC
LIMIT $6;
"""
params = (
f"%{query_lower}%", # For the main ILIKE clause ($1)
query_lower, # For exact match ($2)
f"{query_lower}%", # For prefix match ($3)
f"% {query_lower}%", # For word boundary (space) ($4)
f"%_{query_lower}%", # For word boundary (underscore) ($5)
limit, # For LIMIT ($6)
)
results = await self._query(sql_query, params=dict(enumerate(params, 1)))
labels = [
result["label"] for result in results if result and "label" in result
]
logger.debug(
f"[{self.workspace}] Search query '{query}' returned {len(labels)} results (limit: {limit})"
)
return labels
except Exception as e:
logger.error(
f"[{self.workspace}] Error searching labels with query '{query}': {str(e)}"
)
return []
async def drop(self) -> dict[str, str]:
"""Drop the storage"""
try:
drop_query = f"""SELECT * FROM cypher('{self.graph_name}', $$
MATCH (n)
DETACH DELETE n
$$) AS (result agtype)"""
await self._query(drop_query, readonly=False)
return {
"status": "success",
"message": f"workspace '{self.workspace}' graph data dropped",
}
except Exception as e:
logger.error(f"[{self.workspace}] Error dropping graph: {e}")
return {"status": "error", "message": str(e)}
# Note: Order matters! More specific namespaces (e.g., "full_entities") must come before
# more general ones (e.g., "entities") because is_namespace() uses endswith() matching
NAMESPACE_TABLE_MAP = {
NameSpace.KV_STORE_FULL_DOCS: "LIGHTRAG_DOC_FULL",
NameSpace.KV_STORE_TEXT_CHUNKS: "LIGHTRAG_DOC_CHUNKS",
NameSpace.KV_STORE_FULL_ENTITIES: "LIGHTRAG_FULL_ENTITIES",
NameSpace.KV_STORE_FULL_RELATIONS: "LIGHTRAG_FULL_RELATIONS",
NameSpace.KV_STORE_ENTITY_CHUNKS: "LIGHTRAG_ENTITY_CHUNKS",
NameSpace.KV_STORE_RELATION_CHUNKS: "LIGHTRAG_RELATION_CHUNKS",
NameSpace.KV_STORE_LLM_RESPONSE_CACHE: "LIGHTRAG_LLM_CACHE",
NameSpace.VECTOR_STORE_CHUNKS: "LIGHTRAG_VDB_CHUNKS",
NameSpace.VECTOR_STORE_ENTITIES: "LIGHTRAG_VDB_ENTITY",
NameSpace.VECTOR_STORE_RELATIONSHIPS: "LIGHTRAG_VDB_RELATION",
NameSpace.DOC_STATUS: "LIGHTRAG_DOC_STATUS",
}
def namespace_to_table_name(namespace: str) -> str:
for k, v in NAMESPACE_TABLE_MAP.items():
if is_namespace(namespace, k):
return v
TABLES = {
"LIGHTRAG_DOC_FULL": {
"ddl": """CREATE TABLE LIGHTRAG_DOC_FULL (
id VARCHAR(255),
workspace VARCHAR(255),
doc_name VARCHAR(1024),
content TEXT,
meta JSONB,
create_time TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP,
update_time TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP,
CONSTRAINT LIGHTRAG_DOC_FULL_PK PRIMARY KEY (workspace, id)
)"""
},
"LIGHTRAG_DOC_CHUNKS": {
"ddl": """CREATE TABLE LIGHTRAG_DOC_CHUNKS (
id VARCHAR(255),
workspace VARCHAR(255),
full_doc_id VARCHAR(256),
chunk_order_index INTEGER,
tokens INTEGER,
content TEXT,
file_path TEXT NULL,
llm_cache_list JSONB NULL DEFAULT '[]'::jsonb,
create_time TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP,
update_time TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP,
CONSTRAINT LIGHTRAG_DOC_CHUNKS_PK PRIMARY KEY (workspace, id)
)"""
},
"LIGHTRAG_VDB_CHUNKS": {
"ddl": """CREATE TABLE LIGHTRAG_VDB_CHUNKS (
id VARCHAR(255),
workspace VARCHAR(255),
full_doc_id VARCHAR(256),
chunk_order_index INTEGER,
tokens INTEGER,
content TEXT,
content_vector VECTOR(dimension),
file_path TEXT NULL,
create_time TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP,
update_time TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP,
CONSTRAINT LIGHTRAG_VDB_CHUNKS_PK PRIMARY KEY (workspace, id)
)"""
},
"LIGHTRAG_VDB_ENTITY": {
"ddl": """CREATE TABLE LIGHTRAG_VDB_ENTITY (
id VARCHAR(255),
workspace VARCHAR(255),
entity_name VARCHAR(512),
content TEXT,
content_vector VECTOR(dimension),
create_time TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP,
update_time TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP,
chunk_ids VARCHAR(255)[] NULL,
file_path TEXT NULL,
CONSTRAINT LIGHTRAG_VDB_ENTITY_PK PRIMARY KEY (workspace, id)
)"""
},
"LIGHTRAG_VDB_RELATION": {
"ddl": """CREATE TABLE LIGHTRAG_VDB_RELATION (
id VARCHAR(255),
workspace VARCHAR(255),
source_id VARCHAR(512),
target_id VARCHAR(512),
content TEXT,
content_vector VECTOR(dimension),
create_time TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP,
update_time TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP,
chunk_ids VARCHAR(255)[] NULL,
file_path TEXT NULL,
CONSTRAINT LIGHTRAG_VDB_RELATION_PK PRIMARY KEY (workspace, id)
)"""
},
"LIGHTRAG_LLM_CACHE": {
"ddl": """CREATE TABLE LIGHTRAG_LLM_CACHE (
workspace varchar(255) NOT NULL,
id varchar(255) NOT NULL,
original_prompt TEXT,
return_value TEXT,
chunk_id VARCHAR(255) NULL,
cache_type VARCHAR(32),
queryparam JSONB NULL,
create_time TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
update_time TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
CONSTRAINT LIGHTRAG_LLM_CACHE_PK PRIMARY KEY (workspace, id)
)"""
},
"LIGHTRAG_DOC_STATUS": {
"ddl": """CREATE TABLE LIGHTRAG_DOC_STATUS (
workspace varchar(255) NOT NULL,
id varchar(255) NOT NULL,
content_summary varchar(255) NULL,
content_length int4 NULL,
chunks_count int4 NULL,
status varchar(64) NULL,
file_path TEXT NULL,
chunks_list JSONB NULL DEFAULT '[]'::jsonb,
track_id varchar(255) NULL,
metadata JSONB NULL DEFAULT '{}'::jsonb,
error_msg TEXT NULL,
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
CONSTRAINT LIGHTRAG_DOC_STATUS_PK PRIMARY KEY (workspace, id)
)"""
},
"LIGHTRAG_FULL_ENTITIES": {
"ddl": """CREATE TABLE LIGHTRAG_FULL_ENTITIES (
id VARCHAR(255),
workspace VARCHAR(255),
entity_names JSONB,
count INTEGER,
create_time TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP,
update_time TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP,
CONSTRAINT LIGHTRAG_FULL_ENTITIES_PK PRIMARY KEY (workspace, id)
)"""
},
"LIGHTRAG_FULL_RELATIONS": {
"ddl": """CREATE TABLE LIGHTRAG_FULL_RELATIONS (
id VARCHAR(255),
workspace VARCHAR(255),
relation_pairs JSONB,
count INTEGER,
create_time TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP,
update_time TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP,
CONSTRAINT LIGHTRAG_FULL_RELATIONS_PK PRIMARY KEY (workspace, id)
)"""
},
"LIGHTRAG_ENTITY_CHUNKS": {
"ddl": """CREATE TABLE LIGHTRAG_ENTITY_CHUNKS (
id VARCHAR(512),
workspace VARCHAR(255),
chunk_ids JSONB,
count INTEGER,
create_time TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP,
update_time TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP,
CONSTRAINT LIGHTRAG_ENTITY_CHUNKS_PK PRIMARY KEY (workspace, id)
)"""
},
"LIGHTRAG_RELATION_CHUNKS": {
"ddl": """CREATE TABLE LIGHTRAG_RELATION_CHUNKS (
id VARCHAR(512),
workspace VARCHAR(255),
chunk_ids JSONB,
count INTEGER,
create_time TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP,
update_time TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP,
CONSTRAINT LIGHTRAG_RELATION_CHUNKS_PK PRIMARY KEY (workspace, id)
)"""
},
}
SQL_TEMPLATES = {
# SQL for KVStorage
"get_by_id_full_docs": """SELECT id, COALESCE(content, '') as content,
COALESCE(doc_name, '') as file_path
FROM LIGHTRAG_DOC_FULL WHERE workspace=$1 AND id=$2
""",
"get_by_id_text_chunks": """SELECT id, tokens, COALESCE(content, '') as content,
chunk_order_index, full_doc_id, file_path,
COALESCE(llm_cache_list, '[]'::jsonb) as llm_cache_list,
EXTRACT(EPOCH FROM create_time)::BIGINT as create_time,
EXTRACT(EPOCH FROM update_time)::BIGINT as update_time
FROM LIGHTRAG_DOC_CHUNKS WHERE workspace=$1 AND id=$2
""",
"get_by_id_llm_response_cache": """SELECT id, original_prompt, return_value, chunk_id, cache_type, queryparam,
EXTRACT(EPOCH FROM create_time)::BIGINT as create_time,
EXTRACT(EPOCH FROM update_time)::BIGINT as update_time
FROM LIGHTRAG_LLM_CACHE WHERE workspace=$1 AND id=$2
""",
"get_by_ids_full_docs": """SELECT id, COALESCE(content, '') as content,
COALESCE(doc_name, '') as file_path
FROM LIGHTRAG_DOC_FULL WHERE workspace=$1 AND id = ANY($2)
""",
"get_by_ids_text_chunks": """SELECT id, tokens, COALESCE(content, '') as content,
chunk_order_index, full_doc_id, file_path,
COALESCE(llm_cache_list, '[]'::jsonb) as llm_cache_list,
EXTRACT(EPOCH FROM create_time)::BIGINT as create_time,
EXTRACT(EPOCH FROM update_time)::BIGINT as update_time
FROM LIGHTRAG_DOC_CHUNKS WHERE workspace=$1 AND id = ANY($2)
""",
"get_by_ids_llm_response_cache": """SELECT id, original_prompt, return_value, chunk_id, cache_type, queryparam,
EXTRACT(EPOCH FROM create_time)::BIGINT as create_time,
EXTRACT(EPOCH FROM update_time)::BIGINT as update_time
FROM LIGHTRAG_LLM_CACHE WHERE workspace=$1 AND id = ANY($2)
""",
"get_by_id_full_entities": """SELECT id, entity_names, count,
EXTRACT(EPOCH FROM create_time)::BIGINT as create_time,
EXTRACT(EPOCH FROM update_time)::BIGINT as update_time
FROM LIGHTRAG_FULL_ENTITIES WHERE workspace=$1 AND id=$2
""",
"get_by_id_full_relations": """SELECT id, relation_pairs, count,
EXTRACT(EPOCH FROM create_time)::BIGINT as create_time,
EXTRACT(EPOCH FROM update_time)::BIGINT as update_time
FROM LIGHTRAG_FULL_RELATIONS WHERE workspace=$1 AND id=$2
""",
"get_by_ids_full_entities": """SELECT id, entity_names, count,
EXTRACT(EPOCH FROM create_time)::BIGINT as create_time,
EXTRACT(EPOCH FROM update_time)::BIGINT as update_time
FROM LIGHTRAG_FULL_ENTITIES WHERE workspace=$1 AND id = ANY($2)
""",
"get_by_ids_full_relations": """SELECT id, relation_pairs, count,
EXTRACT(EPOCH FROM create_time)::BIGINT as create_time,
EXTRACT(EPOCH FROM update_time)::BIGINT as update_time
FROM LIGHTRAG_FULL_RELATIONS WHERE workspace=$1 AND id = ANY($2)
""",
"get_by_id_entity_chunks": """SELECT id, chunk_ids, count,
EXTRACT(EPOCH FROM create_time)::BIGINT as create_time,
EXTRACT(EPOCH FROM update_time)::BIGINT as update_time
FROM LIGHTRAG_ENTITY_CHUNKS WHERE workspace=$1 AND id=$2
""",
"get_by_id_relation_chunks": """SELECT id, chunk_ids, count,
EXTRACT(EPOCH FROM create_time)::BIGINT as create_time,
EXTRACT(EPOCH FROM update_time)::BIGINT as update_time
FROM LIGHTRAG_RELATION_CHUNKS WHERE workspace=$1 AND id=$2
""",
"get_by_ids_entity_chunks": """SELECT id, chunk_ids, count,
EXTRACT(EPOCH FROM create_time)::BIGINT as create_time,
EXTRACT(EPOCH FROM update_time)::BIGINT as update_time
FROM LIGHTRAG_ENTITY_CHUNKS WHERE workspace=$1 AND id = ANY($2)
""",
"get_by_ids_relation_chunks": """SELECT id, chunk_ids, count,
EXTRACT(EPOCH FROM create_time)::BIGINT as create_time,
EXTRACT(EPOCH FROM update_time)::BIGINT as update_time
FROM LIGHTRAG_RELATION_CHUNKS WHERE workspace=$1 AND id = ANY($2)
""",
"filter_keys": "SELECT id FROM {table_name} WHERE workspace=$1 AND id IN ({ids})",
"upsert_doc_full": """INSERT INTO LIGHTRAG_DOC_FULL (id, content, doc_name, workspace)
VALUES ($1, $2, $3, $4)
ON CONFLICT (workspace,id) DO UPDATE
SET content = $2,
doc_name = $3,
update_time = CURRENT_TIMESTAMP
""",
"upsert_llm_response_cache": """INSERT INTO LIGHTRAG_LLM_CACHE(workspace,id,original_prompt,return_value,chunk_id,cache_type,queryparam)
VALUES ($1, $2, $3, $4, $5, $6, $7)
ON CONFLICT (workspace,id) DO UPDATE
SET original_prompt = EXCLUDED.original_prompt,
return_value=EXCLUDED.return_value,
chunk_id=EXCLUDED.chunk_id,
cache_type=EXCLUDED.cache_type,
queryparam=EXCLUDED.queryparam,
update_time = CURRENT_TIMESTAMP
""",
"upsert_text_chunk": """INSERT INTO LIGHTRAG_DOC_CHUNKS (workspace, id, tokens,
chunk_order_index, full_doc_id, content, file_path, llm_cache_list,
create_time, update_time)
VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10)
ON CONFLICT (workspace,id) DO UPDATE
SET tokens=EXCLUDED.tokens,
chunk_order_index=EXCLUDED.chunk_order_index,
full_doc_id=EXCLUDED.full_doc_id,
content = EXCLUDED.content,
file_path=EXCLUDED.file_path,
llm_cache_list=EXCLUDED.llm_cache_list,
update_time = EXCLUDED.update_time
""",
"upsert_full_entities": """INSERT INTO LIGHTRAG_FULL_ENTITIES (workspace, id, entity_names, count,
create_time, update_time)
VALUES ($1, $2, $3, $4, $5, $6)
ON CONFLICT (workspace,id) DO UPDATE
SET entity_names=EXCLUDED.entity_names,
count=EXCLUDED.count,
update_time = EXCLUDED.update_time
""",
"upsert_full_relations": """INSERT INTO LIGHTRAG_FULL_RELATIONS (workspace, id, relation_pairs, count,
create_time, update_time)
VALUES ($1, $2, $3, $4, $5, $6)
ON CONFLICT (workspace,id) DO UPDATE
SET relation_pairs=EXCLUDED.relation_pairs,
count=EXCLUDED.count,
update_time = EXCLUDED.update_time
""",
"upsert_entity_chunks": """INSERT INTO LIGHTRAG_ENTITY_CHUNKS (workspace, id, chunk_ids, count,
create_time, update_time)
VALUES ($1, $2, $3, $4, $5, $6)
ON CONFLICT (workspace,id) DO UPDATE
SET chunk_ids=EXCLUDED.chunk_ids,
count=EXCLUDED.count,
update_time = EXCLUDED.update_time
""",
"upsert_relation_chunks": """INSERT INTO LIGHTRAG_RELATION_CHUNKS (workspace, id, chunk_ids, count,
create_time, update_time)
VALUES ($1, $2, $3, $4, $5, $6)
ON CONFLICT (workspace,id) DO UPDATE
SET chunk_ids=EXCLUDED.chunk_ids,
count=EXCLUDED.count,
update_time = EXCLUDED.update_time
""",
# SQL for VectorStorage
"upsert_chunk": """INSERT INTO {table_name} (workspace, id, tokens,
chunk_order_index, full_doc_id, content, content_vector, file_path,
create_time, update_time)
VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10)
ON CONFLICT (workspace,id) DO UPDATE
SET tokens=EXCLUDED.tokens,
chunk_order_index=EXCLUDED.chunk_order_index,
full_doc_id=EXCLUDED.full_doc_id,
content = EXCLUDED.content,
content_vector=EXCLUDED.content_vector,
file_path=EXCLUDED.file_path,
update_time = EXCLUDED.update_time
""",
"upsert_entity": """INSERT INTO {table_name} (workspace, id, entity_name, content,
content_vector, chunk_ids, file_path, create_time, update_time)
VALUES ($1, $2, $3, $4, $5, $6::varchar[], $7, $8, $9)
ON CONFLICT (workspace,id) DO UPDATE
SET entity_name=EXCLUDED.entity_name,
content=EXCLUDED.content,
content_vector=EXCLUDED.content_vector,
chunk_ids=EXCLUDED.chunk_ids,
file_path=EXCLUDED.file_path,
update_time=EXCLUDED.update_time
""",
"upsert_relationship": """INSERT INTO {table_name} (workspace, id, source_id,
target_id, content, content_vector, chunk_ids, file_path, create_time, update_time)
VALUES ($1, $2, $3, $4, $5, $6, $7::varchar[], $8, $9, $10)
ON CONFLICT (workspace,id) DO UPDATE
SET source_id=EXCLUDED.source_id,
target_id=EXCLUDED.target_id,
content=EXCLUDED.content,
content_vector=EXCLUDED.content_vector,
chunk_ids=EXCLUDED.chunk_ids,
file_path=EXCLUDED.file_path,
update_time = EXCLUDED.update_time
""",
"relationships": """
SELECT r.source_id AS src_id,
r.target_id AS tgt_id,
EXTRACT(EPOCH FROM r.create_time)::BIGINT AS created_at
FROM {table_name} r
WHERE r.workspace = $1
AND r.content_vector <=> '[{embedding_string}]'::{vector_cast} < $2
ORDER BY r.content_vector <=> '[{embedding_string}]'::{vector_cast}
LIMIT $3;
""",
"entities": """
SELECT e.entity_name,
EXTRACT(EPOCH FROM e.create_time)::BIGINT AS created_at
FROM {table_name} e
WHERE e.workspace = $1
AND e.content_vector <=> '[{embedding_string}]'::{vector_cast} < $2
ORDER BY e.content_vector <=> '[{embedding_string}]'::{vector_cast}
LIMIT $3;
""",
"chunks": """
SELECT c.id,
c.content,
c.file_path,
EXTRACT(EPOCH FROM c.create_time)::BIGINT AS created_at
FROM {table_name} c
WHERE c.workspace = $1
AND c.content_vector <=> '[{embedding_string}]'::{vector_cast} < $2
ORDER BY c.content_vector <=> '[{embedding_string}]'::{vector_cast}
LIMIT $3;
""",
# DROP tables
"drop_specifiy_table_workspace": """
DELETE FROM {table_name} WHERE workspace=$1
""",
}
|