.\" -*- coding: us-ascii -*-
.if \n(.g .ds T< \\FC
.if \n(.g .ds T> \\F[\n[.fam]]
.de URL
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
.TH odbx-sql 1 "15 July 2026" "" OpenDBX
.SH "نام (NAME)"
odbx-sql \- ابزاری همه‌کاره برای ارتباط با پایگاه‌های داده و پوسته تعاملی SQL
.SH "خلاصه دستور (SYNOPSIS)"
'nh
.fi
.ad l
\fBodbx-sql\fR \kx
.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
'in \n(.iu+\nxu
[-?] [-b \fIbackend\fR] [-c \fIconfigfile\fR] [-d \fIdatabase\fR] [-f \fIdelimiter\fR] [-h \fIhost\fR] [-i] [-k \fIkeywordfile\fR] [-p \fIport\fR] [-s \fIseparator\fR] [-u \fIusername\fR] [-w]
'in \n(.iu-\nxu
.ad b
'hy
.SH "توضیحات (DESCRIPTION)"
\fBodbx-sql\fR ابزاری کوچک و انعطاف‌پذیر برای برقراری ارتباط با پایگاه‌های دادهٔ پشتیبانی‌شده توسط کتابخانهٔ OpenDBX است. در حالت دسته‌ای (batch mode)، هدف اصلی آن خودکارسازی وظایف در اسکریپت‌های شل است که به کار با پایگاه‌های داده نیاز دارند. از سوی دیگر، حالت تعاملی (interactive mode) یک پوستهٔ SQL مناسب را برای ویرایش محتوای پایگاه داده یا آزمایش دستورها فراهم می‌کند. قالب خروجی تا حدودی با تعیین رشته‌هایی برای جداسازی ستون‌ها و تعیین حد فاصل مقادیر فیلدها قابل کنترل است.
.SH "گزینه‌ها (OPTIONS)"
.TP 
-h, --help
چاپ راهنما شامل توضیح کوتاهی از گزینه‌های موجود.
.TP 
-b, --backend=name
نام بک‌اند (backend) پایگاه داده که باید استفاده شود یا مسیر کتابخانهٔ بک‌اند درایور OpenDBX.
.TP 
-c, --config=configfile
فایل پیکربندی شامل پارامترهای مورد نیاز برای اتصال به پایگاه داده. این فایل می‌تواند شامل مقادیری برای بک‌اندِ مورد استفاده، نام میزبان یا نشانی IP (و در صورت نیاز، درگاه)، نام پایگاه داده و نام کاربری و گذرواژه باشد. این مقادیر باید در فایل پیکربندی قرار گیرند تا بتوان در اجرای غیرتعاملی برنامه‌ها به‌صورت امن و بدون فاش شدن گذرواژه در هر جایی، به آن‌ها دسترسی داشت. یک نمونه کامل از چنین فایل پیکربندی را می‌توان در بخش مثال‌های این راهنما یافت.
.TP 
-d, --database=name
نام پایگاه داده بر روی سرور یا مسیر فایل پایگاه داده در فایل‌سیستم محلی.
.TP 
-f, --delimiter=character
یک نویسه یا رشته که مقادیر فیلدهای بازگردانده‌شده توسط دستورهای مشابه SELECT را که در stdout چاپ می‌شوند، احاطه می‌کند.
.TP 
-h, --host=name
نام میزبان، نشانی IP یا مسیر فایل پایگاه داده. همچنین می‌تواند مسیر یک لولهٔ نام‌گذاری‌شده (named pipe) باشد تا ارتباط با سرور پایگاه داده صرفاً به‌صورت محلی برقرار شود.
.TP 
-i, --interactive
اجرا در حالت تعاملی و فراهم کردن یک پوستهٔ SQL مناسب؛ برخلاف حالت دسته‌ای که منتظر دریافت ورودی از stdin می‌ماند و نتایج را در stdout چاپ می‌کند.
.TP 
-k keywordfile
محل قرارگیری یک فایل کلیدواژه که برای ارائهٔ قابلیت تکمیل خودکار (auto-completion) کلیدواژه‌ها استفاده می‌شود.
.TP 
-p, --port=port
نام یا شماره درگاه TCP/IP که سرور پایگاه داده به آن گوش می‌دهد. اگر این پارامتر در خط فرمان اضافه نشود، بیشتر کتابخانه‌های کلاینت پایگاه داده از مقدار پیش‌فرض استفاده می‌کنند. بسیاری از سرورهای پایگاه داده (اما نه همه) می‌توانند شماره درگاه را از نام آن تشخیص دهند و برای دستیابی به بیشترین میزان سازگاری، مقدار پارامتر باید شماره درگاه باشد.
.TP 
-s separator
یک نویسه یا رشته که مقادیر فیلدهای بازگردانده‌شده توسط دستورهای مشابه SELECT را که در stdout چاپ می‌شوند، از یکدیگر جدا می‌کند.
.TP 
-u, --username=name
نام کاربری که برای احراز هویت به سرور پایگاه داده ارسال می‌شود.
.TP 
-w, --password
درخواست ورود گذرواژه در خط فرمان.
.SH "مثال‌ها (EXAMPLES)"
\fBفایل پیکربندی\fR
.PP
.nf

 backend = mysql
 host = localhost
 port = 3306
 database = test
 username = myuser
 password = secret
			
.fi
.PP
\fBراه‌اندازی در حالت تعاملی\fR
.PP
.nf
odbx\-sql \-c mysql.conf \-i
.fi
.PP
\fBاجرای دستورها در حالت دسته‌ای\fR
.PP
.nf
cat stmt.sql | odbx\-sql \-c mysql.conf
.fi
.SH "وضعیت خروج (EXIT STATUS)"
دستور \fBodbx-sql\fR در صورت بروز خطا مقدار 1، و در صورتی که همهٔ دستورها با موفقیت انجام شوند یا تنها هشدارها گزارش شوند، مقدار 0 را برمی‌گرداند. در صورت بروز هشدارها، در stderr نوشته می‌شوند.