#postgis #diesel #gis

postgis_diesel

An extension for Diesel framework to support PostGIS geometry datatype

15 releases (stable)

2.4.1 Jul 21, 2024
2.3.1 Apr 6, 2024
2.3.0 Jan 7, 2024
2.2.1 Jul 16, 2023
0.1.0 Feb 21, 2021

#74 in Database interfaces

Download history 3033/week @ 2024-08-03 1489/week @ 2024-08-10 3092/week @ 2024-08-17 3418/week @ 2024-08-24 3451/week @ 2024-08-31 3633/week @ 2024-09-07 3365/week @ 2024-09-14 3952/week @ 2024-09-21 3296/week @ 2024-09-28 2625/week @ 2024-10-05 3233/week @ 2024-10-12 4400/week @ 2024-10-19 4770/week @ 2024-10-26 3363/week @ 2024-11-02 3147/week @ 2024-11-09 2609/week @ 2024-11-16

14,496 downloads per month

MIT license

120KB
3K SLoC

PostGIS Diesel

Extension for Diesel framework to support PostGIS types.

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
);

Then Rust code 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

  1. Generate schema file with diesel print-schema > src/full_schema.rs.
  2. Remove not required SQL types from it and save to src/schema.rs.
  3. Run diff -U6 src/full_schema.rs src/schema.rs > src/schema.patch.
  4. Add patch_file = "src/schema.patch" to diesel.toml.
  5. Remove src/full_schema.rs, check that diesel 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

  1. Start Postgis DB
docker compose up
  1. Run tests
cargo test

Dependencies

~3.5MB
~71K SLoC