پرش به محتوای اصلی

راهنمای قالب‌بندی SQL

زمان مطالعه: ۳ دقیقه

این ابزار چیست؟

کوئری SQL که از لاگ، ORM یا یک پیام چت کپی شده معمولاً در یک خط بلند است و خواندن شرط‌ها و پیوندهایش دردسر دارد. این ابزار کوئری را بر اساس گویش پایگاه داده‌ی شما مرتب می‌کند: هر بخش در سطر جدا، شرط‌ها زیر هم و کلیدواژه‌ها با حروف یک‌دست.

برای تحلیل‌گران داده، برنامه‌نویس‌ها و کسی که کوئری همکار را بازبینی می‌کند مفید است. خروجی را می‌توان دوباره تک‌خطی کرد تا در پیکربندی یا لاگ جا شود. قالب‌بندی کاملاً در مرورگر انجام می‌شود و کوئری شما به جایی فرستاده نمی‌شود.

گام‌به‌گام

  1. کوئری را بچسبانید

    متن SQL را در کادر سمت راست بگذارید؛ حداکثر حجم ورودی ۲ مگابایت است و نتیجه کمی بعد از توقف تایپ ساخته می‌شود.

  2. گویش را انتخاب کنید

    بین SQL استاندارد، MySQL، PostgreSQL، SQLite، SQL Server و MariaDB یکی را برگزینید تا نقل‌قول‌ها و کلیدواژه‌های ویژه‌ی همان پایگاه درست شناخته شوند.

  3. سبک را تنظیم کنید

    حروف کلیدواژه را بزرگ، کوچک یا بدون تغییر بگذارید و تورفتگی را روی دو یا چهار فاصله تنظیم کنید.

  4. در صورت نیاز فشرده کنید

    گزینه‌ی تک‌خطی کل کوئری را در یک سطر می‌آورد و توضیح‌های دو خط‌تیره‌ای را به توضیح بلوکی تبدیل می‌کند تا بقیه‌ی کوئری را نخورند.

  5. نتیجه را بردارید

    خروجی را کپی کنید یا با دکمه‌ی دانلود به‌صورت فایل query.sql ذخیره کنید.

نمونه‌های کاربردی

  • مرتب‌کردن یک کوئری تک‌خطی

    هر بخش کوئری در سطر جدا می‌آید، ستون‌ها زیر هم قرار می‌گیرند و شرط دوم با AND در سطر خودش دیده می‌شود.

    select id,name from users where age>18 and city='تهران' order by name

    نتیجه: ده سطر مرتب؛ مقدار فارسی تهران بدون تغییر

  • تک‌خطی با کلیدواژه‌ی کوچک

    گزینه‌های «کوچک» و «فشرده‌سازی» را با هم روشن کنید تا کوئری برای قراردادن در لاگ یا فایل پیکربندی آماده شود.

    select id,name from users where age>18 and city='تهران' order by name

    نتیجه: select id, name from users where age > 18 and city = 'تهران' order by name

  • توضیح داخل کوئری تک‌خطی

    در حالت تک‌خطی، توضیحی که با دو خط‌تیره شروع شده بود به توضیح بلوکی تبدیل می‌شود.

    select a from t -- note
    where b=1

    نتیجه: SELECT a FROM t /* note */ WHERE b = 1

اشتباه‌های رایج

  • گویش اشتباه می‌تواند خطای نحوی بدهد یا نقل‌قول را بد بشناسد؛ مثلاً در MySQL نام ستون با پشت‌نقل‌قول (`) و در SQL Server با کروشه نوشته می‌شود. پیش از ارسال به پایگاه داده، گویش را با سامانه‌ی خودتان یکی کنید.
  • این ابزار فقط شکل نوشتار را عوض می‌کند و درستی کوئری را با پایگاه داده نمی‌سنجد. کوئری قالب‌بندی‌شده را هم قبل از اجرا روی داده‌ی واقعی در محیط آزمایشی امتحان کنید.
  • نتیجه‌ی تک‌خطی برای خواندن مناسب نیست؛ آن را فقط برای ذخیره در لاگ یا پیکربندی بگیرید و نسخه‌ی چندخطی را برای بازبینی نگه دارید.

چرا قالب‌بندی SQL مهم است؟

کوئری‌های پیچیده معمولاً چند پیوند، زیرکوئری و شرط دارند. وقتی همه‌چیز در یک خط باشد، یافتن شرطی که نتیجه را عوض می‌کند حدس زدن است. قالب‌بندی یکنواخت باعث می‌شود تفاوت دو نسخه در سیستم کنترل نسخه فقط همان تغییر واقعی را نشان دهد و بازبینی سریع‌تر شود.

عرف رایج این است که کلیدواژه‌ها بزرگ و نام جدول‌ها و ستون‌ها کوچک نوشته شوند تا ساختار کوئری از داده‌هایش جدا دیده شود. با این حال هیچ‌کدام برای پایگاه داده فرقی ندارد و تیم شما می‌تواند قاعده‌ی دیگری انتخاب کند.

گویش‌ها چه فرقی دارند؟

SQL استاندارد در عمل در هیچ پایگاهی کامل پیاده نشده است. هر محصول کلیدواژه‌ها، نقل‌قول نام‌ها و توابع خودش را دارد: PostgreSQL از نقل‌قول دوتایی برای نام‌ها استفاده می‌کند، MySQL از پشت‌نقل‌قول، و SQL Server از کروشه. انتخاب گویش درست کمک می‌کند ابزار این‌ها را به‌عنوان نام بشناسد و وسط کوئری اشتباه نشکند.

اگر مطمئن نیستید، گویش SQL استاندارد معمولاً برای کوئری‌های ساده کافی است. برای ساختارهای ویژه، مثل کوئری‌های بازگشتی یا تابع‌های پنجره‌ای، گویش پایگاه واقعی را انتخاب کنید.

پرسش‌های متداول

رشته‌ها و توضیح‌های فارسی تغییر می‌کنند؟
خیر. رشته‌های داخل نقل‌قول و توضیح‌های -- و /* */ همان‌طور که نوشته‌اید می‌مانند؛ فقط فاصله‌ها و خط‌های اطراف آن‌ها مرتب می‌شود.
حالت فشرده با توضیح‌های تک‌خطی چه می‌کند؟
در یک خط، توضیح «--» بقیه‌ی کوئری را از کار می‌اندازد؛ پس این توضیح‌ها هنگام فشرده‌سازی به /* */ تبدیل می‌شوند تا معنی کوئری عوض نشود.
چرا خطا می‌گیرم؟
معمولاً گویش (dialect) با کوئری نمی‌خواند. گویش درست را انتخاب کنید؛ در صورت امکان سطر و ستون خطا نمایش داده می‌شود.

ابزارهای مرتبط