Skip to content

Commit e817d75

Browse files
authored
Update cli.md (#4329)
* Update cli.md * Fix prettier errors
1 parent ad5a508 commit e817d75

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

docs/source/user-guide/cli.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -155,26 +155,32 @@ LOCATION '/path/to/aggregate_test_100.csv';
155155
156156
The CLI can query data in S3 if the following environment variables are defined:
157157
158-
- `AWS_REGION`
158+
- `AWS_DEFAULT_REGION`
159159
- `AWS_ACCESS_KEY_ID`
160160
- `AWS_SECRET_ACCESS_KEY`
161161
162-
Note that the region must be set to the region where the bucket exists until the following issue is resolved:
162+
Details of the environment variables that can be used are
163163
164-
- https://github.com/apache/arrow-rs/issues/2795
164+
- AWS_ACCESS_KEY_ID -> access_key_id
165+
- AWS_SECRET_ACCESS_KEY -> secret_access_key
166+
- AWS_DEFAULT_REGION -> region
167+
- AWS_ENDPOINT -> endpoint
168+
- AWS_SESSION_TOKEN -> token
169+
- AWS_CONTAINER_CREDENTIALS_RELATIVE_URI -> <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html>
170+
- AWS_ALLOW_HTTP -> set to "true" to permit HTTP connections without TLS
165171
166172
Example:
167173
168174
```bash
169175
$ aws s3 cp test.csv s3://my-bucket/
170176
upload: ./test.csv to s3://my-bucket/test.csv
171177
172-
$ export AWS_REGION=us-east-2
178+
$ export AWS_DEFAULT_REGION=us-east-2
173179
$ export AWS_SECRET_ACCESS_KEY=***************************
174180
$ export AWS_ACCESS_KEY_ID=**************
175181
176-
$ ./target/release/datafusion-cli
177-
DataFusion CLI v12.0.0
182+
$ datafusion-cli
183+
DataFusion CLI v14.0.0
178184
❯ create external table test stored as csv location 's3://my-bucket/test.csv';
179185
0 rows in set. Query took 0.374 seconds.
180186
select * from test;

0 commit comments

Comments
 (0)