این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه پروژه
- سازمان منبع باز:
- آپاچی فلینک
- نویسنده فنی:
- کارتیک خاره
- نام پروژه:
- Table API & SQL Documentation را گسترش دهید
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
Flink SQL وعده های خیره کننده ای را نشان می دهد. این ایده که شما می توانید روی Streams فقط با استفاده از SQL کار کنید واضح است اما پیچیده است. من معتقدم Flink SQL در نهایت می تواند نیاز به مهندسان داده را برای تجزیه و تحلیل بی اهمیت روی داده های بلادرنگ مانند شمارش درخواست های Uber/Lyft در شهرهای مختلف در زمان واقعی برطرف کند. اولین قدم برای رسیدن به این هدف، ساده کردن مستندات است به طوری که شخصی با پیشینه تحلیلی نیز بتواند شروع به کار کند.
در اینجا برخی از بهبودهایی است که من برای اسناد برنامه ریزی می کنم. زمانی که مستندات را شروع کنیم میتوانیم درباره آنها بیشتر بحث کنیم - * صفحه نمای کلی شامل هیچ مثالی نیست. باید شامل مثالهای آسان برای ارائه مقدمه جدول API باشد. * صفحه مفاهیم و مشترک API باید تقسیم شود. * توابع باید یک صفحه جداگانه برای هر دسته داشته باشند. توابع همچنین باید به صورت جدولی با نام، داده های ورودی، پارامترها (در صورت وجود) و مقدار بازگشتی به عنوان ستون فهرست شوند. * صفحه نوع داده باید حاوی نگاشت مناسب از نوع داده JAVA → نوع داده SQL باشد. نمایش فعلی به صورت پاراگراف است اما در حالت ایده آل، باید یک جدول باشد. * قسمت عبارت Syntax در صفحه Table API باید قالب بندی بهتری داشته باشد. * یک صفحه کاملاً جدید در Planners و نحوه استفاده کاربران از آنها. * صفحه ای در مورد بهینه سازی هایی که در حال حاضر در چندین بخش پراکنده شده اند. صفحه نمای کلی SQL نیز نیاز به فرمت مجدد دارد.
محتوا همچنین نیاز به تجدید نظر دارد زیرا کمی سخت به نظر می رسد. همچنین باید بخشی را اضافه کنیم که در آن بتوانید از Table API به جای Streaming API با مقایسه هایی مانند کاهش خطوط کد، بهینه سازی ضمنی بهتر، خوانایی بهتر و اشکال زدایی آسان تر استفاده کنید.