ทำไมเราควรใส่ Comment ใน SQL Query

จากการลองผิดลองถูกปัญหาหนึ่งที่ประสบเจอมาคือ “เฮ้ย Query นี้มาจากส่วนไหนของ Code ฟระ ! ทำไมมันช้าจัง” เนื่องจากระบบผมประสบปัญหามันช้า แล้วเราแทบจำไม่ได้แล้วว่า query นี้มันอยู่ส่วนไหนของ app ดังนั้น ขอเขียนเป็นคำแนะนำสำหรับคนที่กำลังจะทับ App ใหญ่ที่มีความซับซ้อนมี การทำ Report ให้ใส่ Comment ใน Query สักหน่อยอย่างเช่นในตัวอย่าง

สังเกตุได้ว่าการใส่ Comment ไว้ในข้างหน้าหรือข้างหลัง Query จะทำให้เราบอกได้ว่าจริงๆ Query นี้มาจากที่ไหน โดยถ้าเป็นผมจะตั้ง Comment แบบนี้

/* [OBVOC] application/model/page.php @ function get_by_date */

ประมาณนี้คือ “[ชื่อapp] ชื่อไฟล์ @ function ไหน” หรือถ้าไม่ได้เขียนเป็น function หรือใน function มีการทำหลาย query ก็ใส่ (1) , (2) , (3) ไปก็น่าจะ ok แล้วผมว่าใครมีวิธีการ comment แบบไหนให้หาได้ง่ายก็มา share กันนะครับ โดยสรุปข้อดีในการ Comment ใน Query คือ

  • เวลาทำ DB Performance Tuning ทำให้หาส่วนที่ทำให้เกิด Query ช้านี้ได้ทันทีว่ามาจาก app ไหน
  • ทำเป็น Remark ได้ว่า Query นี้จุดประสงค์เอาไว้ทำอะไร
  • คนที่มาทำงานต่อสามารถรู้ได้ทันที ว่าถ้าจะแก้ไข Query นี้ต้องไปแก้ที่ไหน

ปล. อัพเดตหรือไม่ก็เราควรจะทำให้มัน Debug ได้ง่ายๆว่ามาจากจุดไหน โดยใช้โปรแกรมอื่นๆช่วย เช่นพวก Profiler ดีๆ


Originally published at dominixz.com.

One clap, two clap, three clap, forty?

By clapping more or less, you can signal to us which stories really stand out.