Skip to content

Document the optional AWS SDK peer requirement for S3 import/export jobs (v5.3) #672

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
heskew wants to merge 3 commits into
base: main
Choose a base branch
from
+4 −0
Open

Document the optional AWS SDK peer requirement for S3 import/export jobs (v5.3) #672

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
74ce20a
Document the optional AWS SDK peer requirement for import_from_s3 / e…
heskew Sep 15, 2026
2a200f2
Make both SDK install procedures explicit (rootPath vs global) per re…
heskew Sep 15, 2026
e5ec671
Note the official Docker image preinstalls the S3 SDK
heskew Sep 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions reference/database/jobs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,8 @@ Ingests CSV data from a URL.

Imports CSV or JSON files from an AWS S3 bucket.

<VersionBadge type="changed" version="v5.3.0" /> — the AWS SDK backing this operation is an optional peer dependency. The official Harper Docker image ships with it preinstalled; for npm installs, install it where Harper can resolve it: run `npm install @aws-sdk/client-s3 @aws-sdk/lib-storage` from the Harper instance root (`rootPath`), or — when Harper itself is installed globally — `npm install --global @aws-sdk/client-s3 @aws-sdk/lib-storage`. Without it, the operation fails with a `501` error naming this command.

- `operation` _(required)_ — `import_from_s3`
- `database` _(optional)_ — target database; defaults to `data`
- `table` _(required)_ — target table
Expand Down Expand Up @@ -162,6 +164,8 @@ Exports table data to an AWS S3 bucket in JSON or CSV format.

<VersionBadge type="changed" version="v4.3.0" /> — `search_by_conditions` added as a supported search operation

<VersionBadge type="changed" version="v5.3.0" /> — the AWS SDK backing this operation is an optional peer dependency; see the installation note under [Import from S3](#import-from-s3). Without it, the operation fails with a `501` error.

@gemini-code-assist gemini-code-assist Bot Sep 15, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For consistency with the import_from_s3 section and to maintain visibility for this critical requirement, this note should also be placed within a :::caution block.

Suggested change
<VersionBadge type="changed" version="v5.3.0" /> — the AWS SDK backing this operation is an optional peer dependency; see the installation note under [Import from S3](#import-from-s3). Without it, the operation fails with a `501` error.
:::caution Peer Dependencies Required
<VersionBadge type="changed" version="v5.3.0" />
This operation requires the same AWS SDK peer dependencies as `import_from_s3`. See the installation note under [Import from S3](#import-from-s3). Without the dependencies, the operation will fail with a `501` error.
:::
References
  1. When documenting critical caveats, potential runtime errors, or limitations, format them using a :::caution block (or appropriate admonition) to ensure they are prominent and visible, while maintaining consistency with the document's existing formatting patterns.


- `operation` _(required)_ — `export_to_s3`
- `format` _(required)_ — `json` or `csv`
- `s3` _(required)_ — S3 connection details (same fields as Import from S3, plus `key` for the output object name)
Expand Down
Loading