You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "kylebarron (via GitHub)" <gi...@apache.org> on 2025/01/13 23:34:18 UTC

[PR] Improve docs for `AmazonS3Builder::from_env` [arrow-rs]

kylebarron opened a new pull request, #6977:
URL: https://github.com/apache/arrow-rs/pull/6977

   # Which issue does this PR close?
   
   Closes #.
   
   # Rationale for this change
   
   The documentation for [`AmazonS3Builder::from_env`](https://docs.rs/object_store/latest/object_store/aws/struct.AmazonS3Builder.html#method.from_env) makes it seem like only _specific_ AWS environment variables are looked for in the current environment. However **any** env vars starting with `AWS_` are checked. 
   
   # What changes are included in this PR?
   
   Document that all env vars starting with `AWS_` are checked, so any value in `AmazonS3ConfigKey` can be used.
   
   # Are there any user-facing changes?
   
   No, documentation only.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Improve docs for `AmazonS3Builder::from_env` [arrow-rs]

Posted by "tustvold (via GitHub)" <gi...@apache.org>.
tustvold merged PR #6977:
URL: https://github.com/apache/arrow-rs/pull/6977


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Improve docs for `AmazonS3Builder::from_env` [arrow-rs]

Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #6977:
URL: https://github.com/apache/arrow-rs/pull/6977#discussion_r1915583423


##########
object_store/src/aws/builder.rs:
##########
@@ -427,14 +427,19 @@ impl AmazonS3Builder {
 
     /// Fill the [`AmazonS3Builder`] with regular AWS environment variables
     ///
-    /// Variables extracted from environment:
+    /// All environment variables starting with `AWS_` will be evaluated. Names must
+    /// match acceptable input to [`AmazonS3ConfigKey::from_str`][]. Only upper-case environment

Review Comment:
   ```suggestion
       /// match acceptable input to [`AmazonS3ConfigKey::from_str`]. Only upper-case environment
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Improve docs for `AmazonS3Builder::from_env` [arrow-rs]

Posted by "kylebarron (via GitHub)" <gi...@apache.org>.
kylebarron commented on PR #6977:
URL: https://github.com/apache/arrow-rs/pull/6977#issuecomment-2588461358

   Perhaps the Azure and GCS `from_env` docs should be updated similarly? I haven't looked at their implementations.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org