https://github.com/koopjs/koop-pgcache
PostGIS cache for Koop.
https://github.com/koopjs/koop-pgcache
Last synced: about 1 year ago
JSON representation
PostGIS cache for Koop.
- Host: GitHub
- URL: https://github.com/koopjs/koop-pgcache
- Owner: koopjs
- License: other
- Created: 2015-02-11T22:00:07.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T21:02:07.000Z (over 3 years ago)
- Last Synced: 2025-03-24T09:38:14.468Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 813 KB
- Stars: 4
- Watchers: 14
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# koop-pgcache
[![npm][npm-img]][npm-url]
[![travis][travis-image]][travis-url]
[npm-img]: https://img.shields.io/npm/v/koop-pgcache.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/koop-pgcache
[travis-image]: https://img.shields.io/travis/koopjs/koop-pgcache.svg?style=flat-square
[travis-url]: https://travis-ci.org/koopjs/koop-pgcache
A PostGIS data cache for [Koop](https://github.com/Esri/koop).
Koop's data caching is by default a local, in-memory object. `koop-pgcache` allows you to use PostGIS to cache data retrieved from requests more efficiently and minimize round trips and rate limiting from third party data providers.
## Install
```
npm install koop-pgcache
```
## Usage
To use a PostGIS cache, you need to have a PostgreSQL database with PostGIS enabled.
Detailed installation guides for PostgreSQL are available [here](https://wiki.postgresql.org/wiki/Detailed_installation_guides).
Instructions for enabling PostGIS on an existing PostgreSQL database are available [here](http://postgis.net/install/).
Once you have a PostGIS database for Koop to use as a cache, add the postgres address of the database to your Koop configuration and register the PostGIS cache like so:
```js
var config = {
'db': {
'conn': 'postgres://localhost/koopdev'
}
}
var koop = require('koop')(config)
var koopPg = require('koop-pgcache')
koop.registerCache(koopPg)
```
If everything was configured correctly, Koop should now be using your PostGIS database to cache data from providers.
## Documentation
* [koop-pgcache docs](http://koopjs.github.io/koop-pgcache/docs)
## Resources
* [Koop](https://github.com/Esri/koop)
* [PostgreSQL](http://www.postgresql.org/)
* [PostGIS](http://postgis.net/)
* [ArcGIS for Developers](http://developers.arcgis.com)
* [ArcGIS REST API Documentation](http://resources.arcgis.com/en/help/arcgis-rest-api/)
* [@esri](http://twitter.com/esri)
## Issues
Find a bug or want to request a new feature? Please let us know by submitting an issue.
## Contributing
Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](https://github.com/esri/contributing).
## License
[Apache 2.0](LICENSE)