Skip to content

feat(docs): example of multiple catalogs defined in .pyiceberg.yaml #194

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

Merged
merged 3 commits into from
Dec 9, 2023
Merged

feat(docs): example of multiple catalogs defined in .pyiceberg.yaml #194

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f811bdc
feat(docs): example of multiple catalogs defined in .pyiceberg.yaml
jayceslesar Dec 7, 2023
7749435
more explicit example
jayceslesar Dec 9, 2023
457efe5
lint
jayceslesar Dec 9, 2023
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
14 changes: 14 additions & 0 deletions mkdocs/docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,20 @@ catalog:
credential: t-1234:secret
```

Note that multiple catalogs can be defined in the same `.pyiceberg.yaml`:
```yaml
catalog:
hive:
uri: thrift://127.0.0.1:9083
s3.endpoint: http://127.0.0.1:9000
s3.access-key-id: admin
s3.secret-access-key: password
rest:
uri: https://rest-server:8181/
warehouse: my-warehouse
```
and loaded in python by calling `load_catalog`. See below for an example.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the example primarily illustrates how to load a catalog that is not defined in .pyiceberg.yaml. For catalogs that are defined in the yaml file, we might say

and loaded in python by calling `load_catalog(name="hive")` and `load_catalog(name="rest")`

Does this sound right to you?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah I think that is more explicit -- will add


This information must be placed inside a file called `.pyiceberg.yaml` located either in the `$HOME` or `%USERPROFILE%` directory (depending on whether the operating system is Unix-based or Windows-based, respectively) or in the `$PYICEBERG_HOME` directory (if the corresponding environment variable is set).

For more details on possible configurations refer to the [specific page](https://py.iceberg.apache.org/configuration/).
Expand Down