Skip to content
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.

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

Documentation for PostgreSQL integration testing #663

Closed
wants to merge 12 commits into from
1 change: 1 addition & 0 deletions doc/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ parts:
- file: integrations/questdb
- file: integrations/oracle
- file: integrations/trinodb
- file: integrations/postgres-test-doc


- caption: API Reference
Expand Down
3 changes: 3 additions & 0 deletions doc/community/developer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,9 @@ To run some of the tests:
pytest src/tests/integration/test_generic_db_operations.py::test_profile_query
```

### PostgreSQL Integration Tests
To run the tests for PostgreSQL DB integration follow the guide [here](../integrations/postgres-test-doc.ipynb)

### Integration tests with cloud databases

We run integration tests against cloud databases like Snowflake, which requires using pre-registered accounts to evaluate their behavior. To initiate these tests, please create a branch in our [ploomber/jupyter repository](https://github.com/ploomber/jupysql).
Expand Down
1 change: 1 addition & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
"integrations/trinodb.ipynb",
"integrations/oracle.ipynb",
"integrations/snowflake.ipynb",
"integrations/postgres-test-doc.ipynb"
]
nb_execution_in_temp = True
nb_execution_show_tb = True
Expand Down
2 changes: 1 addition & 1 deletion doc/howto/postgres-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ Ensure that you are using `pgspecial 1.x`. `pgspecial 2.x` has migrated to `psyc
```sh
conda install "pgspecial<2" -c conda-forge
```


If you have trouble getting it to work, [message us on Slack.](https://ploomber.io/community)
Loading