SQL Snippets
Create customizable SQL snippet templates with custom trigger keys for faster query writing.
SQL Snippets let you define reusable SQL templates that expand automatically when you type a trigger key. This is useful for frequently written query patterns, standard clauses, or team-specific SQL conventions.
How Snippets Work
- You define a snippet with a trigger key and a template
- In the SQL editor, type the trigger key
- DBX auto-completes the trigger to the full template
- Placeholders in the template let you tab through editable positions
Creating A Snippet
Open Snippet Settings
Go to Settings → SQL Snippets.
Add a New Snippet
Click Add Snippet and fill in:
- Trigger: a short key you type in the editor (e.g.,
selall,joinex) - Template: the SQL text that replaces the trigger
Use the Snippet
In the SQL editor, type the trigger key and press Tab or select it from the autocomplete list. The template expands in place.
Example Snippets
Here are some useful snippet templates to get started:
SELECT with common clauses:
SELECT ${1:columns}
FROM ${2:table}
WHERE ${3:condition}
ORDER BY ${4:column}LEFT JOIN pattern:
LEFT JOIN ${1:table} ON ${2:left_alias}.${3:column} = ${4:right_alias}.${5:column}COUNT with GROUP BY:
SELECT ${1:column}, COUNT(*) AS cnt
FROM ${2:table}
GROUP BY ${1:column}
HAVING COUNT(*) > ${3:threshold}
ORDER BY cnt DESCCREATE TABLE template:
CREATE TABLE ${1:table_name} (
${2:id} INTEGER PRIMARY KEY,
${3:column} ${4:type}
);Placeholders
Use ${1}, ${2}, etc. in templates to mark editable positions. After expansion, press Tab to jump between placeholders. Placeholders with the same number are edited simultaneously.
Tips
- Keep triggers short but memorable (3-6 characters works well)
- Use a consistent prefix for personal snippets (e.g.,
my_selall) - Review expanded snippets before execution, especially on production databases
- Share useful snippets with your team for consistent query patterns