Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/graphile-contrib/postgraphile-plugin-connection-filter-postgis

Last synced: 12 days ago
JSON representation

Host: GitHub
URL: https://github.com/graphile-contrib/postgraphile-plugin-connection-filter-postgis
Owner: graphile-contrib
License: mit
Created: 2018-10-05T14:07:59.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2023-07-18T21:57:26.000Z (over 1 year ago)
Last Synced: 2024-10-31T17:57:47.871Z (13 days ago)
Language: JavaScript
Size: 393 KB
Stars: 18
Watchers: 2
Forks: 4
Open Issues: 10
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Package on npm](https://img.shields.io/npm/v/postgraphile-plugin-connection-filter-postgis.svg)](https://www.npmjs.com/package/postgraphile-plugin-connection-filter-postgis) [![CircleCI](https://circleci.com/gh/graphile-contrib/postgraphile-plugin-connection-filter-postgis.svg?style=svg)](https://circleci.com/gh/graphile-contrib/postgraphile-plugin-connection-filter-postgis)

# postgraphile-plugin-connection-filter-postgis

This plugin exposes additional PostGIS-related fields on the `filter` argument of Connections.

## Usage

Requires `postgraphile@^4.5.0` and the following plugins appended prior to this plugin:

- `@graphile/[email protected]`

- `postgraphile-plugin-connection-filter@^2.0.0`

## Operators

| PostGIS function | Types | GraphQL field name |

| --- | --- | --- |

| ST_3DIntersects | geometry | intersects3D |

| ST_Contains | geometry | contains |

| ST_ContainsProperly | geometry | containsProperly |

| ST_CoveredBy | geometry, geography | coveredBy |

| ST_Covers | geometry, geography | covers |

| ST_Crosses | geometry | crosses |

| ST_Disjoint | geometry | disjoint |

| ST_Equals | geometry | equals |

| ST_Intersects | geometry, geography | intersects |

| ST_OrderingEquals | geometry | orderingEquals |

| ST_Overlaps | geometry | overlaps |

| ST_Touches | geometry | touches |

| ST_Within | geometry | within |

| PostGIS operator | Types | GraphQL field name |

| --- | --- | --- |

| = | geometry, geography | exactlyEquals |

| && | geometry, geography | bboxIntersects2D |

| &&& | geometry | bboxIntersectsND |

| &< | geometry | bboxOverlapsOrLeftOf |

| &<\| | geometry | bboxOverlapsOrBelow |

| &> | geometry | bboxOverlapsOrRightOf |

| \|&> | geometry | bboxOverlapsOrAbove |

| << | geometry | bboxLeftOf |

| <<\| | geometry | bboxBelow |

| >> | geometry | bboxRightOf |

| \|>> | geometry | bboxAbove |

| ~ | geometry | bboxContains |

| ~= | geometry | bboxEquals |

## Development

To establish a test environment, create an empty PostgreSQL database and set a `TEST_DATABASE_URL` environment variable with your database connection string.

```bash

createdb graphile_test

export TEST_DATABASE_URL=postgres://localhost:5432/graphile_test

yarn

yarn test

```