DBX CLI

Kurulum

npm

npm install -g @dbx-app/cli

Homebrew

brew tap t8y2/tap
brew install dbx-cli

npm başlatıcısı için Node.js 18.18.0 ya da üstü gereklidir. CLI'nin kendisi better-sqlite3 ya da bir Node.js yerel modül ABI'sine bağlı değildir. Homebrew kullanıcılarının Node.js'i ayrıca yönetmesi gerekmez.

Bağımsız yerel ikili dosya

packages-v* GitHub Sürümü; macOS, Linux ve Windows için yerel CLI arşivleri sunar. Platformunuza uyan arşivi indirin, CLI-SHA256SUMS ile doğrulayın, çıkarın ve dbx komutunu doğrudan çalıştırın. Bağımsız ikili dosyalar Node.js gerektirmez.

tar -xzf dbx-cli-linux-x64-gnu.tar.gz
chmod +x dbx
./dbx --version

Özel ya da taşınabilir bir DBX veri dizini kullanırken DBX_DATA_DIR değişkenini ayarlayın.

Kurulu sürümü denetleyin:

dbx --version

Yaygın Komutlar

dbx doctor
dbx capabilities
dbx connections list --json
dbx connections list --format csv
dbx schema list local --json
dbx schema describe local users --json
dbx query local "select count(*) as total from users" --json
dbx query local "select id, name from users" --format csv
dbx query local "select * from users" --limit 50 --timeout 10s --json
dbx query local --file ./query.sql --json
dbx context local --tables users,orders
dbx open local users

Tanılama

Yerel DBX yollarını, bağlantı deposunun sağlığını ve masaüstü köprüsünün kullanılabilir olup olmadığını incelemek için dbx doctor kullanın:

dbx doctor
dbx doctor --json

İsteğe bağlı platform paketi kurulmamışsa --no-optional olmadan yeniden kurun:

npm uninstall -g @dbx-app/cli
npm install -g @dbx-app/cli

Hangi veritabanı türlerinin doğrudan sorgulanabildiğini ve hangilerinin şu anda DBX Masaüstü gerektirdiğini görmek için dbx capabilities kullanın:

dbx capabilities
dbx capabilities --json

CLI ikili dosyası şu anda PostgreSQL, Redshift, MySQL, Doris, StarRocks, Manticore Search, SQLite, rqlite, KWDB ve QuestDB türlerini doğrudan sorgulanabilir olarak listeler. Kurulu sürüm için asıl kaynak dbx capabilities çıktısıdır. Diğer türler; çalışan bir DBX Masaüstü köprüsünü ya da kendi Agent/dış sürücü altyapılarını gerektirir.

Çalıştırma Modları

Yerel Depolama

CLI varsayılan olarak Masaüstü ve MCP'nin kullandığı aynı dbx.db bağlantı deposunu okur. DBX_DATA_DIR, dbx.db dosyasını içeren dizini göstermelidir.

• Doğrudan sorgulanabilir türler Masaüstü kapalıyken de çalışabilir
• Köprü gerektiren türler, Masaüstü'nün çalışmasını ve veri dizinindeki köprü port dosyası aracılığıyla bulunabilmesini gerektirir
• Agent/JDBC, DuckDB ve diğer dış sürücü yolları yine DBX üzerinden kurulmuş bileşenleri gerektirir
• dbx open her zaman bir Masaüstü arayüz işlemidir ve uygulama kullanılamadığında DBX_NOT_RUNNING döndürür

DBX Web ve Docker

Yerel bağlantı deposu yerine dağıtılmış bir DBX Web arka ucunu kullanmak için DBX_WEB_URL değişkenini ayarlayın:

DBX_WEB_URL=https://dbx.example.com \
DBX_WEB_PASSWORD='giris-parolaniz' \
dbx connections list --json

DBX_WEB_PASSWORD, Web giriş parolasıdır. Web modunda bağlantılar, yetkiler, sürücüler ve dosya yolları sunucu ortamına aittir. dbx open yine yerel bir Masaüstü köprüsünü hedefler ve uzak bir Web otomasyon API'si olarak görülmemelidir.

Varsayılan Bağlantı

Sorgu ve bağlam komutlarında bağlantı adını atlamak için DBX_CONNECTION değişkenini ayarlayın:

DBX_CONNECTION=local dbx query "select 1" --json
DBX_CONNECTION=local dbx context --tables users,orders

Çıktı Biçimleri

Kararlı, makine tarafından okunabilir çıktı için --json ya da --format json kullanın. Başka komut satırı araçlarına aktarılacak sorgu, bağlantı ve şema verisi için --format csv kullanın.

dbx query local "select id, name from users" --format csv

Hatalar stderr'e yazılır ve sıfır olmayan bir çıkış kodu döndürülür.

Sorgu Denetimleri

dbx query, SQL bağlantıları için SQL çalıştırır ve MongoDB bağlantıları için desteklenen Mongo kabuk komutlarını kabul eder. Redis bu komutla çalıştırılmaz; bunun yerine MCP Redis aracını ya da DBX çalışma alanını kullanın. Sorgu modu varsayılan olarak salt okunurdur.

dbx query local "select * from users" --limit 50 --timeout 10s --json

Süreler ms, s ya da m kabul eder; örneğin 500ms, 10s veya 1m.

Tehlikeli olmayan yazma ifadeleri için --allow-writes kullanın:

dbx query local "update users set name = 'Ada' where id = 1" --allow-writes

DROP, TRUNCATE ve ALTER gibi tehlikeli SQL hem --allow-writes hem --allow-dangerous-sql gerektirir. Açık işlem ifadeleri CLI tarafından engellenmeye devam eder; sabitlenmiş çok adımlı oturumlar için MCP durumlu oturumlarını ya da DBX düzenleyicisini kullanın.

Üretim veritabanlarına yapılan yazmalar ve DDL, iki bayrak da verilse bile engellenir. Üretim algılaması, SQL risk sınıflandırması, bağlantının salt okunur koruması ve veritabanı yetkileri bağımsız üst sınırlardır; bayraklar bir üretim atlatması değildir.

Tire ile Başlayan SQL

Tire ile başlayan SQL'den önce -- geçirin:

dbx query local --json -- "-- comment
select 1"

Hata Kodları

CLI JSON hataları kararlı kodlar kullanır:

Masaüstü Derin Bağlantıları

DBX Masaüstü; istemciyi tarayıcılardan, bastion sunuculardan ya da betiklerden başlatmak için derin bağlantıları destekler.

Başka bir iletişim kutusu açmadan DBX'i başlatın ya da öne getirin:

open 'dbx://open'

Bir web düğmesi protokole doğrudan bağlanabilir:

<a href="dbx://open">DBX'te Aç</a>

Bağlantı alanları önceden doldurulmuş yeni bağlantı iletişim kutusunu açmak için dbx://connection/new kullanın.

DSN modu:

open 'dbx://connection/new?url=postgres%3A%2F%2Fapp%3Asecret%40db.internal%3A5432%2Forders'

Alan modu:

open 'dbx://connection/new?type=mysql&host=127.0.0.1&port=3306&user=root&password=secret&database=test'

Desteklenen alanlar:

Tek seferlik bağlantı örneği:

open 'dbx://connection/new?type=redis&host=127.0.0.1&port=6379&user=default&password=secret&database=0&one_time=true'

Nacos ve servis kaydı örnekleri:

open 'dbx://connection/new?type=consul&host=127.0.0.1&port=8500&password=acl-token'
open 'dbx://connection/new?type=nacos-v3&host=127.0.0.1&port=8848&user=nacos&password=secret'
open 'dbx://connection/new?type=r-nacos&url=http%3A%2F%2F127.0.0.1%3A8848%2Fnacos&user=admin&password=secret'

nacos, nacos-v2 için; rnacos, r-nacos için takma addır. URL modunda servis uç noktası yolları korunur; üst düzeydeki host, port, user, password ve ssl alanları url içindeki değerleri geçersiz kılar. Consul için password, ACL belirtecidir. password verildiğinde Nacos user alanını gerektirir. v alanını atlamak ya da v=1 kullanmak geçerli derin bağlantı protokolünü seçer; diğer sürümler reddedilir.

Codex

Codex, CLI'yi doğrudan kabuk araçlarından çağırabilir:

dbx schema describe local users --json
dbx context local --tables users,orders | codex exec "Write a retention query"