postgis extension for knex
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

knex-postgis

Extension for use postgis functions in knex SQL query builder.

Example

This example show the sql generated by the extension.

const knex = require('knex');
const knexPostgis = require('knex-postgis');

const db = knex({
  dialect: 'postgres'
});

// install postgis functions in knex.postgis;
const st = knexPostgis(db);
/* or:
 * knexPostgis(db);
 * const st = db.postgis;
 */

// insert a point
const sql1 = db.insert({
  id: 1,
  geom: st.geomFromText('Point(0 0)', 4326)
}).into('points').toString();
console.log(sql1);
// insert into "points" ("geom", "id") values (ST_geomFromText('Point(0 0)'), '1')

// find all points return point in wkt format
const sql2 = db.select('id', st.asText('geom')).from('points').toString();
console.log(sql2);
// select "id", ST_asText("geom") as "geom" from "points"

// all methods support alias
const sql3 = db.select('id', st.asText(st.centroid('geom')).as('centroid')).from('geometries').toString();
console.log(sql3);
// select "id", ST_asText(ST_centroid("geom")) as "centroid" from "geometries"

Currently supported functions

Define extra functions

const knex = require('knex');
const knexPostgis = require('knex-postgis');

const db = knex({
  dialect: 'postgres'
});

knexPostgis(db);

db.postgisDefineExtras((knex, formatter) => ({
  utmzone(geom) {
    return knex.raw('utmzone(?)', [formatter.wrapWKT(geom)]);
  }
}));
//now you can use st.utmzone function in the same way as predefined functions

Changelog

0.7.0

0.6.0

0.5.0

  • drop support for node 0.x
  • add knex@0.14, node 8 y node 9 to travis

0.4.0

  • add support for @ operator as boundingBoxContained
  • add support for ~ operator as boundingBoxContains
  • rename function boundingBoxIntersection to boundingBoxIntersects. The function boundingBoxIntersection will be removed in the next release.

0.3.0

  • add support for && operator as boundingBoxIntersection

0.2.2

  • update geojsonhint dependency to its new name (@davidfurlong)

0.2.1

  • fix recognition of multi* WKTs (@johnhampton)

0.2.0

  • (breaking change) Drop support for knex@0.7
  • add support for knex@0.12