Calíope Help
All sections
Calíope tools
Getting Started
- Welcome to Calíope
- Try Calíope against real servers (Docker)
- A heavy sample database (caliope-demo.db)
- Connecting for the first time
- Navigating the Workspace
- Why some tools are missing
- Filtering and collapsing the Tools sidebar
- Offline mode
- Status bar
- Customize the SQL Editor toolbars
- Customize the main toolbar
- Simultaneous sessions across servers
- Open the help center
- Getting around Help: the engine filter, “Go” and the SQL examples
- The tools in the bottom bar
- When the connection is lost
Connections
- Create a Connection Profile
- Edit an Existing Connection
- Delete a connection
- One server with two addresses
- The MongoDB connection string
- Test the Connection
- Connect to the Server
- Change the Active Database
- Close the Connection
- Automatic Reconnection
- Simultaneous Connections to Multiple Servers
- Server Selector Menu
- Add a Server from the Workspace
- Disconnect an Individual Server
- Configure SSL/TLS
- Biometric Authentication
- Organizing profiles into groups
- Environment tags
- Protection levels
- Filtering the connections list
- Server families and products
- Clone a connection profile
- Load the list of databases, character sets and collations
- SSH tunnel notifications
SSH Tunnel
SQL Editor
- Run a SQL query
- Stop a running query
- Clear editor and results
- Format SQL (Beautify)
- Curly quotes that break a query
- Safe mode
- Transactions
- Query history
- Visual EXPLAIN
- Statement delimiter
- Export results to file
- Export table as INSERT
- Output formats
- Concatenate results
- Auto-repeat (polling)
- Link DB — connect a second database
- Compare results between two servers
- Insert snippet in the editor
- View full cell value
- Advanced cell edit
- Generate UPDATE from cell
- Delete row from results
- Contextual help for SQL functions
- SQL statement manager
- Run complete script
- The results grid
- Find and replace in the editor
- Navigate history from the editor (REPL style)
- Pin results to compare
- Integrated SQL terminal (REPL mode)
- Export results in multiple formats
- Expand SELECT * into explicit columns
- Autocomplete in the SQL editor
- Fold and unfold blocks in the editor
- Performance monitor (CPU and memory)
- Toggle SQL comment (⌘D)
- Linting — error diagnosis before executing
- Automatic line wrap (word wrap)
- Bracket pair highlighting
- Highlight every match of a word
- Column editing / multi-cursor
- Go to Definition
- DDL hover tooltip
- Quick Open — Quick object access
- Rename symbol in script
- Query Builder — Visual query constructor
- Editor minimap
- Open SQL files by dragging
- Customize toolbars
- Long query notification
- Large result set notification
- Advanced Cell Editor (long text, JSON, binary)
- Comparing results of two queries
- View and edit spatial data on a map
- The editor's schema panel
- Progress of the running query
- Insert identifier quotes
- Font size of the editor and the results
- Print the result
- Undo a data edit
- The builder canvas is kept when you switch tools
- Column Profiler
- Execution Profile (SHOW PROFILE)
- Index Advisor
- Result Chart
- Query Benchmark
Schema Tree
Global search
Snippets
Statement Manager
Reports
Catalogs
- Browse Catalogs
- View and Edit Object DDL
- Create New Table
- Create Views, Indexes, Routines, Triggers, and Events
- Edit Views, Routines, Triggers, and Events
- Populate Table with Dummy Data
- Read-Only Mode
- View Editor
- Routine and Function Editor
- Trigger Editor
- Event Scheduler Editor
- Index Editor
- Search and refresh in Catalogs
- Delete objects from Catalogs
Table Builder
ER Diagram
Visual EXPLAIN
Data Migration
Data Import
Dashboard
- Opening the Dashboard
- Traffic and query charts
- Distribution charts
- Changing the Dashboard layout
- Server performance charts
- Automatic Dashboard alerts
- Zoom on Dashboard cards
- Customize the Dashboard
- TV mode
- Pause and resume the Dashboard
- Pin the widget’s server from the Dashboard
- Full screen Dashboard
- Server Alerts
Server Health
SQL Alerts
Replication
Query Log
- View the query log
- Filter by session
- Search the log
- Filter by connection
- Filter by result
- Manually refresh the log
- Copy result from the log
- Purge the persistent log
- Log file path and size
- Sync the log with iCloud
- Resolve iCloud sync errors
- iCloud sync failure notification
- Take a log entry to the editor
- Print the query log
Server slow query log
Errors & diagnostics
- Viewing the error log
- Seeing errors from your other device
- Couldn’t connect to the server
- Access denied by the server
- The database doesn’t exist
- The connection to the server dropped
- The SSH server rejected your credentials
- The SSH host key changed
- The private key couldn’t be read
- The SSH tunnel closed on its own
- The SSH server didn’t answer
- iCloud isn’t available
- iCloud sync failed
- iCloud storage ran out
- Calíope has no permission for that file
- The stored permission stopped working
- Safe Mode blocked a statement
- The assistant’s API key is missing
- The provider rejected the request over quota
- A restore stopped halfway
- Take Calíope’s error log out
- Turn the error log on or off
Server Information
Process List
Users
Backup & Restore
Table Maintenance
AI Assistant
- Open the AI Assistant
- Configure the AI provider
- Apple Intelligence in the assistant
- Ollama: models on your own machine
- MCP server: let your AI client query Calíope
- Set up your AI client to talk to Calíope
- What your AI client sees, and what it does with it next
- Load generated SQL into the editor
- Schema context: what gets sent
- Maximum length of generated SQL
- Model response timeout
- Dictate requests by voice
- Export the AI conversation
- Legal Notice & AI Assistant Privacy
- Conversation history
- Syncing the history with iCloud
- Copying the assistant's answers
SQLite Editor
DuckDB Editor
File Previewer
MongoDB
Redis
- Browse keys
- Server status
- Analyze memory
- Slow commands
- Connected clients
- The command console
- The server topology
- Redis reports
- When the Redis server panel cannot read
- When the Redis memory analysis fails
- When Redis slow commands cannot be read
- When the Redis client list cannot be reread
- When the Redis console gets no reply
- When the Redis topology cannot be reread
Settings
- Interface Language
- Settings — General
- Keep Calíope Running in the Background
- Open Calíope at Login
- Settings — Text Editor
- Settings — Connections
- Settings — AI Assistant
- Usage tips
- Calíope notifications
- Restore tabs on reconnect
- iCloud Sync
- "Keep Awake" mode
- Why does my Mac still sleep when I close the lid?
- What’s running right now
- What shows up and what doesn’t
- Go to, stop, and why sometimes you can’t
Privacy
Calíope on your other devices
Widgets
Siri & Shortcuts
Keyboard Shortcuts
Gestures
Menus
Accessibility
Purchase
DBA Handbook
- Data types
- Indexes
- Normalization
- Joins
- Server configuration
- Limits and restrictions
- Best practices
- Performance and optimization
- Transactions and isolation levels
- Locks and deadlocks
- Table partitioning
- CTEs and window functions
- Transactions and isolation levels (PostgreSQL)
- VACUUM, autovacuum and the space that never comes back
- Locks and deadlocks (PostgreSQL)
- Indexes (PostgreSQL)
- Performance and diagnosis (PostgreSQL)
- Server configuration (PostgreSQL)
- Roles, permissions and security (PostgreSQL)
- Backup and recovery (PostgreSQL)
- Online schema changes (PostgreSQL)
- Data types (PostgreSQL)
- Errors and SQLSTATE (PostgreSQL)
- Partitioning (PostgreSQL)
- Encoding and collation (PostgreSQL)
- Limits (PostgreSQL)
- Encoding and collations (SQL Server)
- Data types (SQL Server)
- Errors (SQL Server)
- Indexes (SQL Server)
- Limits (SQL Server)
- Locks and deadlocks (SQL Server)
- Online schema changes (SQL Server)
- Partitioning (SQL Server)
- Performance and diagnosis (SQL Server)
- Backup and recovery (SQL Server)
- Logins, users and permissions (SQL Server)
- Server configuration (SQL Server)
- Transactions and isolation levels (SQL Server)
- Data types (ClickHouse)
- Table engines (ClickHouse)
- Keys and skip indexes (ClickHouse)
- Partitions and TTL (ClickHouse)
- Materialized views (ClickHouse)
- Mutations and deletes (ClickHouse)
- Transactions and atomicity (ClickHouse)
- Performance (ClickHouse)
- Merges and OPTIMIZE (ClickHouse)
- Replication and Keeper (ClickHouse)
- Security: users, roles and privileges (ClickHouse)
- Server configuration (ClickHouse)
- Limits (ClickHouse)
- Common errors (ClickHouse)
- Numbers (Oracle)
- Text and the empty string (Oracle)
- Dates and times (Oracle)
- B-tree indexes (Oracle)
- Function-based, invisible and bitmap indexes (Oracle)
- Unusable indexes and rebuilding (Oracle)
- Primary and unique keys (Oracle)
- Foreign keys (Oracle)
- Identity and sequences (Oracle)
- Range and interval partitioning (Oracle)
- List, hash and automatic partitioning (Oracle)
- Partition pruning and maintenance (Oracle)
- Tablespaces and quotas (Oracle)
- Segments and extents (Oracle)
- Space that does not come back: DELETE, TRUNCATE and SHRINK (Oracle)
- Commit, rollback and the DDL that commits (Oracle)
- Read consistency (Oracle)
- Isolation levels and SET TRANSACTION (Oracle)
- Row locks and who blocks whom (Oracle)
- Not waiting: NOWAIT, WAIT and SKIP LOCKED (Oracle)
- Deadlocks (Oracle)
- The optimizer and EXPLAIN PLAN (Oracle)
- Statistics and DBMS_STATS (Oracle)
- The cursor cache and V$SQL (Oracle)
- Users, roles and privileges (Oracle)
- Profiles, expiring passwords and locked accounts (Oracle)
- Backup and recovery: RMAN, flashback and Calíope’s dump (Oracle)
- Parameters and NLS (Oracle)
- Memory, processes and sessions (Oracle)
- Limits (Oracle)
- Common ORA- errors (Oracle)
- Good practices (Oracle)
- Data modelling: embedding vs. referencing
- BSON types and collation
- Indexes: which one to pick and the ESR rule
- The aggregation pipeline: from $match to $merge
- Transactions: when you need them and conflict 112
- Performance: explain, plan cache and profiler
- Server configuration: the file and what changes hot
- Security: users, roles and the localhost exception
- Backup: mongodump, the oplog and what it does not cover
- Schema: there is no ALTER, there is a validator
- Sharding: the key decides everything
- Frequent errors: the eight numbers and what they carry
- Limits: the eight ceilings and how each one warns you
- Best practices: seven that stand on a number
- Data structures and encodings
- Keys, names and expiry
- Memory and eviction
- Persistence: RDB and AOF
- Clients and latency
- Performance
- Transactions and scripts
- Replicas and cluster
- Security and ACLs
- Server configuration
- Common errors
- What not to do
- Types: affinity, and why a column does not compel
- Transactions: one writer, and the 5 that proves it
- Pragmas: the file's, the connection's, and the commands
- Indexes: there is only the B-tree, and three words in the plan
- Performance: the transaction is worth 440 times the rest
- DDL: four things ALTER can do, and the detour for the rest
- Backup: copying the file is how you lose it
- Errors: eight codes, and the one with four digits says more
- Limits: the eight ceilings, and where they are written
- Best practices: seven, and four are set when you open
- Security, users and roles
- Backup and point-in-time recovery
- Online DDL: changing the schema without stopping
- Character sets and collations
- Common errors and what they mean