Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
add custom limit settings
  • Loading branch information
doneill committed May 5, 2024
1 parent c7c5ea0 commit 9fb3c00
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,14 @@ The provider use `gid` as the OBJECTID unique identifier. Optionally, if you pr
export PG_OBJECTID="${OBJECT_ID}"
```

### Custom PostgreSQL LIMIT
The provider uses Postgres JSONB which limits document size to 255MB in size. To optimize returning data from large datasets exceeding 255MB you can optionally add a limit to just a portion of the rows that are used to create the GeoJSON data. The default limit is 10000000 rows.

```bash
# value should be String, e.g. "1000"
export PG_LIMIT="${LIMIT}"
```

## Install
Koop providers require you to first install [Koop](https://koopjs.github.io/). You can add `koop-provider-pg` to your Koop server dependencies by installing it with npm:

Expand Down

0 comments on commit 9fb3c00

Please sign in to comment.