Skip to content
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.

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

Download S3 files to local disk instead of holding connections to S3 #157

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ package-lock.json
.scannerwork
.idea
.idea/
*.d.ts
*.js
*.js.map
*.utest.js
Expand Down
26 changes: 26 additions & 0 deletions lib/lib.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,32 @@ export interface ReadOptions {
*/
fast_s3_read_parallel_fetch_max_bytes?: number;


/**
* When using the [[`ReadOptions.fast_s3_read`]] feature, this specifies if downloaded files should be saved after they are consumed.
*
* @default false
* @todo inconsistent fast_s3_read_save_files
*/
fast_s3_read_save_files?: boolean;

/**
* When using the [[`ReadOptions.fast_s3_read`]] feature, this specifies if max size in bytes that a file should be download locally vs streamed from S3.
*
* @default 5mb in bytes
* @todo inconsistent fast_s3_read_max_download_file_size_bytes
*/
fast_s3_read_max_download_file_size_bytes?: number;

/**
* When using the [[`ReadOptions.fast_s3_read`]] feature, this specifies if downloaded files should be saved uncompressed (jsonl vs jsonl.gz).
*
* @default false
* @todo inconsistent fast_s3_read_download_as_uncompressed
*/
fast_s3_read_download_as_uncompressed?: boolean;


/**
* The max number of records, events, the SDK should retrieve each time it retrieves events from the
* RStreams Bus' Dynamo DB events table.
Expand Down
Loading