17 releases (stable)
new 3.0.0 | May 4, 2025 |
---|---|
2.5.0 | Mar 15, 2025 |
2.4.1 | Jul 21, 2024 |
2.3.0 | Jan 7, 2024 |
0.1.0 | Feb 21, 2021 |
#9 in Geospatial
15,490 downloads per month
135KB
3.5K
SLoC
PostGIS Diesel
Extension for Diesel framework to support PostGIS types. It provides support for both the postgres
and, optionally, the sqlite
backends. While the former is enabled by default with the postgres
feature, the latter requires the sqlite
feature to be enabled.
Example of Usage
To ensure that the Geometry
type is in scope, read this guide and add postgis_diesel::sql_types::*
to the import_types key in your diesel.toml
file.
Assume that the table is defined like this:
CREATE EXTENSION IF NOT EXISTS postgis;
CREATE TABLE geometry_samples
(
id SERIAL PRIMARY KEY,
point geometry(Point,4326) NOT NULL,
linestring geometry(Linestring,4326) NOT NULL
);
Or, if you are using sqlite
, like this:
CREATE TABLE geometry_samples
(
id SERIAL PRIMARY KEY,
point BLOB NOT NULL,
linestring BLOB NOT NULL
);
Then Rust code (with either backends) may look like this:
#[macro_use]
extern crate diesel;
use postgis_diesel::operators::*;
use postgis_diesel::types::*;
#[derive(Insertable)]
#[diesel(table_name = geometry_samples)]
struct NewGeometrySample {
point: Point,
linestring: LineString<Point>,
}
#[derive(Queryable)]
struct GeometrySample {
id: i32,
point: Point,
linestring: LineString<Point>,
}
table! {
use postgis_diesel::sql_types::*;
use diesel::sql_types::*;
geometry_samples (id) {
id -> Int4,
point -> Geometry,
linestring -> Geometry,
}
}
See integration test for more complete example.
How to Remove Automatically Generated Types From Schema
- Generate schema file with diesel
print-schema > src/full_schema.rs
. - Remove not required SQL types from it and save to
src/schema.rs
. - Run
diff -U6 src/full_schema.rs src/schema.rs > src/schema.patch
. - Add
patch_file = "src/schema.patch"
to diesel.toml. - Remove
src/full_schema.rs
, check thatdiesel print-schema > src/schema.rs
will not add Geometry type.
Example of patch file:
@@ -1,12 +1,9 @@
// @generated automatically by Diesel CLI.
pub mod sql_types {
- #[derive(diesel::query_builder::QueryId, diesel::sql_types::SqlType)]
- #[diesel(postgres_type(name = "geometry"))]
- pub struct Geometry;
#[derive(diesel::query_builder::QueryId, diesel::sql_types::SqlType)]
#[diesel(postgres_type(name = "intensity"))]
pub struct Intensity;
#[derive(diesel::query_builder::QueryId, diesel::sql_types::SqlType)]
@@ -52,13 +49,12 @@
diesel::table! {
use diesel::sql_types::*;
use postgis_diesel::sql_types::*;
use super::sql_types::Intensity;
use super::sql_types::Triggermethod;
- use super::sql_types::Geometry;
laps (activity_id, started_at, manual_track) {
activity_id -> Uuid,
started_at -> Timestamptz,
total_time_seconds -> Float8,
distance_meters -> Float8,
How to Run Tests
- Start Postgis DB
docker compose up
- Run tests
cargo test
Dependencies
~0.1–4MB
~79K SLoC