SQLOZ User Guide & Documentation
Info: This guide is a comprehensive reference for using SQLOZ at a professional level. Each chapter explains real database administration scenarios and how SQLOZ addresses them, step by step.
In this chapter:
Structure of the Guide
Every chapter follows a consistent structure:
- A short summary of the tasks and concepts covered by the chapter.
- Step-by-step procedures for completing the task.
- Important notes, warnings and tips (
::: tip/::: warningblocks). - Links to related chapters at the end of each section (“Related Topics”).
Chapter List
1. Getting Started
System requirements, first setup, creating your first connection, the interface layout, multilingual use, the appearance mode and an overview of the core engines. Open Chapter 1
2. Connections & Tunnels
Direct TCP/IP connections, SSH Jump Host tunnels, the HTTP PHP tunnel (sqloz-tunnel.php), environment color tags and the secure storage of credentials in the macOS Keychain.
Open Chapter 2
3. SQL Editor & Query Execution
Memory protection (bounded streaming), non-blocking query cancellation, multiple result tabs, transaction and savepoint controls, query history and safety gates. Open Chapter 3
4. Data Grid & Editing
Inline cell editing, the cell inspector panel, filtering and sorting, multi-format result export, and the CSV/JSON/XML/XLSX import wizard. Open Chapter 4
5. Visual Schema Designer
ERD canvas, reverse/forward engineering, drag-and-drop foreign keys, key/index badges and visual export. Open Chapter 5
6. Schema Compare & Synchronization
Finding schema differences between databases, reviewing the migration plan, and applying supported changes with safety checks. Open Chapter 6
7. Data Compare & Synchronization
Row-by-row data comparison, impact analysis reports, throttle delay, and review or application of a supported synchronization plan. Open Chapter 7
8. Visual Query Builder
Dragging tables onto the canvas, automatic JOIN detection, column selection, aliases, grouping, filtering, sorting, row limits, generated SQL, XML save/open and query execution. Open Chapter 8
9. DBA Suite & Server Health
Live Processlist, safe query/server termination, server health scan and a security linter. Open Chapter 9
10. Security, Backup & Disaster Recovery
Operation-specific confirmations, backup prerequisites, recovery limits, and Screen Lock. Open Chapter 10
11. Cross-Dialect Migration
Cross-dialect schema/data transfer and dialect detection between MySQL, PostgreSQL and SQLite. Open Chapter 11
12. Preferences & Advanced Configuration
The preferences window, central SMTP configuration, app-managed Pro evaluation and subscription access. Open Chapter 12
13. References, Shortcuts & Troubleshooting
The macOS shortcut table and solutions for common server connection errors. Open Chapter 13
14. OzAI - Natural Language SQL Assistant
Natural-language SQL generation, slow-query optimization, local AI provider setup and data privacy. Open Chapter 14
15. OzCharts - Visualization
Converting query results into charts, supported chart types and high-resolution export. Open Chapter 15
16. OzTeam - Encrypted Profile Exchange
Securely sharing connection profiles as AES-256-GCM encrypted .sqlozprofile capsules.
Open Chapter 16
17. OzOSC - Zero-Downtime Schema Changes
Online schema changes using guarded shadow-table copy and atomic table swap, with explicit recovery controls. Open Chapter 17
18. OzLockTree - Lock Resolver
Live lock dependencies, root blocker detection and the difference between KILL QUERY and KILL CONNECTION.
Open Chapter 18
19. OzExplain - Execution Tree & Index Advisor
A visual execution tree, estimated vs. actual row divergence and index recommendations. Open Chapter 19
20. OzMask - PII Anonymizer
Masking sensitive fields such as email, phone, card and identity data in live data. Open Chapter 20
Supported databases and operations
See the supported engine/version matrix and the Operations Center and Scheduled Jobs guide for the current platform boundaries. Open the supported database matrix · Open Operations & Scheduled Jobs