Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo del progetto
- Organizzazione open source:
- Apache Flink
- Redattore tecnico:
- Kartik Khare
- Nome progetto:
- Estendi l'API Tables e la documentazione di SQL
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Flink SQL è molto promettente. L'idea che puoi lavorare su Streams utilizzando solo SQL è ovvia, ma complicata. Credo che Flink SQL possa eliminare definitivamente la necessità di data engineer per analisi banali sui dati in tempo reale, come il conteggio in tempo reale delle richieste di Uber/Lyft in varie città. Il primo passo verso questo obiettivo è semplificare la documentazione in modo che anche chi ha esperienza in ambito di analisi possa iniziare a utilizzare la piattaforma.
Ecco alcuni dei miglioramenti che sto prevedendo per la documentazione. Ne parleremo di più quando inizieremo a utilizzare la documentazione. * La pagina Panoramica non contiene esempi. Deve contenere semplici esempi per fornire un'introduzione all'API Table. * La pagina Concetti e API comuni deve essere suddivisa. * Le funzioni devono avere una pagina separata per ogni categoria. Le funzioni devono essere elencate anche in un formato tabulare con nome, dati di input, parametri (se presenti) e valore restituito come colonne. * La pagina Tipo di dati deve contenere mappature appropriate del tipo di dati JAVA → tipo di dati SQL. L'attuale rappresentazione è sotto forma di paragrafi, ma idealmente dovrebbe essere una tabella. * La sezione Sintassi dell'espressione nella pagina dell'API Table deve avere una formattazione migliore. * Una pagina completamente nuova sui pianificatori e su come gli utenti possono trarne vantaggio. * Una pagina sulle ottimizzazioni attualmente sparse in più sezioni. Anche la pagina Panoramica SQL deve essere riformattata.
Inoltre, i contenuti devono essere rivisti perché sembrano un po' troppo. Dobbiamo anche aggiungere una sezione su dove puoi utilizzare l'API Table anziché l'API Streaming con confronti come una diminuzione delle righe di codice, ottimizzazioni implicite migliori, leggibilità e debug più semplici.