Add table_schema query and checks

[dbauszus-glx]

This PR adds a table_schema query to the XYZ core queries.

The smallest definition of a layer [template] is with a table and dbs. Although the workspace fallback will be used if not explicit in the template.

  "templates": {
    "foo": {
      "dbs": "MAPP",
      "table": "geodata.uk_glx_geodata_oa_metrics_2021"
    }
  },

The templateTables method has been updated to allow for the table name to pass without the schema.

The schema and table params can now be defined for the table_schema query.

http://localhost:3000/api/query?template=table_schema&table_schema=geodata&table=uk_glx_geodata_oa_metrics_2021&layer=foo

The schema is returned as an array:

[
  {
    "column_name": "id",
    "data_type": "integer",
    "udt_name": "int4",
    "character_maximum_length": null,
    "column_default": null,
    "is_nullable": "NO"
  },
  {
    "column_name": "oa_code",
    "data_type": "text",
    "udt_name": "text",
    "character_maximum_length": null,
    "column_default": null,
    "is_nullable": "YES"
  },
  {
    "column_name": "lsoa_id",
    "data_type": "integer",
    "udt_name": "int4",
    "character_maximum_length": null,
    "column_default": null,
    "is_nullable": "YES"
  },

[dbauszus-glx]

The query module structure has been revised. The executeQuery method was unnecessary complex. This method has now been resolved into the query method.

The checkFieldsParam method has been added to the layerQuery method to ensure that any field in the fields param is referenced in the layer object of a layer query.

The methods to replace variables in query template strings with string or substitute variables have now been unnested and documented.

Request params are now consistently assigned to the template object if not defined on the template ??=.

All params, and properties should now be documented.

The dbs check should be made before compiling the query [string] in the getQueryFromTemplate method.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud