Skip to content

Document the S3 GetObject optimization#6375

Merged
benesch merged 1 commit into
MaterializeInc:mainfrom
quodlibetor:doc-s3-getobject-optimization
Apr 8, 2021
Merged

Document the S3 GetObject optimization#6375
benesch merged 1 commit into
MaterializeInc:mainfrom
quodlibetor:doc-s3-getobject-optimization

Conversation

@quodlibetor

Copy link
Copy Markdown
Contributor

Introduced in #6314

@quodlibetor quodlibetor requested review from awang and msudberg April 7, 2021 19:35

@awang awang left a comment

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.

thank you!!

|-----------------------|------------------------------------------------------------------------------------------|
| All | [`GetObject` permission][getobject] for the objects that they will download |
| **BUCKET SCAN** | [`ListObject` permission][listobject] for the buckets it will scan |
| **BUCKET SCAN** | [`ListObject` permission][listobject] for the buckets it will scan, **unless** the `MATCHING` pattern can only list a single object, in which cas materialize will only perform the necessary `GetObject` API call. |

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.

typo: "cas" -> "case"

Also, Materialize needs to be capitalized in the docs! Always always, unless you are referring to materialized the binary.

And minor nit: "unless the MATCHING pattern can only match a single object" is clearer I think; "list" isn't really a verb that can apply to a pattern but "match" of course is.

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.

+1 to @benesch's comments. I'd also break the final clause into its own sentence: "In such cases, Materialize will only perform the necessary GetObject API call."

@benesch

benesch commented Apr 8, 2021

Copy link
Copy Markdown
Contributor

I'm just going to knock these changes out!

@benesch benesch force-pushed the doc-s3-getobject-optimization branch from ff7c954 to b70c545 Compare April 8, 2021 19:40
@benesch benesch merged commit 7a9948f into MaterializeInc:main Apr 8, 2021
@quodlibetor quodlibetor deleted the doc-s3-getobject-optimization branch April 8, 2021 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants