Skip to content

docs: stop telling README readers that region is mandatory #87

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
ClayMav merged 2 commits into from
Oct 28, 2026
Merged

docs: stop telling README readers that region is mandatory #87

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a70600
docs: fix README region, Store defaults, and PEP 249 globals
ClayMav Oct 28, 2026
cb219bf
docs: note that presigned Store URLs need single=True
ClayMav Oct 28, 2026
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
23 changes: 9 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ runtime and execute Spatial SQL queries.
## PEP 249 DB-API 2.0 Compliance

This driver implements the [PEP 249](https://peps.python.org/pep-0249/)
Python Database API Specification v2.0 and exposes the following
module-level globals:
Python Database API Specification v2.0. Its module-level globals are
defined in `wherobots.db.driver` and are not re-exported from `wherobots.db`:

| Global | Value | Meaning |
|---|---|---|
Expand Down Expand Up @@ -103,7 +103,7 @@ with connect(...) as conn:
results = curr.fetchall()
```

It also implements the `close()` method, as suggested by the PEP-2049
It also implements the `close()` method, as suggested by the PEP 249
specification, to support situations where the cursor is wrapped in a
`contextmanager.closing()`.

Expand Down Expand Up @@ -137,12 +137,12 @@ with connect(

The `Store` class supports the following options:

* `format`: output format - `StorageFormat.PARQUET` (default),
* `format` (required): output format - `StorageFormat.PARQUET`,
`StorageFormat.CSV`, or `StorageFormat.GEOJSON`
* `single`: if `True`, write results to a single file instead of
multiple partitioned files (default: `True`)
multiple partitioned files (default: `False`)
* `generate_presigned_url`: if `True`, generate a presigned URL for
downloading results (default: `False`)
downloading results (default: `False`). Requires `single=True`.

Use `Store.for_download()` as a convenient shorthand for storing results
as a single Parquet file with a presigned URL.
Expand Down Expand Up @@ -250,8 +250,9 @@ parameter, passing in one of the `Runtime` enum values. For more
information on runtime sizing and selection, please consult the
[Wherobots product documentation](https://docs.wherobots.com).

You must also specify in which region your SQL session should execute
into. Wherobots Cloud supports the following compute regions:
You can also choose the region your SQL session runs in with the
`region` parameter. When omitted, your organization's configured default
region is used. Wherobots Cloud supports the following compute regions:

* `aws-us-east-1`: AWS US East 1 (N. Virginia)
* `aws-us-east-2`: AWS US East 2 (Ohio)
Expand All @@ -264,12 +265,6 @@ into. Wherobots Cloud supports the following compute regions:
> and customers; other regions are currently reserved to Professional
> Edition customers.

> [!WARNING]
> To prepare for the expansion of Wherobots Cloud to new regions and cloud providers, the `region` parameter will become mandatory in a future SDK version.
> Before this support for new regions is added, we will release an updated version of the SDK.
> While you can continue using an older SDK version for your development,
> any new or existing SQL session you initialize without specifying the `region` parameter will be hosted in the `aws-us-west-2` region.

### Advanced parameters

The `connect()` method takes some additional parameters that advanced
Expand Down
Loading