Модуль SQLite Zipfile

1. Обзор

Модуль zipfile предоставляет чтение/запись в простые архивы ZIP. Текущая реализация имеет следующие ограничения:

• Не поддерживает шифрование.
• Не поддерживает архивы ZIP, распределённые по нескольким файлам.
• Не поддерживает расширения zip64.
• Поддерживается только алгоритм сжатия "deflate".

Некоторые или все эти ограничения могут быть сняты в будущем.

2. Получение и компиляция Zipfile

Код модуля zipfile находится в файле ext/misc/zipfile.c основного дерева исходного кода SQLite. Его можно скомпилировать в загружаемый расширение SQLite с помощью команды типа:

gcc -g -fPIC -shared zipfile.c -o zipfile.so

В качестве альтернативы, файл zipfile.c можно скомпилировать в приложение. В этом случае для регистрации расширения с каждой новой базой данных необходимо вызвать следующую функцию:

int sqlite3_zipfile_init(sqlite3 *db, void*, void*);

В качестве первого аргумента должен быть передан дескриптор базы данных, с которым нужно зарегистрировать расширение. Второй и третий аргументы должны быть равны 0.

Zipfile включен в большинство сборок оболочки командной строки.

3. Использование Zipfile

Модуль zipfile предоставляет три похожих интерфейса для доступа, обновления и создания архивов zip-файлов:

1. Функция со значениями таблицы, обеспечивающая доступ только для чтения к существующим архивам, как из файловой системы, так и в памяти.
2. Виртуальная таблица, обеспечивающая доступ для чтения и записи к архивам, хранящимся в файловой системе.
3. Функция агрегирования SQL, которая может использоваться для создания новых архивов в памяти.

Модуль zipfile предоставляет два аналогичных интерфейса для доступа к архивам zip. Функция со значениями таблицы, предоставляющая доступ только для чтения к существующим архивам, и интерфейс виртуальной таблицы, предоставляющий доступ для чтения и записи.

3.1. Функция со значениями таблицы (только чтение)

Для чтения существующих архивов zip модуль Zipfile предоставляет функцию со значениями таблицы, принимающую один аргумент. Если аргумент имеет текстовое значение, то это путь к архиву zip для чтения из файловой системы. Или, если аргумент — SQL-двоичное значение, то это данные самого архива zip.

Например, чтобы проверить содержимое архива zip "test.zip" из текущего каталога:

SELECT * FROM zipfile('test.zip');

Или, из инструмента оболочки SQLite (функция readfile() считывает содержимое файла из файловой системы и возвращает его в виде двоичных данных):

SELECT * FROM zipfile( readfile('test.zip') );

Функция со значениями таблицы возвращает одну строку для каждой записи (файл, каталог или символическая ссылка) в архиве zip. Каждая строка содержит следующие столбцы:

3.2. Интерфейс виртуальной таблицы (чтение/запись)

Для создания или изменения существующего zip-файла необходимо создать виртуальную таблицу "zipfile" в схеме базы данных. Оператор CREATE VIRTUAL TABLE ожидает путь к zip-файлу в качестве единственного аргумента. Например, для записи в zip-файл "test.zip" в текущем каталоге виртуальная таблица zipfile может быть создана с помощью:

CREATE VIRTUAL TABLE temp.zip USING zipfile('test.zip');

Такая виртуальная таблица имеет те же столбцы, что и функция со значениями таблицы, описанная в предыдущем разделе. К ней можно обращаться с помощью оператора SELECT так же, как и к функции со значениями таблицы.

Используя интерфейс виртуальной таблицы, новые записи могут быть добавлены в архив zip, вставив новые строки в виртуальную таблицу. Записи могут быть удалены путем удаления строк или изменены путем обновления.

3.2.1. Добавление записей в архив ZIP

Записи могут быть добавлены в архив zip путем вставки новых строк. Наиболее простой способ — указать значения только для столбцов "name" и "data", и zipfile заполнит разумные значения для других полей. Чтобы вставить каталог в архив, установите значение столбца "data" в NULL. Например, чтобы добавить каталог "dir1" и файл "m.txt" содержащий текст "abcdefghi" в архив zip "test.zip":

INSERT INTO temp.zip(name, data) VALUES('dir1', NULL);           -- Add directory 
INSERT INTO temp.zip(name, data) VALUES('m.txt', 'abcdefghi');   -- Add regular file 

Когда вставляется каталог, если значение "name" не заканчивается символом '/', модуль zipfile добавляет его. Это необходимо для совместимости с другими программами (в первую очередь "info-zip"), которые работают с архивами zip.

Чтобы вставить символическую ссылку, пользователь также должен указать значение "mode". Например, чтобы добавить символическую ссылку от "link.txt" к "m.txt":

INSERT INTO temp.zip(name, mode, data) VALUES('link.txt', 'lrwxrw-rw-', 'm.txt');

Следующие правила и замечания применяются к значениям, указанным в качестве части каждого оператора INSERT:

Указание явного значения для поля rowid в операторе INSERT не поддерживается. Любое предоставленное значение игнорируется.

3.2.2. Удаление записей из архива ZIP

Записи могут быть удалены из существующего архива zip путем удаления соответствующих строк. Например, чтобы удалить файл "m.txt" из архива zip "test.zip" с использованием созданной выше виртуальной таблицы:

DELETE FROM temp.zip WHERE name = 'm.txt';

Обратите внимание, что удаление записей из архива zip не освобождает место, используемое в архиве — это просто удаляет запись из "структуры центрального каталога" архива, делая запись недоступной. Один из способов обойти эту неэффективность — создать новый архив zip на основе содержимого измененного архива. Например, после редактирования архива, доступного через виртуальную таблицу temp.zzz:

-- Create a new, empty, archive: 
CREATE VIRTUAL TABLE temp.newzip USING zipfile('new.zip');

-- Copy the contents of the existing archive into the new archive
INSERT INTO temp.newzip(name, mode, mtime, data, method)
    SELECT name, mode, mtime, data, method FROM temp.zzz;

3.2.3. Обновление существующих записей в архиве ZIP

Существующие записи в архиве zip могут быть изменены с помощью операторов UPDATE.

Три столбца слева, "name", "mode" и "mtime", могут быть установлены на любое значение, которое может быть вставлено в тот же столбец (см. выше). Если "mode" или "mtime" установлены в NULL, конечное значение определяется, как описано для вставки значения NULL — текущее время для "mtime" и либо 33188, либо 16877 для "mode", в зависимости от того, указывают ли значения, указанные для следующих четырех столбцов таблицы zipfile, что запись является каталогом или файлом.

Попытка установить поля sz или rawdata на любое значение, кроме NULL, является ошибкой.

Столбцы data и method также могут быть установлены, как описано выше для вставки.

3.3. Функция агрегирования zipfile()

Новые архивы zip могут быть полностью построены в памяти с помощью функции агрегирования zipfile(). Каждый посещаемый строкой функцией агрегирования добавляет запись в архив zip. Возвращаемое значение — это блок данных, содержащий весь образ архива.

Функция агрегирования zipfile() может быть вызвана с 2, 4 или 5 аргументами. Если она вызвана с 5 аргументами, то запись, добавляемая в архив, эквивалентна вставке тех же значений в столбцы "name", "mode", "mtime", "data" и "method" виртуальной таблицы zipfile.

Если zipfile() вызывается с 2 аргументами, то добавляемая в архив запись эквивалентна записи, добавляемой при вставке тех же двух значений в столбцы "name" и "data" виртуальной таблицы zipfile, а все остальные значения устанавливаются в NULL. Если вызывается с 4 аргументами, она эквивалентна вставке 4 значений в столбцы "name", "mode", "mtime" и "data". Другими словами, следующие пары запросов эквивалентны:

SELECT zipfile(name, data) ...
SELECT zipfile(name, NULL, NULL, data, NULL) ...

SELECT zipfile(name, mode, mtime, data) ...
SELECT zipfile(name, mode, mtime, data, NULL) ...

Например, чтобы создать архив, содержащий два текстовых файла "a.txt" и "b.txt", содержащие текст "abc" и "123" соответственно:

WITH contents(name, data) AS (
  VALUES('a.txt', 'abc') UNION ALL
  VALUES('b.txt', '123')
)
SELECT zipfile(name, data) FROM contents;

Эта страница была в последний раз изменена 07.06.2023 13:17:51 UTC