.\" cf. groff_mdoc
.Dd March 25, 2015
.Os FreeTDS 1.5.19
.Dt FISQL FreeTDS "FreeTDS Reference Manual"
.\"
.Sh "نام (NAME)"
.Nm fisql
.Nd پوسته تعاملی SQL
.\"
.Sh "خلاصه دستور (SYNOPSIS)"
.Pp
.Nm
.Op Fl eFgpnvXY
.Op Fl a Ar display_charset
.Op Fl A Ar packet_size
.Op Fl c Ar cmdend
.Op Fl D Ar database
.Op Fl E Ar editor
.Op Fl h Ar headers
.Op Fl H Ar hostname
.Op Fl i Ar inputfile
.Op Fl I Ar interfaces_file
.Op Fl J Ar client_charset
.Op Fl l Ar login_timeout
.Op Fl m Ar errorlevel
.Op Fl o Ar outputfile
.Op Fl P Ar password
.Op Fl s Ar colseparator
.Op Fl S Ar server
.Op Fl t Ar timeout
.Op Fl U Ar username
.Op Fl w Ar width
.Op Fl y Ar sybase_dir
.Op Fl z Ar language
.\"
.Sh "توضیحات (DESCRIPTION)"
.Pp
.Nm
بسیار شبیه به برنامه‌های کاربردی
.Ql isql
توزیع‌شده توسط Sybase و Microsoft است. همانند آن‌ها،
.Nm
از دستور
.Ql go
در یک سطر مجزا به عنوان جداکننده بین دسته‌ها (batches) استفاده می‌کند.
.\"
.Sh "گزینه‌ها (OPTIONS)"
.Bl -tag -width indent
.It Fl a Ar display_charset
نام مجموعه نویسه‌های (charset) کلاینت. پیاده‌سازی نشده است.
.It Fl A Ar packet_size
تنظیم اندازه بسته (packet size) پروتکل. نیازی به تنظیم این پارامتر نخواهید داشت.
.It Fl c Ar cmdend
پایان‌دهنده دستور، با مقدار پیش‌فرض
.Ql go Ns .
.It Fl D
نام پایگاه داده روی سرور برای استفاده.
.It Fl e
پژواک ورودی SQL (معمولاً در outputfile).
.It Fl E Ar editor
تعیین یک ویرایشگر برای فراخوانی. پیش‌فرض vi است.
.It Fl F
روشن کردن حالت FIPS. سرور هنگام مواجهه با یک دستور غیر استاندارد SQL پیامی بازمی‌گرداند (اما در هر صورت پرس‌وجو را پردازش می‌کند).
.It Fl g
نمایش یک پیام راهنمای کوتاه.
.It Fl h Ar headers
تعداد سطرهایی که پس از آن‌ها سرستون‌ها تکرار می‌شوند. پیش‌فرض یک‌بار به ازای هر مجموعه نتیجه (resultset) است.
.It Fl H Ar hostname
نام میزبان (hostname) ماشین کلاینت، آن‌گونه که به سرور اعلام می‌شود.
.It Fl I Ar interfaces_file
نام فایل interfaces یا freetds.conf برای استفاده.
.It Fl i Ar inputfile
نام فایل اسکریپت حاوی SQL.
.It Fl J Ar client_charset
پیاده‌سازی نشده است.
.It Fl l Ar login_timeout
مدت زمان انتظار برای تأیید تلاش ورود توسط سرور.
.It Fl m Ar errorlevel
برای خطاهایی با سطح شدت (severity level) مشخص‌شده یا بالاتر، فقط شماره پیام، وضعیت و سطح خطا را چاپ می‌کند. برای سطوح پایین‌تر، چیزی چاپ نمی‌شود.
.It Fl n
حذف شماره خطوط در خروجی پژواک داده‌شده.
.It Fl o Ar outputfile
نام فایل خروجی، برای نگهداری داده‌های نتیجه.
.It Fl p
چاپ آمار عملکرد. پیاده‌سازی نشده است.
.It Fl P Ar password
گذرواژه سرور پایگاه داده.
.It Fl s Ar colseparator
جداکننده ستون‌ها. پیش‌فرض فاصله (space) است. نویسه‌های ویژه پوسته (metacharacters) نیازمند قرارگیری در نقل‌قول هستند.
.It Fl S Ar server
سرور پایگاه داده برای اتصال.
.It Fl t Ar timeout
مهلت زمانی پرس‌وجو به ثانیه. مدت زمان انتظار برای پردازش یک پرس‌وجو. پیش‌فرض نامحدود است، یا آنچه توسط freetds.conf تعیین شده باشد.
.It Fl U Ar username
نام کاربری برای ورود به سرور پایگاه داده.
.It Fl v
نمایش نسخه و کپی‌رایت.
.It Fl w Ar width
عرض چاپ خروجی بر حسب تعداد نویسه‌ها. پیش‌فرض 80 است.
.It Fl X
استفاده از ورود رمزگذاری‌شده. در FreeTDS پیاده‌سازی نشده است.
.It Fl y Pa sybase_dir
متغیر محیطی
.Ev SYBASE
را تنظیم می‌کند. توسط FreeTDS استفاده نمی‌شود.
.It Fl Y
استفاده از تراکنش‌های زنجیره‌ای (chained transactions).
.It Fl z Ar language
نام زبان برای اعلان‌ها و پیام‌های fisql.
ببینید: DBSETLNATLANG.
.El
.\"
.Sh "نکات (NOTES)"
.Nm
یک فیلتر است؛ از ورودی استاندارد می‌خواند، در خروجی استاندارد می‌نویسد،
و خطاها را در خطای استاندارد می‌نویسد. گزینه‌های
.Fl i Ns ،
.Fl o Ns
و
.Fl e
این مقادیر پیش‌فرض را لغو می‌کنند.
.Pp
.Nm
از API کتابخانه DB-Library ارائه‌شده توسط FreeTDS استفاده می‌کند. این ابزار ابتدا با استفاده از کتابخانه خود Sybase پیاده‌سازی شده بود و همچنان با آن کار می‌کند. قبل (و بعد) از اعمال تغییر در آن، بهتر است آن را با کتابخانه Sybase آزمایش کنید تا از سازگاری میان آن و FreeTDS اطمینان حاصل شود.
وضعیت خروج (EXIT STATUS)
.Pp
.Nm
در صورت موفقیت با 0، و اگر سرور نتواند پرس‌وجو را پردازش کند با مقدار >0 خارج می‌شود.
.Pp
.Nm
هرگونه خطای بازگردانده‌شده از سوی سرور را گزارش خواهد کرد، اما پردازش را ادامه می‌دهد. در یک محیط عملیاتی، این رفتار ممکن است به اندازه کافی سخت‌گیرانه نباشد. برای اینکه آن را به شدت نسبت به خطاها حساس کنید، گرداننده‌های پیام و خطا (handlers) را طوری تغییر دهید که exit(3) را فراخوانی کنند.
.\"
.Sh "تاریخچه (HISTORY)"
.Nm
نخستین بار در FreeTDS 0.65 ظاهر شد.
.\"
.Sh "نویسندگان (AUTHORS)"
ابزار
.Nm
توسط
.An Nicholas S. Castellano Aq entropy@freetds.org Ns ,
نوشته شده است، که آن را تحت شرایط مجوز GPL به پروژه FreeTDS اهدا کرد.
.\"
.Sh "گزارش باگ‌ها (BUGS)"
به کتابخانه GNU readline نیاز دارد.