Command-line interface reference for databases.do - Collections of data resources (see database.do)

Databases CLI

Collections of data resources (see database.do)

Installation

# Install globally
npm install -g do

# Or use via npx
npx do --version

Quick Start

# Basic usage
do db query databases --where.active=true

Commands

Main Command

do db query databases --where.active=true

Description: Collections of data resources (see database.do)

Usage:

do databases [options]

Options

Global Options

--help, -h - Show help
--version, -v - Show version
--verbose - Verbose output
--quiet, -q - Quiet mode
--json - JSON output
--config <file> - Config file path

Command-Specific Options

do databases \
  --option1=value1 \
  --option2=value2 \
  --verbose

Usage Examples

Basic Example

# Simple usage
do db query databases --where.active=true

With Options

# With configuration
do db query databases --where.active=true --verbose --json

Interactive Mode

# Interactive prompts
do databases --interactive

Batch Operations

# Process multiple items
do databases --batch items.json

Pipeline Integration

# Use with pipes
cat data.json | do databases --stdin | jq '.'

Configuration

Config File

Create .doconfig in your project:

{
  "databases": {
    "option1": "value1",
    "option2": "value2"
  }
}

Environment Variables

export DO_DATABASES_OPTION1=value1
export DO_DATABASES_OPTION2=value2

do db query databases --where.active=true

Output Formats

Default Output

do db query databases --where.active=true
# ✓ Operation completed
# Result: ...

JSON Output

do db query databases --where.active=true --json
# {
#   "success": true,
#   "result": { ... }
# }

Verbose Output

do db query databases --where.active=true --verbose
# → Starting operation...
# → Processing...
# → Completed in 1.2s

Scripting

Bash Scripts

#!/bin/bash

# Check if successful
if do db query databases --where.active=true; then
  echo "Success!"
else
  echo "Failed!"
  exit 1
fi

CI/CD Integration

# GitHub Actions
- name: Run Databases
  run: |
    do db query databases --where.active=true \
      --config prod.json \
      --quiet

Error Handling

Exit Codes

0 - Success
1 - General error
2 - Invalid arguments
3 - Timeout
4 - Not found

Error Messages

# Capture errors
do db query databases --where.active=true 2>errors.log

# Handle errors
if ! do db query databases --where.active=true; then
  echo "Error occurred, check errors.log"
  exit 1
fi

Debugging

# Debug mode
DEBUG=* do db query databases --where.active=true

# Dry run
do db query databases --where.active=true --dry-run

# Verbose + timing
time do db query databases --where.active=true --verbose

Best Practices

Use Config Files - Store configuration in .doconfig
Environment Variables - Use for sensitive data
Error Handling - Check exit codes in scripts
JSON Output - Use --json for parsing results
Verbose Mode - Use --verbose for debugging

Databases CLI

On this page