Apache FLink プロジェクト

このページには、Google Season of Docs で承認されたテクニカル ライティング プロジェクトの詳細が掲載されています。

プロジェクトの概要

オープンソース組織:

Apache Flink

テクニカル ライター:

Kartik Khare

プロジェクト名:

Table API と SQL のドキュメントを拡張

プロジェクト期間:

標準期間（3 か月）

プロジェクトの説明

Flink SQL は非常に有望な技術です。SQL のみを使用してストリームを操作できるという考えは当然ですが、複雑です。Flink SQL は最終的に、さまざまな都市の Uber/Lyft のリクエストをリアルタイムでカウントするなど、リアルタイム データの簡単な分析をデータ エンジニアが行う必要性を最終的に取り除くことができると考えています。この目標を達成するための最初のステップは、アナリティクスの経験がないユーザーでも利用できるようにドキュメントを簡素化することです。

ドキュメントに関して計画している改善をいくつか示します。詳細については、ドキュメントの実際の使用時に説明します。 * 概要ページには例は含まれていません。Table API の概要を説明する簡単な例を含める必要があります。* コンセプトと一般的な API のページを分割する必要があります。* 関数は、カテゴリごとに個別のページにする必要があります。また、関数は、名前、入力データ、パラメータ（存在する場合）、戻り値を列として表形式でリストする必要があります。* [データ型] ページには、JAVA データ型 → SQL データ型の適切なマッピングが含まれている必要があります。現在の表現は段落形式ですが、テーブルであることが理想的です。* Table API ページの式の構文セクションのフォーマットが改善されました。* プランナーとその活用方法に関するまったく新しいページ。* 現在、最適化に関するページを複数のセクションに分散させています。 SQL の概要ページも再フォーマットする必要があります。

また、コンテンツが少し圧倒的であるため、再構成が必要です。また、Streaming API ではなく Table API を使用する場合のセクションを追加し、コード行数の削減、暗黙的な最適化の向上、読みやすさの向上、デバッグしやすさなどの比較を追加する必要があります。