Skip to content

Commit

Permalink
Python: Add more pyiceberg docs (apache#6874)
Browse files Browse the repository at this point in the history
  • Loading branch information
LuigiCerone authored Feb 20, 2023
1 parent 2dea41d commit 42d209f
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion python/mkdocs/docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

# Python API

PyIceberg is based around catalogs to load tables. First step is to instantiate a catalog that loads tables. Let's use the following configuration:
PyIceberg is based around catalogs to load tables. First step is to instantiate a catalog that loads tables. Let's use the following configuration to define a catalog called `prod`:

```yaml
catalog:
Expand All @@ -28,6 +28,10 @@ catalog:
credential: t-1234:secret
```
These info must be placed inside a file called `.pyiceberg.yaml` located either in the `$HOME` directory or in the `$PYICEBERG_HOME` directory (if var is set).

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

Then load the `prod` catalog:

```python
Expand Down

0 comments on commit 42d209f

Please sign in to comment.