---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: pdf
excerpt: |
DuckDB Community Extensions
Read, OCR, inspect, transform, and write PDFs in SQL
# PDF 0.9.0: consolidated API for DuckDB 2.0.
extension:
name: pdf
description: Read, OCR, inspect, transform, and write PDFs in SQL
version: 0.9.0
language: C++
build: cmake
license: GPL-2.0-or-later
maintainers:
- asubbarao
# windows_amd64 (MSVC/vcpkg) builds and is supported. mingw/rtools use a
# different toolchain than the MSVC static linkage this extension relies on;
# windows_arm64 is untested; wasm cannot link Poppler/Tesseract.
excluded_platforms: wasm_mvp;wasm_eh;wasm_threads;windows_amd64_mingw;windows_amd64_rtools;windows_arm64
requires_toolchains: vcpkg
vcpkg_url: https://github.com/microsoft/vcpkg.git
vcpkg_commit: 84bab45d415d22042bd0b9081aea57f362da3f35
repo:
github: asubbarao/duckdb-pdf
ref: 82d7ae3d6aa7af6b1688544b7ca26edb616e46a3
docs:
hello_world: |
LOAD pdf;
-- One row per page (path or glob; parallel across pages/files)
SELECT filename, page, text
FROM read_pdf('reports/*.pdf')
WHERE contains(lower(text), 'revenue');
-- Metadata census
SELECT file, title, author, page_count FROM pdf_info('reports/*.pdf');
-- RAG chunks in one statement
CREATE TABLE chunks AS FROM read_pdf('reports/*.pdf', grain := 'chunk');
-- Page raster + native write
SELECT pdf_render('report.pdf', 1, {dpi: 150}) AS page_image;
COPY (SELECT file, page_count FROM pdf_info('reports/*.pdf'))
TO 'findings.pdf' (FORMAT pdf, TITLE 'Findings', FOOTER 'page {page}');
extended_description: |
**Everything PDF, in SQL** — Poppler, Tesseract (OCR), qpdf, and libharu,
statically linked. Paths or globs; no external tools at runtime for core
ops. Full docs and recipes:
[API reference](https://github.com/asubbarao/duckdb-pdf/blob/82d7ae3d6aa7af6b1688544b7ca26edb616e46a3/README.md) and
[cookbook](https://github.com/asubbarao/duckdb-pdf/blob/82d7ae3d6aa7af6b1688544b7ca26edb616e46a3/COOKBOOK.md).
**Breaking API update (0.9.0)** — 19 public names replace the earlier
separate entry points. Retired names are removed. See the
[migration table](https://github.com/asubbarao/duckdb-pdf/blob/82d7ae3d6aa7af6b1688544b7ca26edb616e46a3/README.md#migration-from-48-names).
This source targets DuckDB 2.0.0.
**Discover functions** — `duckdb_functions()` exposes parameter names,
descriptions and examples. Scalar options use validated STRUCT fields.
`pdf_render` and `ocr_image` each have scalar and table forms.
**Read** — `read_pdf` selects page, line, element, table or chunk grain;
`read_pdf_words` returns word boxes, geometric `line` and page size. Auto-OCR on
image-only pages for page/line/word/table readers; element/chunk OCR is
opt-in. English model bundled.
**Inspect** — `pdf_info` selects metadata/permissions or qpdf statistics;
`pdf_objects` selects pages, outline, tagged structure, destinations, fonts,
attachments, form fields, annotations, revisions, signatures or images.
**Convert / render** — `pdf_text` selects text, Markdown, HTML, XML or JSON;
`pdf_render` renders PNG/SVG as a scalar or streams pages as a table.
`ocr_image` has scalar and table forms, with text/hocr/tsv output.
**Transform & write** — `pdf_merge`, `pdf_pages`, `pdf_split`, `pdf_stamp`,
`pdf_rewrite`, `pdf_sign`, `pdf_redact`, `pdf_ocr`;
`write_pdf` / `COPY … (FORMAT pdf)`;
`to_pdf` for office docs (LibreOffice at runtime).
**Scope** — deterministic extraction, not ML document AI. **License** —
GPL-2.0-or-later (Poppler).
extension_star_count: 12
extension_star_count_pretty: 12
extension_download_count: 978
extension_download_count_pretty: 978
image: '/images/community_extensions/social_preview/preview_community_extension_pdf.png'
layout: community_extension_doc
---
### Compatibility Matrix
This table covers all DuckDB releases that have not reached [end-of-life](https://duckdb.org/release_calendar), including LTS releases, and shows the 2 most recent patch releases of each. Older patch releases are not listed, but the extension may be available for them as well.
| Platform | 1.4.4 | 1.4.5 | 1.5.5 | 1.5.6 | 2.0.0 |
| :--- | :---: | :---: | :---: | :---: | :---: |
| Linux AMD64 | ❌ | ❌ | ✅ | ✅ | ✅ |
| Linux ARM64 | ❌ | ❌ | ✅ | ✅ | ✅ |
| macOS AMD64 | ❌ | ❌ | ✅ | ✅ | ❌ |
| macOS ARM64 | ❌ | ❌ | ✅ | ✅ | ✅ |
| Windows AMD64 | ❌ | ❌ | ✅ | ✅ | ✅ |
| Windows ARM64 | ❌ | ❌ | ❌ | ❌ | ❌ |
| WebAssembly | ❌ | ❌ | ❌ | ❌ | ❌ |
### Installing and Loading
```sql
INSTALL {{ page.extension.name }} FROM community;
LOAD {{ page.extension.name }};
```
{% if page.docs.hello_world %}
### Example
```sql
{{ page.docs.hello_world }}```
{% endif %}
{% if page.docs.extended_description %}
### About {{ page.extension.name }}
{{ page.docs.extended_description }}
{% endif %}
### Added Functions
| function_name | function_type | description | comment | examples |
|--------------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|---------------------------------------------------------------------------------------------------------------------|
| ocr_image | scalar | Recognize an encoded image BLOB. Scalar returns text, HOCR or TSV and accepts an optional options STRUCT. Table returns text, confidence and format with named OCR settings. | NULL | [SELECT ocr_image(pdf_render('document.pdf', 1), {language: 'eng'});] |
| ocr_image | table | Recognize an encoded image BLOB. Scalar returns text, HOCR or TSV and accepts an optional options STRUCT. Table returns text, confidence and format with named OCR settings. | NULL | [SELECT text, confidence FROM ocr_image(pdf_render('document.pdf', 1));] |
| pdf_info | table | Inspect metadata, permissions and features (detail basic), or qpdf structural and encryption statistics (detail qpdf). Basic supports projection pushdown and ignore_errors. | NULL | [SELECT * FROM pdf_info('document.pdf', detail := 'basic');] |
| pdf_merge | scalar | Merge local input PDFs in list order and atomically publish the output. | NULL | [SELECT pdf_merge(['first.pdf', 'second.pdf'], 'merged.pdf');] |
| pdf_objects | table | Inspect typed PDF objects; kind is required: outline, structure, destinations, fonts, form_fields, annotations, attachments, images, signatures, revisions or pages. Each kind has its own schema. Signature verification checks integrity, not certificate trust. | NULL | [SELECT * FROM pdf_objects('document.pdf', kind := 'outline');] |
| pdf_ocr | table | Add searchable Tesseract layers to selected pages and return one status row per document page. Existing text pages are skipped unless force is true. Force adds another layer and can duplicate extracted text. | NULL | [SELECT * FROM pdf_ocr('document.pdf', 'searchable.pdf', force := false);] |
| pdf_pages | scalar | Extract/reorder local PDF pages using qpdf ranges; optional STRUCT rotate (multiple of 90) and rotate_pages select rotation after extraction, in output page coordinates. Default rotates all selected pages. | NULL | [SELECT pdf_pages('document.pdf', 'selected.pdf', '1-3', {rotate: 90});] |
| pdf_pages | scalar | Rotate a complete local PDF without extracting pages, preserving its catalog, metadata and bookmarks. STRUCT rotate is a multiple of 90; optional rotate_pages defaults to all and uses original document page numbers. | NULL | [SELECT pdf_pages('document.pdf', 'rotated.pdf', {rotate: 90});] |
| pdf_redact | table | Rasterize redacted pages and remove their underlying text. Boxes use original PDF user-space points with a bottom-left origin. Redaction removes forms, annotations, attachments and document metadata. | NULL | [SELECT * FROM pdf_redact('document.pdf', 'redacted.pdf', [{page: 1, x: 0.0, y: 0.0, w: 100.0, h: 30.0}]);] |
| pdf_redact_lateral | table | Column-input variant of pdf_redact. Uses dpi 200 and an empty password; no named options. | NULL | [SELECT * FROM pdf_redact_lateral('document.pdf', 'redacted.pdf', [{page: 1, x: 0.0, y: 0.0, w: 100.0, h: 30.0}]);] |
| pdf_render | scalar | Scalar: render one page to encoded PNG or SVG bytes (BLOB); optional STRUCT format defaults to png, dpi to 150. Use decode for SVG text. Table: stream pages, with format png (default) or svg; output_dir writes preview files. Page bounds, dpi and password are named table options. | NULL | [SELECT pdf_render('document.pdf', 1, {format: 'png', dpi: 150});] |
| pdf_render | table | Scalar: render one page to encoded PNG or SVG bytes (BLOB); optional STRUCT format defaults to png, dpi to 150. Use decode for SVG text. Table: stream pages, with format png (default) or svg; output_dir writes preview files. Page bounds, dpi and password are named table options. | NULL | [SELECT page, png FROM pdf_render('document.pdf', dpi := 150);] |
| pdf_rewrite | scalar | Rewrite a local PDF. STRUCT mode is compress, repair, encrypt or decrypt. Encrypt/decrypt require password; encrypt optionally accepts owner_password. Repair optionally accepts password. Output is atomically published. | NULL | [SELECT pdf_rewrite('document.pdf', 'small.pdf', {mode: 'compress'});] |
| pdf_sign | table | Sign using a PEM certificate and key. Existing signatures are rejected: incremental signing is unsupported. Inspect with pdf_objects kind signatures. | NULL | [SELECT * FROM pdf_sign('document.pdf', 'signed.pdf', 'cert.pem', 'key.pem');] |
| pdf_split | table | Split a local PDF into files by page (default mode page), or near-white separators (mode blank, blank_threshold in (0,1]). Schemas differ by mode. The output directory must exist. | NULL | [SELECT * FROM pdf_split('document.pdf', 'parts', mode := 'blank');] |
| pdf_stamp | scalar | Stamp a local PDF. STRUCT mode watermark requires text, optional opacity defaults to 0.30; mode bates requires prefix and start. Output is atomically published. | NULL | [SELECT pdf_stamp('document.pdf', 'marked.pdf', {mode: 'watermark', text: 'DRAFT'});] |
| pdf_text | scalar | Convert a path or PDF BLOB to VARCHAR. Optional STRUCT: format text (default), markdown, html, xml or json; text layout defaults to reading. Password is supported except for Markdown. Markdown requires a path. | NULL | [SELECT pdf_text('document.pdf', {format: 'markdown'});] |
| poppler_version | scalar | Return the linked runtime Poppler version. | NULL | [SELECT poppler_version();] |
| read_pdf | table | Read PDF pages by default, or select grain page, line, element, table or chunk at bind time. Each grain retains its native typed columns and streams through DuckDB file readers. Unsupported options for the selected grain are rejected. | NULL | [SELECT page, text FROM read_pdf('document.pdf', grain := 'page');] |
| read_pdf_words | table | Read positioned words with font, column/line grouping, label and OCR provenance. Coordinates use displayed page points with a top-left origin. | NULL | [SELECT * FROM read_pdf_words('document.pdf');] |
| to_pdf | scalar | Convert a local Office document with LibreOffice. Omit output_path to replace the input extension with pdf. Requires external process access. | NULL | [SELECT to_pdf('document.docx', 'converted.pdf');] |
| write_pdf | scalar | Write text to PDF using the in-process writer. Omit output_path to create a temporary PDF and return its path. | NULL | [SELECT write_pdf('Hello', 'hello.pdf');] |
### Overloaded Functions
This extension does not add any function overloads.
### Added Types
This extension does not add any types.
### Added Settings
| name | description | input_type | scope | aliases | typed_value |
|----------------|---------------------------------------------------------|------------|--------|---------|-------------|
| temp_directory | Set the directory to which temporary files are written. | VARCHAR | GLOBAL | [] | post.db.tmp |