Fixes and adjustments for the Oracle provider (#1410)

* Added support for table synonyms * Added new parameters to query and manipulator call * Changed error types * Mount volumes to oracle container * workflow part 2 * workflow part 3 * workflow part 4 * Changed file permissions to 777 * Deleted folder * Recreated folder * Changed to official Oracle Docker-Image * Added Chown user * back to gvenzl/oracle-xe:latest * Tried docker-entrypoint-startdb.d * Added addnab/docker-run-action@v3 * Added port and deamon mode * next try * added job.container.network * next try * + docker ps * next try * using docker run * next try * next try * Changed len of array to 11 * Use sdo_util.from_geojsonfor create and update * Flake8 changes * Fixed error with views * Added crs_transform_spec support * Without default_crs * Updated documentation for Oracle Provider * changes for flake8 * Added crs_transform_spec support to get function * review changes * Added configurable SDO operator
geopython · Dec 16, 2023 · f5b6505 · f5b6505
1 parent d25d0cf
commit f5b6505
Show file tree

Hide file tree

Showing 7 changed files with 508 additions and 127 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -43,27 +43,10 @@ jobs:
     env:
       PYGEOAPI_CONFIG: "$(pwd)/pygeoapi-config.yml"
 
-    services:
-      # Oracle service (label used to access the service container)
-      oracle:
-        # Docker Hub image (feel free to change the tag "latest" to any other available one)
-        image: gvenzl/oracle-xe:latest
-        # Provide passwords and other environment variables to container
-        env:
-          ORACLE_RANDOM_PASSWORD: true
-          APP_USER: geo_test
-          APP_USER_PASSWORD: geo_test
-        # Forward Oracle port
-        ports:
-          - 1521:1521
-        # Provide healthcheck script options for startup
-        options: >-
-          --health-cmd healthcheck.sh
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 10
-    
     steps:
+    - name: Chown user
+      run: |
+        sudo chown -R $USER:$USER $GITHUB_WORKSPACE
     - uses: actions/checkout@v2
     - uses: actions/setup-python@v2
       name: Setup Python ${{ matrix.python-version }}
@@ -105,6 +88,9 @@ jobs:
       with:
         packages: gdal-bin libgdal-dev
         version: 3.0.4
+    - name: Install and run Oracle
+      run: |
+        docker run -d --name oracledb -e ORACLE_PWD=oracle -v ${{ github.workspace }}/tests/data/oracle/init-db:/opt/oracle/scripts/startup -p 1521:1521 container-registry.oracle.com/database/express:21.3.0-xe
     - name: Install requirements 📦
       run: |
         pip3 install -r requirements.txt
@@ -125,6 +111,7 @@ jobs:
         python3 tests/load_mongo_data.py tests/data/ne_110m_populated_places_simple.geojson
         gunzip < tests/data/hotosm_bdi_waterways.sql.gz | psql postgresql://postgres:${{ secrets.DatabasePassword || 'postgres' }}@localhost:5432/test
         psql postgresql://postgres:${{ secrets.DatabasePassword || 'postgres' }}@localhost:5432/test -f tests/data/dummy_data.sql
+        docker ps
         python3 tests/load_oracle_data.py
     - name: run unit tests ⚙️
       env:

diff --git a/docs/source/data-publishing/ogcapi-features.rst b/docs/source/data-publishing/ogcapi-features.rst
@@ -26,6 +26,7 @@ parameters.
    `GeoJSON`_,✅/✅,results/hits,❌,❌,❌,✅,❌,❌,✅
    `MongoDB`_,✅/❌,results,✅,✅,✅,✅,❌,❌,✅
    `OGR`_,✅/❌,results/hits,✅,❌,❌,✅,❌,❌,✅
+   `Oracle`_,✅/✅,results/hits,✅,❌,✅,✅,❌,❌,✅
    `PostgreSQL`_,✅/✅,results/hits,✅,✅,✅,✅,✅,❌,✅
    `SQLiteGPKG`_,✅/❌,results/hits,✅,❌,❌,✅,❌,❌,✅
    `SensorThings API`_,✅/✅,results/hits,✅,✅,✅,✅,❌,❌,✅
@@ -274,6 +275,8 @@ Oracle
 .. note::
   Requires Python package oracledb
 
+Connection
+""""""""""
 .. code-block:: yaml
 
   providers:
@@ -295,21 +298,64 @@ Oracle
         table: lakes
         geom_field: geometry
         title_field: name
-        # sql_manipulator: tests.test_oracle_provider.SqlManipulator
-        # sql_manipulator_options:
-        #     foo: bar
-        # mandatory_properties:
-        # - bbox
-        # source_crs: 31287 # defaults to 4326 if not provided
-        # target_crs: 31287 # defaults to 4326 if not provided
-
-The provider supports connection over host and port with SID or SERVICE_NAME. For TNS naming, the system 
+
+The provider supports connection over host and port with SID, SERVICE_NAME or TNS_NAME. For TNS naming, the system 
 environment variable TNS_ADMIN or the configuration parameter tns_admin must be set.
 
 The providers supports external authentication. At the moment only wallet authentication is implemented.
 
 Sometimes it is necessary to use the Oracle client for the connection. In this case init_oracle_client must be set to True.
 
+SDO options
+"""""""""""
+.. code-block:: yaml
+
+  providers:
+      - type: feature
+        name: OracleDB
+        data:
+            host: 127.0.0.1
+            port: 1521
+            service_name: XEPDB1
+            user: geo_test
+            password: geo_test
+        id_field: id
+        table: lakes
+        geom_field: geometry
+        title_field: name
+        sdo_operator: sdo_relate # defaults to sdo_filter
+        sdo_param: mask=touch+coveredby # defaults to mask=anyinteract
+        
+The provider supports two different SDO operators, sdo_filter and sdo_relate. When not set, the default is sdo_relate!
+Further more  it is possible to set the sdo_param option. When sdo_relate is used the default is anyinteraction!
+`See Oracle Documentation for details <https://docs.oracle.com/en/database/oracle/oracle-database/23/spatl/spatial-operators-reference.html>`_.
+
+Mandatory properties
+""""""""""""""""""""
+.. code-block:: yaml
+
+  providers:
+      - type: feature
+        name: OracleDB
+        data:
+            host: 127.0.0.1
+            port: 1521
+            service_name: XEPDB1
+            user: geo_test
+            password: geo_test
+        id_field: id
+        table: lakes
+        geom_field: geometry
+        title_field: name
+        manadory_properties:
+        - example_group_id
+
+On large tables it could be useful to disallow a query on the complete dataset. For this reason it is possible to 
+configure mandatory properties. When this is activated, the provoder throws an exception when the parameter
+is not in the query uri.
+
+Custom SQL Manipulator Plugin
+"""""""""""""""""""""""""""""
 The provider supports a SQL-Manipulator-Plugin class. With this, the SQL statement could be manipulated. This is
 useful e.g. for authorization at row level or manipulation of the explain plan with hints.