index-suggester

Get smart database index suggestions from query patterns. Use when queries are slow.

1. Upewnij się, że masz zainstalowany Node.js w wersji 18 lub nowszej oraz że zmienna środowiskowa OPENAI_API_KEY jest ustawiona w Twoim systemie.

2. Przejdź do folderu Twojego projektu i uruchom narzędzie, wskazując ścieżkę do plików zapytań. Najprostszy sposób to: npx @lxgicstudios/ai-index ./src/queries/ — narzędzie przeanalizuje wszystkie pliki zapytań w tym folderze.

3. Czekaj na wyniki. Narzędzie przeczyta Twoje pliki zapytań, wydobędzie klauzule WHERE i warunki JOIN, a następnie zaproponuje indeksy, które przyspieszą Twoje zapytania. Każda sugestia zawiera wyjaśnienie, dlaczego dany indeks jest potrzebny.

4. Jeśli chcesz zapisać sugestie do pliku SQL, użyj flagi -o: npx @lxgicstudios/ai-index ./src/queries/ -o indexes.sql. Możesz też analizować pojedyncze pliki, na przykład: npx @lxgicstudios/ai-index ./src/queries/users.ts.

5. Przejrzyj sugestie i zastosuj je rozważnie. Pamiętaj, że indeksy przyspieszają odczyt, ale spowalniają zapis — indeksuj najpierw zapytania, które wykonują się najczęściej. Dla indeksów złożonych kolejność kolumn ma znaczenie.

6. Przed wdrożeniem indeksów w produkcji przetestuj je w środowisku testowym, aby upewnić się, że rzeczywiście poprawiają wydajność Twoich zapytań.