Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
Podsumowanie projektu
- Organizacja open source:
- Apache Flink
- Specjalista ds. technicznych:
- Kartik Khare
- Nazwa projektu:
- Rozszerzanie interfejsu Table API i dokumentacja SQL
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Flink SQL pokazuje obiecującą obietnicę. Praca nad strumieniami za pomocą samego SQL jest oczywista, ale skomplikowana. Wydaje mi się, że Flink SQL może w ostatecznym rozrachunku wyeliminować potrzebę wykonywania przez inżynierów danych praktycznych analiz danych w czasie rzeczywistym, takich jak zliczanie zapytań dotyczących Uber/Lyft w różnych miastach w czasie rzeczywistym. Pierwszym krokiem w tym kierunku jest uproszczenie dokumentacji, aby umożliwić korzystanie z niej osobom, które mają już doświadczenie w zakresie analityki.
Oto kilka ulepszeń, które planuję wprowadzić w dokumentach. Możemy omówić więcej z nich, gdy zaczniemy omawiać dokumentację.* Strona Przegląd nie zawiera żadnych przykładów. Powinien zawierać łatwe przykłady wprowadzające do interfejsu Table API. * Strona Pojęcia i interfejsy API wspólne powinna zostać podzielona. * Funkcje powinny mieć osobną stronę dla każdej kategorii. Funkcje powinny być również wymienione w postaci tabeli z nazwami, danymi wejściowymi, parametrami (jeśli występują) i wartościami zwracanymi jako kolumnami. * Strona Typ danych powinna zawierać odpowiednie mapowania typu danych JAVA na typ danych SQL. Obecna reprezentacja ma postać akapitów, ale idealnie powinna być tabelą. * Sekcja Składnia wyrażeń na stronie interfejsu Table API powinna mieć lepsze formatowanie. * Całkowicie nowa strona dotycząca planistów i sposobów, w jakie użytkownicy mogą z nich korzystać. * Strona dotycząca optymalizacji, która jest obecnie rozproszona po wielu sekcjach. Strona SQL – przegląd też musi zostać sformatowana.
Treści wymagają też przerobienia, ponieważ są przytłaczające. Musimy też dodać sekcję, w której opiszemy, w jakich sytuacjach można używać interfejsu Table API zamiast Streaming API. Wskażemy też porównania, np. zmniejszenie liczby linii kodu, lepsze optymalizacje domyślne, lepszą czytelność i łatwiejsze debugowanie.