Diese Seite enthält die Details zu einem Projekt für technische Angelegenheiten, das für die Google-Saison der Dokumente angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Apache Flink
- Technischer Redakteur:
- Kartik Khare
- Projektname:
- Table API und SQL-Dokumentation erweitern
- Projektdauer:
- Standardlaufzeit (3 Monate)
Projektbeschreibung
Flink SQL bietet enorme Möglichkeiten. Die Idee, dass Sie mit Streams nur mit SQL arbeiten können, ist naheliegend, aber kompliziert. Ich glaube, dass sich Data Engineers mit Flink SQL letztendlich keine trivialen Analysen von Echtzeitdaten wie Zählanfragen für Uber/Lyft in verschiedenen Städten in Echtzeit machen lassen. Der erste Schritt in Richtung dieses Ziels besteht darin, die Dokumentation so zu vereinfachen, dass auch eine Person mit Analysekenntnissen anfangen kann.
Hier sind einige der Verbesserungen, die ich für die Dokumentation plane. Wir können mehr darüber sprechen, wenn wir mit der Dokumentation beginnen. * Die Übersichtsseite enthält keine Beispiele. Sie sollte einfache Beispiele enthalten, die eine Einführung in die Table API bieten. * Die Seite „Konzepte und gängige APIs“ sollte aufgeteilt werden. * Die Funktionen sollten für jede Kategorie eine eigene Seite haben. Die Funktionen sollten auch tabellarisch mit Name, Eingabedaten, Parametern (falls vorhanden) und Rückgabewert als Spalten aufgeführt werden. * Die Seite „Datentyp“ muss korrekte Zuordnungen von JAVA-Datentyp → SQL-Datentyp enthalten. Die aktuelle Darstellung erfolgt in Form von Absätzen, idealerweise sollte es sich aber um eine Tabelle handeln. * Der Abschnitt „Syntax des Ausdrucks“ auf der Seite „Tabellen-API“ sollte besser formatiert sein. * Eine völlig neue Seite zu Planern und wie Nutzer sie nutzen können. * Eine Seite zu Optimierungen, die derzeit in mehreren Abschnitten verstreut sind. Auch die SQL-Übersichtsseite muss neu formatiert werden.
Auch die Inhalte müssen überarbeitet werden, da sie etwas überwältigend wirken. Wir müssen auch einen Abschnitt hinzufügen, in dem beschrieben wird, wie Sie die Table API anstelle der Streaming API mit Vergleichen wie weniger Codezeilen, besseren impliziten Optimierungen, besserer Lesbarkeit und einfacherer Fehlerbehebung verwenden können.