`calibredb`¶

calibredb команда [параметри] [аргументи]

calibredb — інтерфейс командного рядка до бази даних calibre. Передбачено декілька допоміжних команд, які документовано нижче.

calibredb можна скористатися для керування або базою даних calibre, вказаної шляхом, або Сервером даних calibre, запущеного або на локальному комп’ютері, або в інтернеті. Запустити Сервер даних calibre можна або за допомогою команди calibre-server, або з головного вікна програми calibre вибором пункту З’єднатись/Роздати → Запустити сервер даних. Оскільки calibredb може вносити зміни до ваших бібліотек calibre, вам слід спочатку налаштувати розпізнавання на сервері. Це можна зробити у два способи:

Якщо ви плануєте з’єднуватися лише з сервером, який запущено на тому самому комп’ютері, ви можете просто скористатися параметром --enable-local-write сервера даних, щоб уможливити для будь-якої програми, зокрема calibredb, запущеної на локальному комп’ютері, внесення змін до ваших даних calibre. Якщо ви запускаєте сервер із головного вікна програми calibre, цей пункт можна знайти у розділі Налаштування → Обмін мережею → Додатково. Втім, вам слід бути обережними, оскільки у деяких браузерах, в основному у Firefox, передбачено можливість для довільних сайтів мати доступ до локальних серверів. Якщо ви використовуєте Firefox, варто налаштувати ім’я користувача і пароль, як це описано нижче. Обмеження локальних адрес усе ще не було реалізовано на час появи Firefox 149.

Якщо ви хочете увімкнути доступ інтернетом, вам слід налаштувати облікові записи користувачів на сервері і скористатися параметрами --username і --password програми calibredb для надання їй доступу. Ви можете налаштувати розпізнавання для calibre-server за допомогою параметра --enable-auth і скористатися параметром --manage-users для створення облікових записів користувачів. Якщо ви працюєте із сервером з головного вікна програми calibre, скористайтеся пунктом, Налаштування → Обмін мережею → Вимагати введення імені користувача і пароля.

Для встановлення з’єднання із запущеним сервером даних, передайте адресу сервера у параметрі --with-library. Див. документацію до цього параметра, щоб дізнатися більше і ознайомитися із прикладами.

ЗАГАЛЬНІ ПАРАМЕТРИ ¶

--help, -h¶: показати це довідкове повідомлення і завершити роботу

--library-path, --with-library¶: Шлях до бібліотеки calibre. Типово, використовується шлях, який збережено у параметрах роботи програми. В також можете встановити з’єднання із сервером даних calibre для виконання дій із віддаленими бібліотеками. Для цього скористайтеся адресою у такому форматі: http://hostname:port/#library_id, наприклад, http://localhost:8080/#mylibrary. Ідентифікатором бібліотеки є ідентифікатор бібліотеки на сервері даних. Ви можете скористатися спеціальним значенням параметра ідентифікатор_бібліотеки, «-», щоб отримати список ідентифікаторів бібліотек на сервері. Докладний опис налаштовування доступу за допомогою сервера даних можна знайти у розділі https://manual.calibre-ebook.com/uk/generated/uk/calibredb.html.

--password¶: Пароль для встановлення з’єднання із сервером даних calibre. Щоб пароль було прочитано із стандартного джерела введення, скористайтеся спеціальним значеннямв: <stdin>. Щоб пароль було прочитано з файла, скористайтеся такою конструкцією: <f:/path/to/file> (тобто <f: шлях до файла повністю і завершальний >). Символи «менше» і «більше» є обов'язковими. Не забудьте про їхнє екранування та лапки, якщо використовуєте їх у командній оболонці.

--timeout¶: Час очікування, у секундах, на встановлення з'єднання мережею із бібліотекою calibre. Типовим є час у дві хвилини.

--username¶: Ім’я користувача для встановлення з’єднання із сервером даних calibre

--version¶: показати дані щодо версії програми і завершити роботу

list ¶

calibredb list [параметри]

Показати список книг у базі даних calibre.

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--ascending¶: Впорядкувати дані за зростанням

--fields, -f¶: Поля, які слід показувати у списку книг бази даних. Поля у списку слід відокремлювати комами. Можливі поля: author_sort, authors, comments, cover, formats, identifiers, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, size, tags, template, timestamp, title, uuid Типовий список: title,authors. Особливим значенням «all» можна скористатися для вибору всіх полів. Крім вбудованих полів, назви яких наведено вище, можна скористатися нетиповими полями, доступ до яких здійснюється у форматі *назва_поля, наприклад, для нетипового поля #rating, слід скористатися назвою *rating

--for-machine¶: Вивести дані у форматі JSON, який є придатнішим для обробки комп’ютером. Призводить до ігнорування параметрів ширини рядків та роздільників.

--limit¶: Максимальна кількість показаних результатів. Типове значення: всі результати.

--line-width, -w¶: Максимальна ширина окремого рядка виведених даних. Типове значення визначається на основі розмірів екрана.

--prefix¶: Префікс всіх шляхів до файлів. Типовим є абсолютний шлях до теки бібліотеки.

--search, -s¶: Фільтрувати результати за запитом щодо пошуку. Настанови щодо форматування запитів для пошуку наведено у підручнику користувача. Типово не виконується жодного фільтрування.

--separator¶: Рядок, який відокремлюватиме поля. Типовим є пробіл.

--sort-by¶: Поле, з яким буде впорядковано результати. Ви можете вказати деілька полів, відокремивши їх комами. Доступні поля: author_sort, authors, comments, cover, formats, identifiers, isbn, languages, last_modified, pubdate, publisher, rating, series, series_index, size, tags, template, timestamp, title, uuid Типове значення: id. Крім вбудованих полів, назви яких наведено вище, можна скористатися нетиповими полями, доступ до яких здійснюється у форматі *назва_поля, наприклад, для нетипового поля #rating, слід скористатися назвою *rating

--template¶: Шаблон, який слід запустити, якщо у списку полів є «template». Зауважте, що шаблони буде проігноровано при з'єднанні із сервером calibre. Типове значення: немає

--template_file, -t¶: Шлях до файла, що містить шаблон, який слід запустити, якщо у списку полів є «template». Типове значення: немає

--template_heading¶: Заголовок стовпчика шаблонів. Типове значення: template. Цей параметр буде проігноровано, якщо встановлено параметр --for-machine

add ¶

calibredb add [параметри] файл1 файл2 файл3 ...

Додати вказані файли як книги до бази даних. Ви також можете вказати теки. Докладніший опис параметрів, пов’язаних з теками, наведено нижче.

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--authors, -a¶: Встановити авторів для доданих книг

--automerge, -m¶: Якщо буде виявлено книги із однаковими назвами і авторами, об'єднати вхідні формати (файли) автоматично із наявними записами книг. Значення «ignore» означає, що дублікати форматів буде відкинуто. Значення «overwrite» означає, що дублікати форматів у бібліотеці буде перезаписано новими доданими файлами. Значення «new_record» означає, що дублікати форматів буде записано до нового запису книги.

--cover, -c¶: Шлях до зображення обкладинки, яке слід використати для доданої книги

--duplicates, -d¶: Додати записи книг до бази даних, навіть якщо такі записи у цій базі вже створено. Порівняння виконуватиметься за назвами або авторами книг. Зауважте, що пріоритет буде надано параметру --automerge.

--empty, -e¶: Додати порожню книгу (книгу без формату)

--identifier, -I¶: Встановити ідентифікатори для цієї книги, наприклад -I asin:XXX -I isbn:YYY

--isbn, -i¶: Встановити ISBN для доданих книг

--languages, -l¶: Список мов, відокремлених комами (варто користуватися кодами мов ISO639, втім, передбачено розпізнавання і деяких повних назв мов)

--series, -s¶: Встановити цикл для доданих книг

--series-index, -S¶: Встановити номер у циклі для доданих книг

--tags, -T¶: Встановити мітки для доданих книг

--title, -t¶: Встановити заголовки для доданих книг

ДОДАВАННЯ З ТЕК ¶

Параметри, які керують додаванням книг з тек. Типово, програма додаватиме лише файли книг, суфікси назв яких є відомими як суфікси назв файлів електронних книг.

--add¶: Взірець (загальний) назви файла. Файли, назви яких відповідатимуть взірцеві буде додано під час пошуку файлів у теках, навіть якщо суфікс назви не належить до відомого програмі набору суфіксів назв файлів електронних книг. Можна вказати декілька взірців.

--ignore¶: Взірець (загальний) назви файла. Файли, назви яких відповідатимуть взірцеві буде проігноровано під час пошуку файлів у теках. Можна вказати декілька взірців. Якщо, наприклад, вказати взірець *.pdf, буде проігноровано усі файли PDF.

--one-book-per-directory, -1¶: Припускати, що у кожній теці міститься лише одна книга, всі файли у цьому каталозі є цією книгою, записаною у різних форматах

--recurse, -r¶: Обробляти теки рекурсивно

remove ¶

calibredb remove ідентифікатори

Вилучити книги, визначені ідентифікаторами з бази даних. Ідентифікатори у списку слід відокремлювати комами. Отримати номери ідентифікаторів можна за допомогою команди search. Приклад: 23,34,57-85 (у діапазон ідентифікаторів не включатиметься запис діапазону, у нашому прикладі 85).

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--permanent¶: Не використовувати теку смітника

add_format ¶

calibredb add_format [параметри] ідентифікатор файл_книги

Додати книгу з файла файл_книги до доступних форматів для логічної книги, визначеної ідентифікатором. Ідентифікатор може бути визначено за допомогою команди search. Якщо запис формату вже існує, його буде замінено, якщо не вказано параметр вимикання такої заміни.

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--as-extra-data-file¶: Додати файл як додатковий файл даних, а не формат книги

--dont-replace¶: Не замінювати формат, якщо файл у цьому форматі вже існує

remove_format ¶

calibredb remove_format [параметри] ідентифікатор формат

Вилучити формат з запису логічної книги, визначеної ідентифікатором. Визначити ідентифікатор можна за допомогою команди search. Формат має бути визначено суфіксом назви файла, наприклад LRF, TXT або EPUB. Якщо у записі логічної книги не міститиметься запису формату, ніяких дій не буде виконано.

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

show_metadata ¶

calibredb show_metadata [параметри] ідентифікатор

Показати метадані, що зберігаються у базі даних calibre для книги з ідентифікатором «ідентифікатор». «ідентифікатор» є ідентифікатором, який повертає команда search.

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--as-opf¶: Вивести метадані у форматі OPF (XML)

set_metadata ¶

calibredb set_metadata [параметри] ідентифікатор_книги [/шлях/до/метадані.opf]

Встановити у базі метаданих calibre для книги, вказаної за ідентифікатором, метадані з файла OPF метадані.opf. ідентифікатором має бути значення зі списку, який надається командою search. Коротку довідку щодо формату OPF можна отримати за допомогою ключа –as-opf, доданого до команди show_metadata. Крім того, можна встановлювати метадані для окремих полів за допомогою параметра –field. Якщо використовується параметр –field, вказувати файл OPF не потрібно.

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--field, -f¶: Поле, значення якого слід встановити. Формат визначення поля такий: назва_поля:значення. Приклад: --field tags:tag1,tag2. Скористайтеся --list-fields, щоб отримати список всіх назв полів. Цей параметр можна використовувати декілька разів з метою встановлення значень для декількох полів. Зауваження: для полів мов слід використовувати коди мов ISO639 (наприклад en для англійської, uk для української тощо). Синтаксис ідентифікаторів: --field identifiers:isbn:XXXX,doi:YYYYY. Для булевих полів (полів «так/ ні») слід використовувати значення true та false або yes та no.

--list-fields, -l¶: Показати список назв полів метаданих, які може бути використано з параметром --field

export ¶

calibredb export [параметри] ідентифікатори

Експортувати книги, вказані за допомогою ідентифікаторів (розділених у списку комами) до файлової системи. Під час дії з експортування зберігаються всі формати книги, зображення обкладинки книги і метадані (у форматі файла OPF). Також буде збережено усі файли додаткових даних, які пов’язано із книгою. Визначити номери ідентифікаторів можна за допомогою команди search.

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--all¶: Експортувати всі книги у бібліотеці з ігноруванням списку ідентифікаторів.

--dont-asciiize¶: Наказати calibre перетворити усі символи у назвах файлів, яких немає у англійській абетці, на символи англійської абетки. Це корисно для зберігання даних у застарілих файлових системах без повної підтримки назв файлів у форматі Unicode. Визначення цього перемикача вимкне вказану поведінку.

--dont-save-cover¶: Зазвичай calibre зберігатиме зображення обкладинки у окремому файлі разом з файлами електронної книги. Визначення цього перемикача вимкне вказану поведінку.

--dont-save-extra-files¶: Зберегти усі файли даних, які пов'язано із книгою, при зберігання книги Визначення цього перемикача вимкне вказану поведінку.

--dont-update-metadata¶: Зазвичай calibre оновлює метадані у збережених файлах на основі даних бібліотеки calibre. Уповільнює запис на диск. Визначення цього перемикача вимкне вказану поведінку.

--dont-write-opf¶: Зазвичай calibre записуватиме метадані до окремого файла OPF разом з файлами електронної книги. Визначення цього перемикача вимкне вказану поведінку.

--formats¶: Відокремлений комами список форматів, у яких слід зберігати кожну книгу. Типово книга зберігатиметься у всіх форматах.

--progress¶: Сповіщати про поступ

--replace-whitespace¶: Замінити пробіли підкреслюваннями.

--single-dir¶: Експортувати всі книги до однієї теки

--template¶: Шаблон для керування назвами файлів та структурою тек збережених файлів. Типовим є шаблон «{author_sort}/{title}/{title} - {authors}», у разі використання якого книги буде збережено до окремих підтек за авторами, назви файлів міститимуть назви книг і імена авторів. Доступні можливості керування: {author_sort, authors, id, isbn, languages, last_modified, pages, pubdate, publisher, rating, series, series_index, tags, timestamp, title}

--timefmt¶: Формат, у якому слід показувати дати. %d — день, %b — місяць, %m — номер місяця, %Y — рік. Типовим форматом є %b, %Y

--to-dir¶: Експортувати книги до вказаної теки. Типовою текою є .

--to-lowercase¶: Перетворити символи шляхів на нижній регістр.

catalog ¶

calibredb catalog /шлях/до/призначення.(csv|epub|mobi|xml...) [параметри]

Експортувати каталог у форматі, вказаної параметром «шлях/до/призначення.суфікс_назви». Параметри керують способом показу у виведених даних каталогу. Зауважте, що у різних форматах каталогів передбачено підтримку різних наборів параметрів. Щоб переглянути варіанти, вкажіть назву файла результатів, а потім параметр –help.

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--ids, -i¶: Список значень ідентифікаторів бази даних, відокремлених комами, для каталогізації. Якщо визначено, --search буде проігноровано. Типове значення: всі значення (all)

--search, -s¶: Фільтрувати результати за запитом щодо пошуку. Настанови щодо форматування запитів для пошуку наведено у підручнику користувача. Типово не виконується жодного фільтрування

--verbose, -v¶: Показувати докладні виведені дані. Корисно для діагностики.

ПАРАМЕТРИ EPUB ¶

--catalog-title¶: Заголовок створеного каталогу, використаний як заголовок у метаданих. Типове значення: «My Books» Застосування: формати виведення AZW3, EPUB, MOBI

--cross-reference-authors¶: Створювати перехресні посилання у розділі авторів для книг з декількома авторами. Типове значення: «False» Застосовується до таких форматів виведення даних: AZW3, EPUB, MOBI

--debug-pipeline¶: Зберігати виведені дані на різних кроків у вказаній теці. Корисно, якщо ви не впевнені, на якому кроці сталася помилка. Типове значення: «None» Застосування: формати виведення AZW3, EPUB, MOBI

--exclude-genre¶: Формальний вираз, що описує мітки для виключення жанрів. Типове значення: «[.+]|^+$» виключає мітки у квадратних дужках, наприклад «[Project Gutenberg]», та «+», типову мітку прочитаних книг. Застосування: формати виведення AZW3, EPUB, MOBI

--exclusion-rules¶: Визначає правила виключення книг зі створеного каталогу. Модель правила виключення записується у форматі ('<назва правила>','Tags','<список міток, відокремлених комами>') або ('<назва правила>','<нетиповий стовпчик>','<шаблон>'). Приклад: (('Архівовані книги','#status','Archived'),) виключить книги зі значенням «Archived» у нетиповому стовпчику «status». Якщо визначено декілька правил, буде застосовано всі з них. Типове значення: (('Архівовані книги','#status','Archived'),) виключить книги зі значенням «Archived» у нетиповому стовпчику «status». Якщо визначено декілька правил, буде застосовано всі з них. Типове значення: "(('Catalogs','Tags','Catalog'),)" Застосовується до форматів результатів AZW3, EPUB, MOBI

--generate-authors¶: Включення розділу «Автори» до каталогу. Типове значення: «False» Застосування: формати виведення AZW3, EPUB, MOBI

--generate-descriptions¶: Включення розділу «Описи» до каталогу. Типове значення: «False» Застосування: формати виведення AZW3, EPUB, MOBI

--generate-genres¶: Включення розділу «Жанри» до каталогу. Типове значення: «False» Застосування: формати виведення AZW3, EPUB, MOBI

--generate-recently-added¶: Включення розділу «Нещодавно додані» до каталогу. Типове значення: «False» Застосування: формати виведення AZW3, EPUB, MOBI

--generate-series¶: Включення розділу «Цикли» до каталогу. Типове значення: «False» Застосування: формати виведення AZW3, EPUB, MOBI

--generate-titles¶: Включення розділу «Заголовки» до каталогу. Типове значення: «False» Застосування: формати виведення AZW3, EPUB, MOBI

--genre-source-field¶: Поле джерела даних для розділу жанру. Типове значення: «Теґи» Стосується таких форматів виведення даних: AZW3, EPUB, MOBI

--header-note-source-field¶: Нетипове поле, що містить текст нотатки для додавання до заголовка опису. Типове значення: «» Застосування: формати виведення AZW3, EPUB, MOBI

--merge-comments-rule¶: #<нетипове поле>:[before|after]:[True|False] визначає: <нетипове поле> — нетипове поле, що містить нотатки, які має бути додано до коментарів [before|after] — розташування нотаток відносно коментарів [True|False] — визначає чи слід додавати горизонтальну лінію між нотатками і коментарями Типове значення: «::» Застосування: формати виведення AZW3, EPUB, MOBI

--output-profile¶: Визначає профіль виведення даних. Іноді профіль виведення даних потрібен для оптимізації каталогу для пристрою. Наприклад, профілі «kindle» і «kindle_dx» створюють структурований зміст з розділами і статтями. Типове значення: «None» Формати: формати виведення AZW3, EPUB, MOBI

--prefix-rules¶: Визначає правила, використані для включення префіксів, що позначають прочитані книги, пункти списку бажаних книг та інші визначені користувачами префікси. Модель правила префіксів є такою: ('<назва правила>','<поле джерела>','<шаблон>','<префікс>'). Якщо буде визначено декілька правил, застосовуватиметься лише перше відповідне з них. Типове значення: "(('Read books','tags','+','✓'),('Wishlist item','tags','Wishlist','×'))" Застосовується до форматів результатів AZW3, EPUB, MOBI

--preset¶: Використовувати вказаний за назвою шаблон, створений за допомогою графічних інструментів збирання каталогу. У такому шаблоні визначено всі параметри збирання каталогу. Типове значення: 'None' Застосування: формати виведення результатів AZW3, EPUB, MOBI.

--thumb-width¶: Основний розмір (у дюймах) для зображень обкладинок у каталозі. Діапазон: 1.0 — 2.0 Типове значення: «1.0» Застосування: формати виведення AZW3, EPUB, MOBI

--use-existing-cover¶: Замінювати зображення обкладинок під час створення каталогу. Типове значення: «False» Застосування: формати виведення AZW3, EPUB, MOBI

saved_searches ¶

calibredb saved_searches [параметри] (list|add|remove)

Керування збереженими записами пошуків, що зберігаються у цій базі даних. Якщо ви спробуєте додати запит з назвою, яку вже записано до бази даних, попередній запис буде замінено новим.

Синтаксис для виведення списку, типової дії:

%p saved_searches list

Синтаксис для додавання:

calibredb saved_searches add назва_пошуку вираз_пошуку

Синтаксис для вилучення:

calibredb saved_searches remove назва_пошуку

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

add_custom_column ¶

calibredb add_custom_column [параметри] мітка назва тип_даних

Створити нетиповий стовпчик. «мітка» — комп’ютерна назва стовпчика. Мітка не повинна містити пробілів і двокрапок. «назва» — зручна для читання назва стовпчика. «тип_даних» має бути одним з таких значень: bool, comments, composite, datetime, enumeration, float, int, rating, series, text

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--display¶: Набір параметрів для налаштовування обробки даних у цьому стовпчику. Має бути рядком JSON. Для стовпчиків нумерації скористайтеся --display"{\ "enum_values\ ":[\ "значення1\ ", \ "значення2\ "]}" Передбачено багато варіантів передавання значень показаній змінній. Серед варіантів за типами стовпчиків: мішаний тип: composite_template, composite_sort, make_category,contains_html, use_decorations дата і час: date_format нумерація: enum_values, enum_colors, use_decorations ціле, десятковий дріб: number_format текст: is_names, use_decorations Найкращим способом визначення відповідних комбінацій є створення нетипового стовпчика відповідного типу за допомогою графічного інтерфейсу з наступним вивченням резервної копії OPF книги (переконайтеся, що новий OPF було створено після додавання стовпчика). У такому OPF можна знайти JSON для показу ("display") нового стовпчика.

--is-multiple¶: У цьому стовпчику зберігаються дані, подібні до міток (тобто значення, відокремлені комами). Застосовується, лише якщо типом даних є «text».

custom_columns ¶

calibredb custom_columns [параметри]

Показати доступні нетипові стовпчики. Виводить мітки та ідентифікатори стовпчиків.

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--details, -d¶: Показати параметри кожного стовпчика.

remove_custom_column ¶

calibredb remove_custom_column [параметри] мітка

Вилучити нетиповий стовпчик, визначений міткою. Переглянути список доступних стовпчиків можна за допомогою команди custom_columns.

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--force, -f¶: Не питати про підтвердження

set_custom ¶

calibredb set_custom [параметри] стовпчик ідентифікатор значення

Встановити значення у нетиповому стовпчику для книги, визначеної ідентифікатором. Список ідентифікаторів можна отримати за допомогою команди search. Отримати список назв нетипових стовпчиків можна отримати за допомогою

команди custom_columns.

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--append, -a¶: Якщо у стовпчику зберігається декілька значень, дописати вказані значення до вже записаних замість заміни цих значень.

restore_database ¶

calibredb restore_database [параметри]

Відновити цю базу даних на основі метаданих, що зберігаються у файлах OPF кожної з тек бібліотеки calibre. Корисно, якщо ваш файл metadata.db пошкоджено.

ПОПЕРЕДЖЕННЯ: у результаті виконання цієї команди вашу базу даних буде створено з нуля. Ви втратите всі збережені дані пошуку, категорії користувача, засоби обробки, збережені параметри перетворення окремих книг та нетипові рецепти. Відновлені метадані будуть настільки точними, наскільки точними є дані, збережені у файлах OPF.

Код завершення дорівнює 0, якщо відновлення виконано успішно; 1, якщо воно повністю не вдалося; і 2, якщо базу даних було відновлено, але деякі книги чи інші дані відновити не вдалося.

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--really-do-it, -r¶: Виконати відновлення. Команду не буде виконано, якщо не буде вказано цього параметра.

check_library ¶

calibredb бібліотека_для_перевірки [параметри]

Виконати деякі перевірки у файловій системі бібліотеки. Звіти буде invalid_titles, extra_titles, invalid_authors, extra_authors, missing_formats, extra_formats, extra_files, missing_covers, extra_covers, malformed_formats, malformed_paths, failed_folders

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--csv, -c¶: Виведення у форматі CSV

--ignore_extensions, -e¶: Список суфіксів назв, які слід ігнорувати, відокремлений комами. Типове значення: всі (all)

--ignore_names, -n¶: Список назв, які слід ігнорувати, відокремлений комами. Типове значення: всі (all)

--report, -r¶: Список звітів, відокремлених комами. Типове значення: всі (all)

--vacuum-fts-db¶: Очистити базу даних повнотекстового пошуку. Процедура може бути дуже повільною і вимогливою до пам'яті, залежно від розміру бази даних.

backup_metadata ¶

calibredb backup_metadata [параметри]

Створити резервну копію метаданих, що зберігаються у базі даних у окремих файла OPF у кожній з тек книг. Зазвичай, така дія виконується автоматично, але ви можете наказати програмі виконати примусове повторне створення файлів OPF, якщо вкажете параметр –all.

Зауважте, що зазвичай потреби у цій команді немає, оскільки резервні копії файлів OPF створюються автоматично у разі внесення змін до метаданих.

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--all¶: Зазвичай, ця програма обробляє лише ті книги, файли OPF яких застаріли. За допомогою цього параметра ви можете наказати програмі обробляти всі файли книг.

clone ¶

calibredb clone шлях/до/нової/бібліотеки

Створити клон поточної бібліотеки. За допомогою цієї програми можна створити нову порожню бібліотеку з тими самими нетиповими стовпчиками, віртуальними бібліотеками та іншими параметрами, що і у поточній бібліотеці.

У клонованій бібліотеці не буде жодної книги. Якщо вам потрібно створити дублікати бібліотеки з усіма книгами, просто скористайтеся інструментами для керування файлами і скопіюйте теку бібліотеки.

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

embed_metadata ¶

calibredb embed_metadata [параметри] ідентифікатор_книги

Оновити метадані файлів книги, що зберігаються у бібліотеці calibre на основі метаданих з бази даних calibre. Зазвичай, метадані оновлюються лише під час експортування файлів з calibre. Ця команда корисна, якщо ви хочете оновити файли на місці. Зауважте, що у файлах різних форматів передбачено зберігання різних наборів метаданих. Щоб оновити метадані у всіх книгах, скористайтеся спеціальним значенням ідентифікатора — «all». Крім того, можна вказати декілька ідентифікаторів книг, відокремивши їх пробілами, або діапазони ідентифікаторів з межами, відокремленими дефісами. Приклад: calibredb embed_metadata 1 2 10-15 23

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--only-formats, -f¶: Оновити метадані лише у файлах вказаного формату. Можна вказувати декілька таких параметрів, якщо потрібно обробити файли декількох форматів. Якщо параметр не вказано, програма оновлює усі формати.

search ¶

calibredb search [параметри] вираз для пошуку

Шукати у бібліотеці записи із вказаним ключем для пошуку. Повертає список ідентифікаторів відповідних книг, відокремлених комами. Формат виведення даних корисний для передавання іншим командам, які приймають вхідні дані у форматі списку ідентифікаторів.

Виразом для пошуку може бути будь-який запис потужною мовою запитів calibre. Приклад: calibredb search author:asimov „title:»i robot»“

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--limit, -l¶: Максимальна кількість повернутих результатів. Типово буде повернуто усі результати.

fts_index ¶

calibredb fts_index [параметри] enable/disable/status/reindex

Керування процедурою індексування для повнотекстового пошуку.

enable — увімкнути індексування для повнотекстового пошуку для цієїї бібліотеки disable — вимкнути індексування для повнотекстового пошуку для цієї бібліотеки status — показати поточний стан індексування reindex — можна скористатися для повторного індексування певних книг або

усієї бібліотеки. Щоб повторно індексувати якісь книги, вкажіть ідентифікатори книг як додаткові аргументи після команди reindex. Якщо ідентифікаторів книг не буде вказано, буде виконано повторне індексування усієї бібліотеки.

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--indexing-speed¶: Швидкість індексування. Скористайтеся швидким індексуванням з використанням усіх ресурсів комп'ютера або повільним, якщо слід заощаджувати ресурси на індексуванні. Зауважте, що програма скидатиме швидкість на повільну після кожного виклику.

--wait-for-completion¶: Очікувати на завершення індексування усіх книг, періодично показуючи дані щодо поступу індексуування

fts_search ¶

calibredb fts_search [параметри] вираз для пошуку

Виконати повнотекстовий пошук в усій бібліотеці або її підмножині.

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--do-not-match-on-related-words¶: Встановлювати відповідність лише за точним словом, а не за пов'язаними з ним словами. Таким чином, пошук «виправлення» не призводитиме до показу відповідника «виправити».

--include-snippets¶: Включати фрагменти тексту навколо кожного відповідника. Зауважте, що це значно уповільнить пошук.

--indexing-threshold¶: Частка бібліотеки у відсотках, яку має бути індексовано, перш ніж повнотекстовий пошук буде увімкнено. Типовим є значення 90.

--match-end-marker¶: Позначка, яку буде використано для кінця відповідного слова у фрагменті

--match-start-marker¶: Позначка, яку буде використано для початку відповідного слова у фрагменті

--output-format¶: Формат виведення результатів пошуку. Може мати значення «text» для звичайного тексту або «json» для виведення у форматі JSON.

--restrict-to¶: Обмежити перелік книг для пошуку за допомогою якогось виразу для пошуку або списку ідентифікаторів. Приклад: ids:1,2,3 — обмежити пошук вказаними ідентифікаторами, або search:tag:щось — обмежити пошук книгами із міткою «щось».

notes ¶

calibredb notes [параметри] [list|search|show|set|remove]

Керування нотатками, прив’язаними до таких елементів, як автори, серії, теги та видавці. ПОЛЕ — це назва поля (ідентифікатор), наприклад: authors, series, tags, publisher або #mycolumn. ЗАПИС — назва конкретного запису, наприклад, ім’я автора. Пошук записів здійснюється без урахування регістру символів.

Виведення списку елементів, що мають нотатки (за бажанням — лише для вказаного поля). Це типова дія:

calibredb notes list [ПОЛЕ]

Пошук у тексті нотаток із використанням того самого синтаксису повнотекстового пошуку SQLite, що і в інструменті «Навігація нотатками» у програмі calibre. Для кожного знайденого збігу буде виведено назву поля, назву запису та уривок тексту. Скористайтеся параметром –field для пошуку нотаток лише в певному полі:

calibredb notes search «вираз для пошуку» calibredb notes search –field authors «вираз для пошуку»

Виведення нотатки для запису у форматі Markdown або (з параметром –as-html) у вигляді документа HTML з вбудованими зображеннями; цей формат працює з командою set:

calibredb notes show ПОЛЕ ЗАПИС

Заміна нотатки для запису вмістом файла HTML. Скористайтеся символом «-», щоб зчитати HTML зі стандартного джерела вхідних даних. Зображення вбудовуються як дані, закодовані в base64; для локальних і віддалених бібліотек до нотатки додаються відповідні URL-адреси. У разі використання локальної бібліотеки та зчитування з файла також додаються зображення, на які є посилання за відносними шляхами (відносно цього файла):

calibredb notes set ПОЛЕ ЗАПИС ФАЙЛ

Вилучення нотатки для запису:

calibredb notes remove ПОЛЕ ЗАПИС

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--as-html¶: При показі нотатки виводити її як HTML замість тексту у форматі Markdown

--field¶: При пошуку нотаток обмежити пошук цим полем, приклади: authors, tags і #mycolumn

items ¶

calibredb items [параметри] (rename|remove) ПОЛЕ ЗАПИС ...

Перейменування або вилучення таких елементів, як автори, мітки, цикли та видавці, в усіх книгах — аналогічно до дій «Керування авторами, мітками тощо» в інтерфейсі програми calibre. ПОЛЕ — це внутрішня назва поля, наприклад: authors, tags, series, publisher або #mycolumn. Пошук елементів здійснюється без урахування регістру.

Перейменування елемента. Якщо елемент із назвою НОВА_НАЗВА вже існує, відбувається об’єднання двох записів. Для полів, що містять кілька значень, НОВА_НАЗВА може включати кілька значень, розділених відповідним для цього поля роздільником (наприклад, відокремлення комою для міток). У такому разі запис буде замінено всіма вказаними значеннями:

calibredb items rename ПОЛЕ ЗАПИС НОВА_НАЗВА

Вилучення одного або кількох записів з усіх книг. Записи авторів вилучати не можна:

calibredb items remove ПОЛЕ ЗАПИС [ЗАПИС …]

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--search, -s¶: Вносити зміни лише до книг, які відповідають виразу для пошуку. Приклад: tags:"=Fiction"

virtual_libraries ¶

calibredb virtual_libraries [параметри] (list|add|rename|remove)

Керування віртуальними бібліотеками цієї бібліотеки. Віртуальна бібліотека є результатом пошуку, який містить лише ті книги, які відповідають певним критеріям пошуку. Щоб переглянути список віртуальної бібліотеки або виконати у ній пошук, скористайтеся такою командою: calibredb search „vl:»name»“

Вивести список віртуальних бібліотек з параметрами пошуку та кількістю книг у них, типова дія:

calibredb virtual_libraries list

Створити віртуальну бібліотеку на основі пошуку:

calibredb virtual_libraries add назва вираз_для_пошуку

Перейменувати віртуальну бібліотеку:

calibredb virtual_libraries rename назва нова_назва

Вилучити віртуальні бібліотеки без зміни книг у них:

calibredb virtual_libraries remove назва …

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--for-machine¶: Вивести результати списку у форматі JSON, який є зручнішими для комп'ютерної обробки

--replace¶: Замінити пошук наявної віртуальної бібліотеки з тією самою назвою при додаванні

annotations ¶

calibredb annotations [параметри] (list|search|export|import|remove)

Керування анотаціями (підсвічуваннями та закладками) у книгах — як створеними у програмі перегляду електронних книг calibre, так і синхронізованими з інших програм.

Виведення списку анотацій із зазначенням їхніх ідентифікаторів:

calibredb annotations list

Пошук у позначеному тексті, нотатках до анотацій та назвах закладок із використанням того самого синтаксису повнотекстового пошуку SQLite, що і в інструменті «Навігація анотаціями». Результати впорядковуються за релевантністю; вони містять ідентифікатори анотацій, назви книг і відповідні уривки тексту. Скористайтеся параметром –search для обмеження пошуку певними книгами, –type — для вибору типу анотацій, –user-type та –annotation-user — для фільтрування за користувачем, –no-stemming — для пошуку точних форм слів, або –format json — для отримання результатів у форматі масиву JSON (що включає дані анотацій та уривки тексту):

calibredb annotations search «пошуковий запит»

Експорт анотацій у форматі звичайного тексту, Markdown або JSON (з групуванням за книгами). Формат JSON відповідає структурі збірки анотацій calibre, яку можна створити за допомогою кнопки «Експортувати» в інструменті «Навігація анотаціями»:

calibredb annotations export

Імпорт збірки анотацій calibre, експортованої у форматі JSON за допомогою цієї команди або інструменту «Навігація анотаціями». Збірка має містити анотації лише до однієї книги. ІДЕНТИФІКАТОР_КНИГИ — це ідентифікатор цільової книги (а не той, що міститься у файлі). Буде імпортовано лише анотації вказаного формату (ФОРМАТ); анотації інших форматів буде проігноровано. Формат (ФОРМАТ) має існувати в цільовій книзі. Скористайтеся тією самою редакцією книги, щоб позиції збігалися:

calibredb annotations import ІДЕНТИФІКАТОР_КНИГИ ФОРМАТ ФАЙЛ

Якщо замість ФАЙЛ вказати «-», дані будуть зчитані зі стандартного вхідного потоку даних. Перед імпортом уся збірка проходить перевірку. Анотації буде об’єднано з наявними відповідно до правил програми перегляду: підсвічування зіставляються за UUID, а закладки — за назвою; у разі конфлікту перевага надається анотації з новішою міткою часу. Повторний імпорт не створює дублікатів. Анотації та позиції читання, що не стосуються імпортованих даних, залишаються без змін.

Типово анотації імпортуються до набору даних програми перегляду електронних книг calibre. Щоб імпортувати їх для користувача сервера даних, скористайтеся параметрами –user-type web –annotation-user КОРИСТУВАЧ. Експортовані колекції містять інформацію про те, якому користувачеві належать анотації; якщо ж збірка містить анотації кількох користувачів, її буде відхилено. Щоб експортувати анотації лише одного користувача, скористайтеся під час експортування параметрами –user-type та –annotation-user.

Остаточно вилучити анотації із зазначеними ідентифікаторами (як показано у списку):

calibredb annotations remove ІДЕНТИФІКАТОР …

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--annotation-user¶: Будувати список, шукати і експортувати анотації лише для вказаного типу користувача. Під час імпортування — користувач сервера даних, для якого імпортуються анотації, слід вказати, якщо використовується параметр :option:–user-type` web`. Зауважте, що це може бути будь-який користувач, а не лише той, що використовується для з'єднання з віддаленою бібліотекою.

--format, -f¶: Формат експортування, одне з таких значень: text, markdown, json. Для пошуку, текст або json. Типове значення: text

--no-stemming¶: Для пошуку, встановлювати відповідність лише цілим формам слів, а не їхнім основам

--search, -s¶: Вивести список, виконати пошук або експортувати анотації лише тих книг, які відповідають вказаному пошуковому запиту щодо книг, наприклад: --search "series:Фундація"

--type, -t¶: Вивести список, виконати пошук або експортувати анотації певного типу, одного з таких: highlight, bookmark

--user-type¶: Будувати список, шукати і експортувати анотації лише для вказаного типу користувача. У разі імпортування слід визначити тип користувача, для якого імпортуються анотації: користувач програми перегляду електронних книг calibre (локальний) або користувач сервера даних (веб). Типово для імпортування вибрано локального користувача.

trash ¶

calibredb trash [options] (list|restore|delete|empty) [ідентифікатори]

Керування книгами та форматами, які було вилучено і переміщено до смітника. Об’єкти у смітнику буде автоматично і остаточно вилучено за кілька днів. Параметр ідентифікатори — це список ідентифікаторів книг, відокремлених комами (аналогічно до команди remove), наприклад: `23,34,57-85 (якщо вказано діапазон, останнє число в ньому не буде враховано).

Показати список вилучених книг і форматів, найсвіжіші вилучені першими, з часом вилучення у місцевому часовому поясі. Вилучені формати книг, яких вже не існує буде позначено, як такі, що неможливо відновити, їх можна лише вилучити зі списку. З параметром –for-machine, час буде вказано за Грінвичем:

calibredb trash list

Відновити вилучені книги або, з –formats, вилучені формати книг:

calibredb trash restore ids

Остаточно вилучити записи з теки смітника:

calibredb trash delete ids

Остаточно вилучити усе у теці смітника:

calibredb trash empty

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--for-machine¶: Вивести результати дії з побудови списку у форматі JSON, який є зручнішими для комп'ютерної обробки

--formats¶: Працювати з вилученими форматами вказаних книг, а не з вилученими книгами

data_files ¶

calibredb data_files [параметри] (list|add|get|rename|remove) ІДЕНТИФІКАТОР_КНИГИ ...

Керування додатковими файлами даних, пов’язаними з книгою, у локальних або віддалених бібліотеках. Назви слід вказувати відносно каталогу даних книги. Для підкаталогів скористайтеся символом /; також можна використовувати . Файли, у назвах яких є символ , буде показано у списку, але інші дії з ними виконувати не можна. Ця команда не надає доступу до форматів електронних книг, обкладинок та файлів metadata.opf. Для роботи з віддаленими бібліотеками, як і у випадку з іншими командами керування, потрібен обліковий запис із правами на запис. ПІдтримки облікових записів з обмеженнями пошуку для окремих бібліотек не передбачено.

Виведення списку назв файлів, їхніх розмірів у байтах і часу останньої зміни (у секундах від початку епохи Unix). Для отримання результату у форматі JSON скористайтеся параметром –for-machine:

calibredb data_files list ІДЕНТИФІКАТОР_КНИГИ

Додавання файла. Скористайтеся його базовою назвою; за допомогою параметра –name можна вказати нетипову назву або підкаталог. Наявні файли не буде замінено, якщо не вказано параметр –replace. Цю дію також можна виконати за допомогою команди add_format з аргументом –as-extra-data-file:

calibredb data_files add ІДЕНТИФІКАТОР_КНИГИ ФАЙЛ

Збереження файла даних у вказаному місці (–output) на локальному комп’ютері. Наявні файли за вказаним шляхом не буде замінено, якщо не вказано параметр –replace:

calibredb data_files get ІДЕНТИФІКАТОР_КНИГИ НАЗВА –output FILE

Перейменування файла. Якщо файл з такою назвою вже існує, файл не буде замінено, доки не буде вказано параметр –replace:

calibredb data_files rename ІДЕНТИФІКАТОР_КНИГИ НАЗВА НОВА_НАЗВА

Вилучення файла (переміщення до системної теки смітника). Використання параметра –permanent призводить до остаточного вилучення. У випадку віддалених бібліотек ця дія виконується на сервері:

calibredb data_files remove ІДЕНТИФІКАТОР_КНИГИ НАЗВА

Каталоги, що залишилися порожніми після перейменування або вилучення файлів, також буде вилучено. При роботі з віддаленими бібліотеками кожен файл передається в межах одного запиту; тому для дуже великих файлів потрібен достатній обсяг пам’яті як на клієнті, так і на сервері, а розмір файлів, що завантажуються, обмежений максимально допустимим розміром запиту на сервері.

Якщо ви передаєте аргументи calibredb, які містять пробіли, додайте навколо таких аргументів лапки. Приклад: «/some path/with spaces»

--for-machine¶: Вивести список файлів у форматі JSON

--name¶: Назва, яку слід використати для доданого файла, відносно каталогу даних

--output¶: Локальне місце для дії get

--permanent¶: Остаточно вилучити файл даних замість пересування його до теки смітника

--replace¶: Дозволити заміну наявних файлів при додаванні, отриманні або перейменуванні

calibredb¶

`calibredb`¶