NAME¶

calibredb - calibredb

calibredb command [options] [arguments]

calibredb 是 Calibre 数据库的命令行接口。它包含多个子命令（详见下文说明）。

calibredb 可用于操作指定的本地库路径，也可操作运行在本机或互联网上的 Calibre“内容服务器”。您可以使用 calibre-server 程序启动服务器，或者在 Calibre 主界面点击“连接/共享 -> 启动内容服务器”。由于 calibredb 具有修改书库的权限，您必须先在服务器上配置身份验证。有两种实现方式：

若要连接到正在运行的内容服务器，请将服务器的 URL 传递给 --with-library 选项，具体细节和示例请参阅该选项的说明文档。

全局选项¶

LIST¶

calibredb list [options]

列出 calibre 数据库中可用书籍。

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

ADD¶

calibredb add [选项] file1 file2 file3 ...

将指定文件当做书籍添加到数据库。你可以指定目录，请查看下面目录相关选项。

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

REMOVE¶

calibredb remove ids

从数据库删除指定id的书籍。id为以逗号分隔的 id 号列表（你可以使用搜索命令来获得 id 号）。例如，23,34,57-85（如果指定一个区间，该区间的最后一个数字不会被包括在内）。

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

ADD_FORMAT¶

calibredb add_format [options] id ebook_file

将 ebook_file中的电子书添加到由id标识的书籍的可用格式中。您可以使用搜索命令获取id。如果格式已经存在，则替换它，除非指定了不替换选项。

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

REMOVE_FORMAT¶

calibredb remove_format [options] id fmt

从ID标识的逻辑书籍中删除特定格式- fmt。你可以通过使用搜索命令获取id。fmt 应该是形如LRF或TXT或EPUB的一个文件扩展名。如果逻辑书籍没有 fmt 可用则什么也不做。

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

SHOW_METADATA¶

calibredb show_metadata [options] id

显示在 calibre 数据库中存储的指定id的书籍的元数据。 id是来自搜索命令的id号。

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

SET_METADATA¶

calibredb set_metadata [options] book_id [/path/to/metadata.opf]

根据 OPF 文件 --metadata.opf 设置存储在 calibre 数据库中的以 book_id 标识的书籍的元数据。 book_id 是来自搜索命令的 id 号。您可以通过使用 --as-opf 切换到 show_metadata 命令来快速 了解 OPF 格式。还可以用 --field 选项设置各个字段的元数据。如果使用 --field 选项则 不需要指定 OPF 文件。

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

EXPORT¶

calibredb export [options] ids

导出指定id(以逗号分隔的列表)的书籍至文件系统。 导出操作将保存书籍的所有格式，以及其封面和元数据(保存 至一个opf文件)。也会保存与书籍相关联的任何附加的数据文件。 你可以使用搜索命令来获得id。

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

CATALOG¶

calibredb catalog /path/to/destination.(csv|epub|mobi|xml...) [options]

以 path/to/destination extension 指定的格式导出书目。 选项控制项目在生成的书目中的显示方式。 请注意，不同的书目格式支持不同的选项。 要查看不同的选项，请指定输出文件的名称，然后指定 --help选项。

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

SAVED_SEARCHES¶

calibredb saved_searches [options] [list|add|remove]

Manage the saved searches stored in this database. If you try to add a query with a name that already exists, it will be replaced.

Syntax for listing, the default action:

calibredb saved_searches list

Syntax for adding:

calibredb saved_searches add search_name search_expression

Syntax for removing:

calibredb saved_searches remove search_name

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

ADD_CUSTOM_COLUMN¶

calibredb add_custom_column [options] label name datatype

创建一个自定义列，列名为你自定义的名称，不能包含空格或冒号。数据类型可为：bool, comments, composite, datetime, enumeration, float, int, rating, series, text

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

CUSTOM_COLUMNS¶

calibredb custom_columns [options]

列出可用的自定义列。显示栏目标签和id。

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

REMOVE_CUSTOM_COLUMN¶

calibredb remove_custom_column [options] label

删除由标签标识的自定义列。可以使用custom_columns command命令查看可用列。

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

SET_CUSTOM¶

calibredb set_custom [options] column id value

为 id 标识的书籍设置自定义列的值。 您可以使用搜索命令获取id列表。 您可以使用 custom_columns 命令获取自定义列名的列表。

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

RESTORE_DATABASE¶

calibredb restore_database [options]

Restore this database from the metadata stored in OPF files in each folder of the calibre library. This is useful if your metadata.db file has been corrupted.

WARNING: This command completely regenerates your database. You will lose all saved searches, user categories, plugboards, stored per-book conversion settings, and custom recipes. Restored metadata will only be as accurate as what is found in the OPF files.

The exit status is 0 if the restore succeeded, 1 if it failed completely and 2 if the database was restored but some books or other data could not be.

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

CHECK_LIBRARY¶

calibredb check_library [options]

对书库的文件系统执行一些检查。报告是invalid_titles, extra_titles, invalid_authors, extra_authors, missing_formats, extra_formats, extra_files, missing_covers, extra_covers, malformed_formats, malformed_paths, failed_folders

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

LIST_CATEGORIES¶

calibredb list_categories [options]

在数据库中生成一个类别信息的报告。 该信息与标签浏览器中显示的信息相同。

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

BACKUP_METADATA¶

calibredb backup_metadata [options]

将存储在数据库中的元数据备份到每个书籍文件夹中的 单个 OPF 文件中。这通常是自动的，但是您可以运行 此命令来强制重新生成 OPF 文件，并使用 --all 选项。

请注意，通常不需要这样做，因为每次元数据更改时， OPF 文件都会自动备份。

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

CLONE¶

calibredb clone path/to/new/library

创建当前书库的副本。这将创建一个新的、空的书库，它所有的自定义列、虚拟书库和其他设置与当前书库相同。

副本书库将没有任何书籍。如果您想要创建一个完整的副本书库，包括所有的书籍，那么只需使用您的文件系统工具来复制书库文件夹。

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

EMBED_METADATA¶

calibredb embed_metadata [options] book_id

通过calibre 数据库中的元数据更新存储在 calibre 书库中的实际书籍文件中的元数据。 通常，只有从 calibre 导出文件时才更新元数据，如果希望文件就地更新，则此命 令很有用。请注意，不同的文件格式支持不同数量的元数据。你可以使用book_id 的特殊值“all”来更新所有书籍中的元数据。还可以指定许多由空格分隔的书籍id 和由连字符分隔的ID区间。例如：calibredb embed_metadata 1 2 10-15 23

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

SEARCH¶

calibredb search [options] search expression

搜索书库中指定的搜索项，返回与搜索表达式匹配的以逗号分隔的书籍id列表。输出格式对于输入接受id列表的其他命令非常有用。 搜索表达式可以是来自calibre强大的搜索查询语言中的任何内容，例如：calibredb searchauthor:asimov 'title:"i robot"'

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

FTS_INDEX¶

calibredb fts_index [options] enable/disable/status/reindex

控制全文检索索引进程。

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

FTS_SEARCH¶

calibredb fts_search [options]  search expression

对整个书库或其子集进行全文检索。

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

NOTES¶

calibredb notes [options] [list|search|show|set|remove]

Manage the notes attached to items such as authors, series, tags and publishers. FIELD is the lookup name of the field, for example: authors, series, tags, publisher or #mycolumn. ITEM is the name of the item, for example the name of an author. Items are matched case insensitively.

List the items that have notes, optionally only those in the specified field. This is the default action:

calibredb notes list [FIELD]

Search the text of notes using the same SQLite full text search syntax as the Browse notes tool in calibre. Print the field, item name and an excerpt for each match. Use --field to search only the notes in a particular field:

calibredb notes search "search expression" calibredb notes search --field authors "search expression"

Print the note for an item as Markdown formatted text, or with --as-html as an HTML document with any images embedded, suitable for use with set:

calibredb notes show FIELD ITEM

Replace the note for an item with the contents of an HTML file. Use - to read the HTML from standard input. Images embedded as base64-encoded data: URLs are added to the note for both local and remote libraries. When using a local library and reading from a file, images referenced by paths relative to the file are added as well:

calibredb notes set FIELD ITEM FILE

Remove the note for an item:

calibredb notes remove FIELD ITEM

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

ITEMS¶

calibredb items [options] (rename|remove) FIELD ITEM ...

Rename or remove items such as authors, tags, series and publishers in all books, the same as the Manage authors, tags, etc. actions in the calibre interface. FIELD is the lookup name of the field, for example: authors, tags, series, publisher or #mycolumn. Items are matched case insensitively.

Rename an item. If an item named NEW_NAME already exists, the two items are merged. For fields that contain multiple values, NEW_NAME can contain more than one value, separated by the separator for the field, for example a comma for tags. The item is then replaced by all the values:

calibredb items rename FIELD ITEM NEW_NAME

Remove one or more items from all books. Authors cannot be removed:

calibredb items remove FIELD ITEM [ITEM ...]

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

VIRTUAL_LIBRARIES¶

calibredb virtual_libraries [options] [list|add|rename|remove]

Manage the Virtual libraries of this library. A Virtual library is a search that behaves as though the library contains only the books it matches. To list or search the books in a Virtual library, use: calibredb search 'vl:"name"'

List the Virtual libraries, with their searches and number of books. This is the default action:

calibredb virtual_libraries list

Create a Virtual library from a search:

calibredb virtual_libraries add name search_expression

Rename a Virtual library:

calibredb virtual_libraries rename name new_name

Remove Virtual libraries, the books in them are not changed:

calibredb virtual_libraries remove name ...

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

ANNOTATIONS¶

calibredb annotations [options] [list|search|export|import|remove]

Manage the annotations, that is the highlights and bookmarks, of books, as created in the calibre E-book viewer or synced from other applications.

List the annotations, with their ids. This is the default action:

calibredb annotations list

Search highlighted text, annotation notes and bookmark titles using the same SQLite full text search syntax as the Browse annotations tool. Results are ordered by relevance and include annotation ids, book titles and matching excerpts. Use --search to restrict the books, --type to restrict the annotation type, --user-type and --annotation-user to restrict the user, --no-stemming to match exact word forms, or --format json for a JSON array of results including the annotation data and excerpts:

calibredb annotations search "search expression"

Export the annotations as plain text, Markdown or JSON, grouped by book. The JSON is the same calibre annotation collection as created by the Export button in the Browse annotations tool:

calibredb annotations export

Import a calibre annotation collection exported as JSON by this command or the Browse annotations tool. The collection must contain annotations from only one book. BOOK_ID is the destination book id, not the id stored in the file. Only the annotations of the format FORMAT are imported, annotations of other formats are skipped. FORMAT must exist in the destination book. Use the same edition of the book so positions match:

calibredb annotations import BOOK_ID FORMAT FILE

Use - for FILE to read from standard input. The entire collection is validated before importing. Annotations are merged with existing ones using the viewer's rules: highlights are matched by UUID and bookmarks by title, and the newer timestamp wins. Repeated imports do not create duplicates. Unrelated annotations and reading positions are preserved.

By default annotations are imported into those of the calibre E-book viewer. Use --user-type web --annotation-user USER to import them into those of a Content server user instead. Exported collections record the user the annotations belong to, and if a collection contains annotations of more than one user, it is rejected. Use the --user-type and --annotation-user options when exporting, to export the annotations of a single user.

Permanently remove the annotations with the specified ids, as shown by list:

calibredb annotations remove ID ...

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

TRASH¶

calibredb trash [options] (list|restore|delete|empty) [ids]

Manage the books and formats that have been removed and placed in the trash bin. Entries in the trash bin are permanently deleted automatically after some days. ids is a comma separated list of book ids, as for the remove command, for example: 23,34,57-85 (when specifying a range, the last number in the range is not included).

List the removed books and formats, most recently removed first, with the times they were removed in local time. Removed formats of books that no longer exist are marked as not restorable, they can only be deleted. With --for-machine, the times are in UTC:

calibredb trash list

Restore removed books, or with --formats, the removed formats of books:

calibredb trash restore ids

Permanently delete entries from the trash bin:

calibredb trash delete ids

Permanently delete everything in the trash bin:

calibredb trash empty

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

DATA_FILES¶

calibredb data_files [options] (list|add|get|rename|remove) BOOK_ID ...

Manage the extra data files associated with a book, in local or remote libraries. Names are relative to the book's data directory. Use / for subdirectories, is also accepted. Files whose names contain a are listed, but cannot otherwise be managed. E-book formats, covers and metadata.opf cannot be accessed with this command. Remote libraries require an account with write access, as for other management commands, and do not support accounts with per-library search restrictions.

List file names, sizes in bytes and modification times (seconds since the Unix epoch). Use --for-machine for JSON output:

calibredb data_files list BOOK_ID

Add a file, using its basename, or --name to specify a name or subdirectory. Existing files are not replaced unless --replace is specified. This is also available through add_format --as-extra-data-file:

calibredb data_files add BOOK_ID FILE

Save one data file to --output on the local machine. Existing output files are not replaced unless --replace is specified:

calibredb data_files get BOOK_ID NAME --output FILE

Rename a file. Existing destinations are not replaced unless --replace is set:

calibredb data_files rename BOOK_ID NAME NEW_NAME

Remove a file to the operating system's recycle bin. With --permanent, delete it permanently instead. For remote libraries this happens on the server:

calibredb data_files remove BOOK_ID NAME

Directories left empty by rename and remove are deleted. With remote libraries, each file is transferred in a single request, so very large files need enough memory on both the client and the server, and uploads are limited by the maximum request size of the server.

每当您将包含空格的参数传递给%p程序时，请将参数放在引号中。例如: "/some path/with spaces"

Author¶

Kovid Goyal

Copyright¶

Kovid Goyal