644281359a
* Add pygeofilter, unpin psycopg2 * Add pygeofilter SQLAlchemy query demo * Add note about primary key * Add todos to script * Make script generic * Add (commented out) PostgreSQL provider hotosm_bdi_waterways to config * Update to use local test database * Return result as dictionary * Pass GEOM_FIELD as variable * Add offset and limt, fix two names * Implement order by * Use function for cql query * Add cql query block to query and test * Link up to db engine * Convert WKB geometry to GeoJSON * Add shapely as explicit dependency * Add tests for CQL queries * Add test using CROSSES with LINESTRING * Uncomment Docker PostGIS test layer * First pass at wiring up API The CQL is read from the request but the parser fails to convert to AST. * Turn logging to DEBUG Example query http://localhost:5000/collections/hot_osm_waterways/items?cql=%27osm_id%20BETWEEN%2080800000%20AND%2080900000%20AND%20name%20IS%20NULL%27 * Create dedicated pygeoapi-config.yml for testing PostgreSQL * Add test for PostgreSQL CQL * Return 400 for bad CQL * Tidy up old files * Bring API error type tests together * Only reflect the table of interest * Add pygeofilter to requirements * Remove local setup_env.sh from .gitignore * Remove lark exception handling * Remove lark codes from tests, docstring change * Split cql test into good and error * Rename cql parameter to filter * Add optional filter-lang parameter with test * Initial changes * Rename cql text parser * Use CQL-JSON POST for PostgreSQL query * Refactor to get data early and handle errors * Add error tests for CQL-JSON PostgreSQL * Add tests for prev/next and provider instantiation * As filter-lang is set the block in not needed * Clarify test fixtures * Use filterq only in all CQL calls * Make engine and table_model attributes of provider * Handle different instantiation failures * Use SQLAlchemy for get_fields() * Minor doc edits * Use SQLAlchemy for get() * Simplify _sqlalchemy_to_feature * Store database parameters in dedicated function * Strip out non-SQLAlchemy code * Add draft query() based on CQL filters * Add property filtering to query() * Implement select_properties and skip_geometry * Implement bbox filter * Implement properties subset defined in config * Clean up materialized view test We only need to test the fields that are present to be sure that the view has been accessed, so other checks have been removed. * Flake8 fixes and tidy up * Add combined test for CQL with bbox and properties * Create sessions directly where required * Add Engine store to allow connection reuse * Replace cql_ast with filterq * Tidy up tests by using fixture for api * Add authors * Use Session() as context manager A session requires a connection to the database, as provided by the SQLAlchemy engine. When the session goes out of scope, e.g. at exit from the function when it was used, it should be garbage collected and the connection freed. However, during load testing it was found that this wasn't happening. This commit uses a context manager pattern to start the session, which ensures that the session is closed at the end of the `with` block. * Return fields type as {'type': ...} * Cache the table_model with the engine Generating the table_model by "reflecting" the database is expensive but the resulting model doesn't change. If we cache the table_model with the engine we save on a round-trip to the database and speed up response time. * Use separate stores for Engine and table_models Using a combined store based on both engine and table_model meant that a pygeoapi serving multiple tables on the same database would maintain a connection pool for each table. This could eventually saturate the number of available connections. This commit separates the store into two parts. * Update documentation with example * Manage or post items based on POST content type * ghcr build action * only ghcr job * run criteria edit * Update README.md * job = main * remove success requirememt * add tag * tags: bgs-cql * Update main.yml * Update README.md * remove binary * update * Update actions to latest versions * Dockerfile refactor * Dockerfile refactor * restore dockerhub * fix pygeoif version * # 3.6 test & dockerhub ref * Pin pygeoif version to less than 1 * Replace psycopg-binary with psycopg * Split Docker build into sections * Pin click version >7,<=8 * Add further cql examples * Update workflows to match GeoPython repo * update flake python version * Unquote PostgreSQL column names * Update container workflow uses versions * flake8 use python version 3.7 * Use pre ping to get db connection * Test that properties are set in provider * Amendments as requested by @tomkralidis * Correction * Fix reviewed changes in api code Co-authored-by: Colin Blackburn <colb@bgs.ac.uk> Co-authored-by: KoalaGeo <eddlewis85@gmail.com> Co-authored-by: Edd <edlew@bgs.ac.uk> Co-authored-by: Colin Blackburn <ximenesuk@users.noreply.github.com>
137 lines
4.5 KiB
YAML
137 lines
4.5 KiB
YAML
# =================================================================
|
|
#
|
|
# Authors: Tom Kralidis <tomkralidis@gmail.com>
|
|
#
|
|
# Copyright (c) 2020 Tom Kralidis
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person
|
|
# obtaining a copy of this software and associated documentation
|
|
# files (the "Software"), to deal in the Software without
|
|
# restriction, including without limitation the rights to use,
|
|
# copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
# copies of the Software, and to permit persons to whom the
|
|
# Software is furnished to do so, subject to the following
|
|
# conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be
|
|
# included in all copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|
# OTHER DEALINGS IN THE SOFTWARE.
|
|
#
|
|
# =================================================================
|
|
|
|
server:
|
|
bind:
|
|
host: 0.0.0.0
|
|
port: 5000
|
|
url: http://localhost:5000
|
|
mimetype: application/json; charset=UTF-8
|
|
encoding: utf-8
|
|
gzip: false
|
|
languages:
|
|
# First language is the default language
|
|
- en-US
|
|
- fr-CA
|
|
# cors: true
|
|
pretty_print: true
|
|
limit: 100
|
|
# templates:
|
|
# path: /path/to/Jinja2/templates
|
|
# static: /path/to/static/folder # css/js/img
|
|
map:
|
|
url: https://tile.openstreetmap.org/{z}/{x}/{y}.png
|
|
attribution: '© <a href="https://openstreetmap.org/copyright">OpenStreetMap contributors</a>'
|
|
# manager:
|
|
# name: TinyDB
|
|
# connection: /tmp/pygeoapi-process-manager.db
|
|
# output_dir: /tmp/
|
|
# ogc_schemas_location: /opt/schemas.opengis.net
|
|
|
|
logging:
|
|
level: DEBUG
|
|
#logfile: /tmp/pygeoapi.log
|
|
|
|
metadata:
|
|
identification:
|
|
title:
|
|
en: pygeoapi default instance
|
|
fr: instance par défaut de pygeoapi
|
|
description:
|
|
en: pygeoapi provides an API to geospatial data
|
|
fr: pygeoapi fournit une API aux données géospatiales
|
|
keywords:
|
|
en:
|
|
- geospatial
|
|
- data
|
|
- api
|
|
fr:
|
|
- géospatiale
|
|
- données
|
|
- api
|
|
keywords_type: theme
|
|
terms_of_service: https://creativecommons.org/licenses/by/4.0/
|
|
url: https://example.org
|
|
license:
|
|
name: CC-BY 4.0 license
|
|
url: https://creativecommons.org/licenses/by/4.0/
|
|
provider:
|
|
name: Organization Name
|
|
url: https://pygeoapi.io
|
|
contact:
|
|
name: Lastname, Firstname
|
|
position: Position Title
|
|
address: Mailing Address
|
|
city: City
|
|
stateorprovince: Administrative Area
|
|
postalcode: Zip or Postal Code
|
|
country: Country
|
|
phone: +xx-xxx-xxx-xxxx
|
|
fax: +xx-xxx-xxx-xxxx
|
|
email: you@example.org
|
|
url: Contact URL
|
|
hours: Mo-Fr 08:00-17:00
|
|
instructions: During hours of service. Off on weekends.
|
|
role: pointOfContact
|
|
|
|
resources:
|
|
# Configuration for local Docker PostgreSQL data. See providers/postgresql.py for
|
|
# instructions on running and populating the database.
|
|
hot_osm_waterways:
|
|
type: collection
|
|
title: OSM waterways
|
|
description: Waterways demo data
|
|
keywords:
|
|
- OSM
|
|
- waterways
|
|
links:
|
|
- type: text/html
|
|
rel: canonical
|
|
title: Source instructions for loading data
|
|
href: https://github.com/geopython/pygeoapi/blob/master/pygeoapi/provider/postgresql.py
|
|
hreflang: en-UK
|
|
extents:
|
|
spatial:
|
|
bbox: [-180, -90, 180, 90]
|
|
crs: http://www.opengis.net/def/crs/OGC/1.3/CRS84
|
|
temporal:
|
|
begin: null
|
|
end: null # or empty (either means open ended)
|
|
providers:
|
|
- type: feature
|
|
name: PostgreSQL
|
|
data:
|
|
host: localhost
|
|
dbname: test
|
|
user: postgres
|
|
password: postgres
|
|
search_path: [osm, public]
|
|
id_field: osm_id
|
|
table: hotosm_bdi_waterways
|
|
geom_field: foo_geom |