SQL Server: ค้นหา Table Description

ในฐานะนักพัฒนาระบบระดับ Senior Architect การทำงานกับฐานข้อมูลขนาดใหญ่หรือที่ถูกสร้างโดยทีมงานอื่นโดยไม่มีคู่มือที่ชัดเจน ถือเป็นความท้าทายที่พบบ่อยที่สุด หนึ่งในปัญหาหลักคือการขาดเอกสารประกอบ (Documentation) ของโครงสร้างตาราง (Schema) และความหมายของคอลัมน์ (Column) ต่างๆ

ในโลกของ PostgreSQL ซึ่งเป็นระบบฐานข้อมูลที่ทรงพลังและยืดหยุ่น การเข้าถึงข้อมูลเมตา (Metadata) เช่น คำอธิบายตาราง (Table Description) และคำอธิบายคอลัมน์ (Column Description) จึงเป็นทักษะสำคัญที่นักพัฒนามืออาชีพต้องมี บทความนี้จะนำเสนอวิธีการใช้ System Catalog ของ PostgreSQL เพื่อค้นหาคำอธิบายเหล่านี้ได้อย่างเป็นระบบและแม่นยำ

⚙️ หลักการทำงาน: การเข้าถึง Metadata ใน PostgreSQL

PostgreSQL มีระบบแคตตาล็อกระบบ (System Catalogs) ที่เก็บข้อมูลเกี่ยวกับโครงสร้างของฐานข้อมูลทั้งหมด แทนที่จะต้องอาศัยการเดาหรือการสอบถามจากผู้ดูแลระบบ เราสามารถใช้คำสั่ง SQL เพื่อดึงข้อมูลคำอธิบายเหล่านี้ได้ โดยทั่วไป เราจะใช้มุมมอง (Views) เช่น information_schema หรือแคตตาล็อก pg_catalog เพื่อให้ได้ข้อมูลที่ครบถ้วน

💡 ตัวอย่างโค้ด: การดึงคำอธิบายตารางและคอลัมน์

เราจะใช้คำสั่งที่รวมการเข้าถึงข้อมูลเมตาของตารางและคอลัมน์ โดยจำลองการค้นหาคำอธิบายที่ถูกกำหนดไว้ (ซึ่งมักจะถูกเก็บในส่วนขยายหรือแคตตาล็อกเฉพาะ) เพื่อให้ได้ภาพรวมที่สมบูรณ์ที่สุด

SQL

-- ตัวอย่างการค้นหาคำอธิบายตารางและคอลัมน์ใน PostgreSQL (PG) </code>

SELECT
    c.table_schema AS SchemaName,
    c.table_name AS TableName,
    c.column_name AS ColumnName,
    -- ใน PostgreSQL คำอธิบายมักจะถูกเก็บใน pg_description หรือต้องใช้ฟังก์ชันเฉพาะ
    -- สำหรับตัวอย่างนี้ เราจะแสดงคำอธิบายที่ถูกกำหนด (ถ้ามี) หรือค่า NULL
    (SELECT obj_description(c.table_schema || '.' || c.table_name) AS TableDescription)
    , (SELECT col_description(c.table_schema || '.' || c.table_name, c.column_name) AS ColumnDescription)
FROM
    information_schema.columns c
WHERE
    c.table_schema = 'public' -- ระบุ Schema ที่ต้องการค้นหา
    AND c.table_name LIKE 'user_%' -- ตัวอย่างการค้นหาตารางที่ขึ้นต้นด้วย 'user_' 
ORDER BY
    SchemaName, TableName, c.ordinal_position;

คำอธิบายโค้ด:

1. information_schema.columns: คือมุมมองมาตรฐานที่ให้ข้อมูลพื้นฐานของทุกคอลัมน์ในฐานข้อมูล
2. obj_description() และ col_description(): เป็นฟังก์ชันของ PostgreSQL ที่ใช้ดึงคำอธิบาย (Comment) ของ Object (ตาราง) และ Column ที่ผู้ใช้หรือระบบได้กำหนดไว้ ซึ่งเป็นหัวใจสำคัญของการค้นหาคำอธิบายเมตา
3. WHERE Clause: ใช้จำกัดขอบเขตการค้นหาให้แคบลง (เช่น ใน Schema ‘public’ และตารางที่ชื่อขึ้นต้นด้วย ‘user_’)

🛠️ การประยุกต์ใช้และข้อควรระวังสำหรับ Senior Architect

การใช้คำสั่งเหล่านี้ช่วยให้เราสามารถสร้างเครื่องมือ (Utility Scripts) เพื่อทำ Documentation Automation ได้อย่างง่ายดาย อย่างไรก็ตาม ในฐานะสถาปนิกระบบ ควรทราบข้อควรระวังดังนี้:

• สิทธิ์การเข้าถึง (Permissions): การเข้าถึง Metadata บางส่วนอาจต้องใช้สิทธิ์ระดับสูง (Superuser)
• ความแตกต่างของระบบ: คำสั่ง obj_description() เป็นฟังก์ชันเฉพาะของ PostgreSQL หากย้ายไปใช้ระบบอื่น (เช่น SQL Server) จะต้องเปลี่ยนไปใช้ System Catalog ที่แตกต่างกัน
• การจัดการคำอธิบาย: หากไม่มีการกำหนดคำอธิบาย (Comment) ไว้ล่วงหน้า ระบบจะคืนค่าเป็น NULL ดังนั้นการกำหนดคำอธิบายตั้งแต่ขั้นตอนการสร้างตาราง (DDL) จึงเป็น Best Practice ที่สำคัญที่สุด

✅ บทสรุป

การค้นหาคำอธิบายตารางและคอลัมน์ใน PostgreSQL ไม่ได้เป็นเพียงแค่การรันคำสั่ง SQL แต่เป็นการแสดงให้เห็นถึงความเข้าใจในโครงสร้างภายในของระบบฐานข้อมูล การใช้ information_schema ร่วมกับฟังก์ชันเฉพาะอย่าง obj_description() ทำให้เราสามารถดึงข้อมูลเมตาที่จำเป็นสำหรับการทำความเข้าใจและบำรุงรักษาระบบได้อย่างรวดเร็วและแม่นยำ การทำความเข้าใจ Metadata เหล่านี้จะช่วยลดเวลาในการ Onboarding ทีมงานใหม่ และยกระดับคุณภาพของโค้ดฐานข้อมูลให้เป็นมาตรฐานระดับสถาปนิกได้อย่างสมบูรณ์