Workflow: Shared Database Lifecycle (CLI)

Last validated: 2026-05-11

Use this workflow to provision and operate shared VBase services with CLI-first commands.

When to Use

onboarding a new tenant database quickly
enabling teams to run collection/data commands without manual endpoint setup
validating auth and service context from terminal only

Step 1: Authenticate


dodil login <service_account_id> <service_account_secret>

Expected outcome:

token and org context saved in ~/.config/dodil/config.yaml

Step 2: Create shared database service


dodil vbase db create my-shared-db

Arguments:

my-shared-db: service name to allocate.

Step 3: List services and capture target service ID


dodil vbase db list

Tip:

use -o json for automation parsing.


dodil vbase db list -o json

Step 4: Select service context


dodil vbase db use <service_id>

This step resolves and writes:

vbase.host
vbase.port
vbase.db_name

Step 5: Verify tenant endpoint health and version


dodil vbase status
dodil vbase version

Optional API Validation (gRPC)

If you need independent verification outside CLI:


grpcurl -insecure \
  -H "authorization: Bearer $TOKEN" \
  -d '{"organization_id":"'"$ORG_ID"'"}' \
  "rpc.dev.dodil.io:443" dodil.vbase.v1.VBaseService/ListServices

Optional API Validation (HTTP)


curl -sS \
  -H "Authorization: Bearer $TOKEN" \
  "https://api.dev.dodil.io:443/v1/vbase/list/$ORG_ID"

Cleanup


dodil vbase db drop <service_id>

Use with caution in shared environments.