الانتقال إلى المحتوى الرئيسي
ClickHouse CLI (clickhousectl) هي أداة موحّدة لسطر الأوامر لإدارة موارد ClickHouse Cloud ودعم التطوير المحلي باستخدام ClickHouse. كما تتيح أيضًا إدارة خدمات ClickHouse Cloud Postgres.

التثبيت

curl https://clickhouse.com/cli | sh
يُنشأ أيضًا اسم مستعار لـ chctl تلقائيًا لتسهيل الاستخدام.

إدارة Cloud

قم بالمصادقة باستخدام ClickHouse Cloud وأدِر خدماتك مباشرةً من سطر الأوامر.

المصادقة

clickhousectl cloud auth
سيُطلب منك إدخال مفتاح API والسر الخاصَّين بك، وسيتم حفظهما في .clickhouse/credentials.json (محلي على مستوى المشروع، ومتجاهَل من git). يمكنك أيضًا استخدام متغيرات البيئة:
export CLICKHOUSE_CLOUD_API_KEY=your-key
export CLICKHOUSE_CLOUD_API_SECRET=your-secret

الخدمات

# List services
clickhousectl cloud service list

# Create a service
clickhousectl cloud service create --name my-service \
  --provider aws \
  --region us-east-1

# Get service details
clickhousectl cloud service get <service-id>

# Scale a service
clickhousectl cloud service scale <service-id> \
  --min-replica-memory-gb 24 \
  --max-replica-memory-gb 48 \
  --num-replicas 3

# Start/stop a service
clickhousectl cloud service start <service-id>
clickhousectl cloud service stop <service-id>

# Delete a service
clickhousectl cloud service delete <service-id>

خدمات Postgres (بيتا)

أنشئ ClickHouse Cloud Postgres وأدِر خدماته.
# List Postgres services
clickhousectl cloud postgres list

# Create a Postgres service
clickhousectl cloud postgres create \
  --name my-pg \
  --region us-east-1 \
  --size c6gd.xlarge \
  --pg-version 18

# Get service details
clickhousectl cloud postgres get <pg-id>

# Update a service
clickhousectl cloud postgres update <pg-id> --size c6gd.2xlarge --add-tag env=prod

# Reset the password
clickhousectl cloud postgres reset-password <pg-id> --generate

# Read replicas and point-in-time restore
clickhousectl cloud postgres read-replica create <pg-id> --name replica-1
clickhousectl cloud postgres restore <pg-id> --name restored --restore-target 2026-04-16T12:00:00Z

# Delete a service
clickhousectl cloud postgres delete <pg-id>

المنظمات

clickhousectl cloud org list
clickhousectl cloud org get <org-id>

مفاتيح API

clickhousectl cloud key list
clickhousectl cloud key create --name ci-key --role-id <role-id>
clickhousectl cloud key delete <key-id>

الأعضاء والدعوات

clickhousectl cloud member list
clickhousectl cloud invitation create --email dev@example.com --role-id <role-id>

النسخ الاحتياطية

clickhousectl cloud backup list <service-id>
clickhousectl cloud backup get <service-id> <backup-id>

مخرجات JSON

استخدم الخيار --json للحصول على استجابات مُنسّقة بتنسيق JSON من أي أمر سحابي:
clickhousectl cloud --json service list

التطوير المحلي

تُدير أداة CLI أيضًا عمليات التثبيت المحلية لـ ClickHouse والخوادم. راجع صفحة clickhousectl (CLI) للتعرّف على خطوات البدء في التطوير المحلي.

المتطلبات

آخر تعديل في ٢٥ يونيو ٢٠٢٦