Configuration Reference¶

[database]
# Default query result limit
default_limit = 1000

# Connection timeout in seconds
timeout = 30

# Maximum number of connection retries
max_retries = 3

# Show query execution time
show_execution_time = true

# Automatically run EXPLAIN for slow queries
auto_explain_threshold = 1000  # milliseconds

# SSL verification mode
verify_ssl = true

# Query timeout in seconds
query_timeout = 300

[display]
# Table formatting
border_style = 1                    # 0=none, 1=light, 2=heavy
max_column_width = 50               # Maximum width for table columns
truncate_long_values = true         # Truncate values longer than max width
null_display = "NULL"               # How to display NULL values

# Date and number formatting
date_format = "%Y-%m-%d %H:%M:%S"   # strftime format for timestamps
number_format = "human"             # "raw" or "human" (with thousands separator)

# Column selection settings
column_selection_threshold = 10     # Auto-trigger when >N columns
column_selection_default_all = false # Default to all columns selected

# Pagination
enable_paging = true                # Enable result paging for large outputs
page_size = 50                      # Rows per page when paging enabled

# Output formats
default_output_format = "table"     # "table", "csv", "json", "expanded"

[ui]
# Startup behavior
show_banner = true                  # Show DBCrust banner on startup
auto_connect = false                # Auto-connect to recent database

# Prompt customization
show_database_in_prompt = true      # Show database name in prompt
show_host_in_prompt = false         # Show hostname in prompt
prompt_format = "{user}@{db}=> "    # Custom prompt format

# Interactive features
enable_autocomplete = true          # Enable SQL/command autocompletion
autocomplete_min_chars = 2          # Minimum characters before suggestions
history_size = 1000                 # Command history size

# Confirmation prompts
confirm_destructive_operations = true  # Confirm DROP, DELETE, etc.
confirm_large_results = true          # Confirm queries returning many rows
large_result_threshold = 10000        # Threshold for "large" results

[logging]
# Log level: trace, debug, info, warn, error
level = "info"

# Output destinations
console_output = true               # Log to console/terminal
file_output = false                 # Log to file

# File logging settings
file_path = "~/.config/dbcrust/dbcrust.log"  # Log file location
max_file_size_mb = 10              # Max log file size before rotation
max_files = 5                       # Number of rotated files to keep

# Log filtering
enable_query_logging = false        # Log all executed queries
enable_performance_logging = true   # Log performance metrics
log_connection_events = true        # Log connection attempts

[ssh_tunnel_patterns]
# Pattern = "ssh_connection_string"
"^db\\.internal\\..*\\.com$" = "user@jumphost.example.com:2222"
"^.*\\.prod\\.company\\.com$" = "deploy@bastion.company.com"
"^postgres-.*\\.docker\\.local$" = "docker@localhost:2222"

# Multiple patterns can be defined
"^staging-.*" = "staging-user@staging-jumphost:22"
"^dev-.*" = "dev-user@dev-jumphost:22"

[vault]
# Vault server configuration
addr = "https://vault.company.com"
token_file = "~/.vault-token"

# Credential caching
credential_cache_enabled = true
cache_renewal_threshold = 0.25      # Renew when 25% TTL remaining
cache_min_ttl_seconds = 300         # Minimum 5 minutes TTL required

# Default vault paths
default_mount_path = "database"
default_role = "readonly"

# Authentication
auth_method = "token"               # "token", "userpass", "ldap", etc.

[docker]
# Container discovery
enable_discovery = true
discovery_timeout = 5               # Seconds to wait for container list

# Container filtering
supported_images = [               # Image patterns for database containers
    "postgres*",
    "mysql*",
    "mariadb*",
    "sqlite*"
]

# Connection defaults
default_user = "postgres"           # Default username for containers
prefer_named_containers = true     # Prefer containers with custom names

# OrbStack integration (macOS)
enable_orbstack_integration = true

[saved_sessions.production]
host = "prod.db.company.com"
port = 5432
user = "app_user"
dbname = "myapp_prod"
database_type = "PostgreSQL"
created_at = "2024-01-15T10:30:00Z"

[saved_sessions.staging]
host = "staging.db.company.com"
port = 5432
user = "app_user"
dbname = "myapp_staging"
database_type = "PostgreSQL"
created_at = "2024-01-15T11:15:00Z"

[[recent_connections]]
connection_url = "postgres://user@localhost:5432/testdb"
display_name = "user@localhost:5432/testdb"
timestamp = "2024-01-15T14:22:33Z"
database_type = "PostgreSQL"
success = true

[[recent_connections]]
connection_url = "docker://postgres-dev/myapp"
display_name = "docker://postgres-dev/myapp"
timestamp = "2024-01-15T14:20:15Z"
database_type = "PostgreSQL"
success = true

# ~/.config/dbcrust/named_queries.toml

[global]
count_all = "SELECT COUNT(*) FROM $1"
user_by_id = "SELECT * FROM users WHERE id = $1"

[postgres]
table_sizes = "SELECT schemaname, tablename, pg_size_pretty(pg_total_relation_size(schemaname||'.'||tablename)) as size FROM pg_tables ORDER BY pg_total_relation_size(schemaname||'.'||tablename) DESC"

[mysql]
show_status = "SHOW GLOBAL STATUS LIKE '$1'"

# Session-local queries stored per connection
["session:postgres://user@localhost:5432/myapp"]
daily_report = "SELECT DATE(created_at), COUNT(*) FROM orders GROUP BY DATE(created_at)"

[database]
default_limit = 100
show_execution_time = true
auto_explain_threshold = 500

[display]
column_selection_threshold = 8
max_column_width = 100

[ui]
show_banner = true
enable_autocomplete = true

[logging]
level = "debug"
console_output = true
enable_query_logging = true

[database]
default_limit = 1000
show_execution_time = false
auto_explain_threshold = 2000
verify_ssl = true

[display]
column_selection_threshold = 15
max_column_width = 50

[ui]
show_banner = false
confirm_destructive_operations = true

[logging]
level = "warn"
console_output = false
file_output = true
file_path = "/var/log/dbcrust.log"

[database]
default_limit = 500
show_execution_time = true

[ui]
confirm_destructive_operations = true
confirm_large_results = true
large_result_threshold = 5000

[ssh_tunnel_patterns]
"^.*\\.internal\\.company\\.com$" = "user@bastion.company.com"
"^.*\\.prod\\..*$" = "prod-user@prod-bastion.company.com:2222"

[vault]
addr = "https://vault.company.com"
default_mount_path = "database"
default_role = "readonly"