Описать схему SQLite
Собирает таблицы, колонки и индексы базы в Markdown или CSV.
Что делает скрипт
Скрипт читает sqlite_master и PRAGMA-функции, поэтому не требует ORM и работает с любой базой. В Markdown попадают таблицы, типы, NOT NULL, значения по умолчанию, первичные ключи и индексы. CSV содержит по строке на колонку и удобен для сравнения версий схемы. База открывается только для чтения.
- Схема читается на соединении read-only. Существующий выходной файл не перезаписывается без --force.
Быстрый старт
bash sqlite_schema.sh --db app.db --output schema.md
Скачайте файл, откройте терминал в папке со скриптом и выполните команду.
Другие варианты
bash sqlite_schema.sh --db app.db --format csv --output schema.csvbash sqlite_schema.sh --db app.db --output docs/schema.md --force
Что понадобится
sudo apt install bash
brew install bash
sudo apt install sqlite3
brew install sqlite
sqlite_schema.sh
#!/usr/bin/env bash
set -euo pipefail
usage() {
echo "Использование: $0 --db <файл.db> [--output <файл>] [--format md|csv] [--force]"
}
db=""
output=""
format="md"
force=0
while [[ $# -gt 0 ]]; do
case "$1" in
--db) db="${2:-}"; shift 2 ;;
--output) output="${2:-}"; shift 2 ;;
--format) format="${2:-}"; shift 2 ;;
--force) force=1; shift ;;
-h|--help) usage; exit 0 ;;
*) echo "Неизвестный аргумент: $1" >&2; usage >&2; exit 2 ;;
esac
done
if [[ -z "$db" ]]; then
usage >&2
exit 2
fi
if ! command -v sqlite3 >/dev/null 2>&1; then
echo "Не найдена программа sqlite3" >&2
exit 2
fi
if [[ ! -f "$db" ]]; then
echo "База не найдена: $db" >&2
exit 2
fi
if [[ "$format" != "md" && "$format" != "csv" ]]; then
echo "Формат должен быть md или csv" >&2
exit 2
fi
if [[ -z "$output" ]]; then
if [[ "$format" == "md" ]]; then
output="schema.md"
else
output="schema.csv"
fi
fi
if [[ -e "$output" && "$force" -eq 0 ]]; then
echo "Файл уже существует: $output. Добавьте --force" >&2
exit 2
fi
tables=$(sqlite3 -readonly "$db" "SELECT name FROM sqlite_master WHERE type='table' AND name NOT LIKE 'sqlite_%' ORDER BY name;")
if [[ -z "$tables" ]]; then
echo "В базе нет пользовательских таблиц" >&2
exit 1
fi
mkdir -p "$(dirname "$output")"
tmp=$(mktemp "${output}.tmp.XXXXXX")
trap 'rm -f "$tmp"' EXIT
if [[ "$format" == "csv" ]]; then
printf 'table,column_index,column,type,not_null,default,pk\n' > "$tmp"
while IFS= read -r table; do
[[ -z "$table" ]] && continue
escaped=$(printf '%s' "$table" | sed "s/'/''/g")
sqlite3 -readonly -csv -noheader "$db" \
"SELECT '$escaped', cid, name, coalesce(type,''), \"notnull\", coalesce(cast(dflt_value as text),''), pk FROM pragma_table_info('$escaped') ORDER BY cid;" >> "$tmp"
done <<< "$tables"
else
{
echo "# Схема базы"
echo
echo "Файл: \`$db\`"
echo
while IFS= read -r table; do
[[ -z "$table" ]] && continue
escaped=$(printf '%s' "$table" | sed "s/'/''/g")
display=$(printf '%s' "$table" | sed 's/|/\\|/g')
columns=$(sqlite3 -readonly "$db" "SELECT count(*) FROM pragma_table_info('$escaped');")
index_count=$(sqlite3 -readonly "$db" "SELECT count(*) FROM pragma_index_list('$escaped');")
echo "## $display"
echo
echo "Колонок: $columns. Индексов: $index_count."
echo
echo "| # | Колонка | Тип | NOT NULL | По умолчанию | PK |"
echo "|---|---|---|---|---|---|"
sqlite3 -readonly -noheader -list "$db" \
"SELECT '| ' || cid || ' | ' || replace(name, '|', '\|') || ' | ' || replace(coalesce(type,''), '|', '\|') || ' | ' || CASE \"notnull\" WHEN 1 THEN 'да' ELSE '' END || ' | ' || replace(coalesce(cast(dflt_value as text),''), '|', '\|') || ' | ' || CASE pk WHEN 0 THEN '' ELSE 'да' END || ' |' FROM pragma_table_info('$escaped') ORDER BY cid;"
echo
echo "### Индексы"
echo
indexes=$(sqlite3 -readonly -noheader -list "$db" \
"SELECT '| ' || replace(name, '|', '\|') || ' | ' || CASE \"unique\" WHEN 1 THEN 'да' ELSE 'нет' END || ' |' FROM pragma_index_list('$escaped') ORDER BY name;")
if [[ -z "$indexes" ]]; then
echo "Индексов нет."
else
echo "| Индекс | Уникальный |"
echo "|---|---|"
printf '%s\n' "$indexes"
fi
echo
done <<< "$tables"
} > "$tmp"
fi
mv "$tmp" "$output"
trap - EXIT
echo "Таблиц: $(printf '%s\n' "$tables" | wc -l | tr -d ' ')"
echo "Формат: $format"
echo "Результат: $output"
Скрипты работают с файлами и настройками системы. Перед запуском прочитайте код и проверьте пути. Особенно если скрипт удаляет, перезаписывает или перемещает данные.