Database Commands
Last validated: 2026-05-11
The db group manages shared database services through VBase gateway APIs.
Command Summary
| Command | Syntax | Underlying API call | Main use case |
|---|---|---|---|
| Create database service | dodil vbase db create <name> | AllocateDatabase | Provision new shared database service. |
| List services | dodil vbase db list | ListServices | Discover service IDs/status before selecting one. |
| Drop database service | dodil vbase db drop <service_id> | DeleteDatabase | Decommission shared service. |
| Use database context | dodil vbase db use <service_id> | GetServiceAccess | Resolve endpoint/port/db_name and save active context. |
| Connectivity test | dodil vbase db test-grpc | ListServices over direct gRPC dial | Validate gateway connectivity and auth quickly. |
Arguments and Flags
db create <name>
Arguments:
<name>: service name to allocate.
Flags:
--orgexists but current implementation uses org from config (global.org_id).
Example:
dodil vbase db create my-shared-dbdb list
Flags:
--orgexists but current implementation uses org from config.-o jsonfor machine-readable output.
Example:
dodil vbase db list -o jsonImportant behavior:
- this command calls
ListServicesand may include non-database service types, depending on backend response.
db drop <service_id>
Arguments:
<service_id>: service ID to remove (not the display name).
Example:
dodil vbase db drop 5fbd6b4f-9cb8-4ba8-b6d5-41f221d0c2abdb use <service_id>
Arguments:
<service_id>: service ID to resolve access for.
Flags:
--orgexists but current implementation uses org from config.
Behavior:
- calls
GetServiceAccess - updates
~/.config/dodil/config.yamlundervbasewith:hostportdb_nameservice_name
Example:
dodil vbase db use <service_id>db test-grpc
Purpose:
- validates gateway gRPC reachability and auth by invoking
ListServices
Example:
dodil vbase db test-grpcTypical Usage Sequence
dodil login <service_account_id> <service_account_secret>
dodil vbase db create my-shared-db
dodil vbase db list
dodil vbase db use <service_id>Common Mistakes
- Passing DB name to
db useordb dropinstead of service ID. - Expecting
db listto include only database services. - Running db commands before successful Dodil CLI login.