backend/model/

entity.rs

//! Contains all entities used in `PermaplanT`.
//!
//! The fill & error ratios in the file can be calculated and updated automatically
//! via the script in /tools/update-fill-error-ratio/update-fill-error-ratio.py (usage in respective README)
//!
//! Latest script run was on 07.07.2026
//! Git SHA of the scraper-data commit used: 4eeed7ea0fda9fa6f3a6771d4816ab8330bf81e8

pub mod application_settings_impl;
pub mod areas;
pub mod areas_impl;
pub mod base_layer_images;
pub mod base_layer_images_impl;
pub mod drawing_properties;
pub mod drawing_properties_impl;
pub mod drawings;
pub mod drawings_impl;
pub mod guided_tour_impl;
pub mod layers;
pub mod layers_impl;
pub mod map_collaborator_impl;
pub mod map_impl;
pub mod plant_layer;
pub mod plantings;
pub mod plantings_impl;
pub mod plants_impl;
pub mod seed_impl;
pub mod timeline;

use chrono::NaiveDate;
use chrono::NaiveDateTime;

use diesel::AsChangeset;
use diesel::QueryableByName;
use diesel::{Identifiable, Insertable, Queryable};
use postgis_diesel::types::Point;
use postgis_diesel::types::Polygon;
use uuid::Uuid;

use crate::schema::{
    application_settings, guided_tour_progress, guided_tour_states, map_collaborators, maps,
    plants, seeds,
};

use super::r#enum::{
    herbaceous_or_woody::HerbaceousOrWoody, life_cycle::LifeCycle,
    light_requirement::LightRequirement, privacy_access_control::PrivacyAccessControl,
    quality::Quality, quantity::Quantity, shade::Shade, soil_texture::SoilTextureEnum,
    taxonomic_rank::TaxonomicRank, water_requirement::WaterRequirementEnum,
};

/// The `Plants` entity builds up an hierarchical structure, see `/doc/database/hierarchy.md`:
///
/// Use case for plant attributes is described in `/doc/usecases/assigned/plant_attributes.md`.
///
#[doc = include_str!("../../../doc/database/hierarchy.md")]
///
#[derive(Debug, Identifiable, Queryable, QueryableByName)]
#[diesel(table_name = plants)]
pub struct Plants {
    /// *Used* at many places
    /// - The internal id of the plant.
    /// - *Database fill ratio:* 100.00%
    pub id: i64,

    /// *Used* at many places
    /// - The unique name of the plant.
    /// - The structure is described above (`doc/database/hierarchy.md`).
    /// - *Database fill ratio:* 100.00%
    /// - *Scraper fill ratio:* 100.00%
    pub unique_name: String,

    /// *Used* at many places
    /// - The list of the common names of the plant in English.
    /// - *Fetched from* `PracticalPlants` and Permapeople.
    /// - *Database fill ratio:* 70.69%
    /// - *Scraper fill ratio:* 71.34%
    pub common_name_en: Option<Vec<Option<String>>>,

    /// *Used* at many places
    /// - The list of the common names of the plant in German.
    /// - *Fetched from* Wikidata API if not present in any source datasets.
    /// - *Database fill ratio:* 20.20%
    /// - *Scraper fill ratio:* 20.37%
    pub common_name_de: Option<Vec<Option<String>>>,

    // /// - The edible use of the plant, answering: Which food type can be produced from this plant, e.g. oil?
    // /// - Interesting for search functionality.
    // /// - *Fetched from* Permapeople as `edible_uses` and merged with Reinsaat.
    /// - *Not used*
    /// - *Scraper fill ratio:* 5.12%
    // pub edible_uses_en: Option<String>,

    // /// - *Fetched from* PracticalPlants as `medicinal_uses` and merged with Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.71%
    //pub medicinal_uses: Option<String>,

    // /// - Only for references.
    // /// - *Fetched from* PracticalPlants)
    /// - *Not used*
    /// - *Scraper fill ratio:* 26.73%
    // pub material_uses_and_functions: Option<String>,

    // /// - Only for references.
    // /// - *Fetched from* PracticalPlants)
    /// - *Not used*
    /// - *Scraper fill ratio:* 50.08%
    // pub botanic: Option<String>,

    // /// - Only informational.
    // /// - *Fetched from* PracticalPlants
    // /// - Plants are not only used for food but also for other uses, e.g. fiber to produce paper.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.57%
    // pub material_uses: Option<String>,
    //
    /// - *Used* for search ranking (diversity) and to be displayed in plant attributes.
    /// - ecological and environmental function of the plant, especially nitrogen fixer is relevant for `PermaplanT`.
    /// - *Fetched from* `PracticalPlants`)
    /// - *Database fill ratio:* 12.51%
    /// - *Scraper fill ratio:* 12.46%
    pub functions: Option<String>,

    // /// - Use `hardiness_zone` instead.
    // /// - indication of the heat range a plant endures.
    // /// - *Fetched from* `PracticalPlants`.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.03%
    // pub heat_zone: Option<i16>,
    //
    /// - Shade tolerance of the plant, to be used together with `light_requirement`.
    /// - *Used* in shade layer.
    /// - *For example* a plant that has "no shade", should get a warning if placed in a shade.
    /// - No shade: full sun exposure
    /// - Light shade: moderately shaded throughout the day
    /// - Partial shade: about 3-6 hours of direct sunlight
    /// - Permanent shade: less than 3 hours of direct sunlight
    /// - Shade indicates the shade tolerance. Plants obviously grow better with better light conditions.
    /// - Warnings should only show if a plant is moved into a too dark spot.
    ///   No warning should be shown when moved into a lighter spot.
    /// - *Fetched from* `PracticalPlants`.
    /// - *Database fill ratio:* 58.42%
    /// - *Scraper fill ratio:* 58.26%
    pub shade: Option<Shade>,

    // /// - Currently unused (maybe later used in pH layer).
    // /// - *See* explanation in `/doc/architecture/context.md`
    // /// - Soil PH can be tested by the user with simple means (e.g. litmus).
    // /// - *Fetched from* `PracticalPlants` and Permapeople (merged between Permapeople and `PracticalPlants`).
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.54%
    // pub soil_ph: Option<Vec<Option<SoilPh>>>,
    //
    /// - *See* explanation in `/doc/architecture/context.md`
    /// - *Used* in soil layer.
    /// - *Fetched from* `PracticalPlants` and Permapeople (merged with `soil_type` of Permapeople).
    /// - *Database fill ratio:* 77.81%
    /// - *Scraper fill ratio:* 77.78%
    pub soil_texture: Option<Vec<Option<SoilTextureEnum>>>,

    // /// - *NOT used* in hydrology layer
    // ///   as it has poor quality and no additional data compared to water_requirement
    // /// - *Fetched from* PracticalPlants
    // /// - wet = drowned, (often) flooded or in general very moist, e.g. swamp
    // /// - moist = humid, can hold some water, e.g. flat bed with humus
    // /// - well drained = dry, low capacity to hold water, e.g. sandhill.
    /// - *Scraper fill ratio:* 29.83%
    // pub soil_water_retention: Option<Vec<Option<SoilWaterRetention>>>,

    // /// - Only informational.
    // /// - *Fetched from* PracticalPlants
    // /// - gives information about environmental conditions, such as drought or wind tolerance
    /// - *Not used*
    /// - *Scraper fill ratio:* 12.26%
    //pub environmental_tolerances: Option<Vec<Option<String>>>,

    // /// - *Fetched from* PracticalPlants
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.18%
    //pub native_geographical_range: Option<String>,

    // /// - *Fetched from* `PracticalPlants`
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.11%
    //pub native_environment: Option<String>,

    // /// - Interesting for search functionality.
    // /// - *Fetched from* `PracticalPlants`
    // /// - informs about the (vertical) layer, that the plant usually inhabits, e.g. soil surface or canopy
    /// - *Not used*
    /// - *Scraper fill ratio:* 12.70%
    // pub ecosystem_niche: Option<String>,

    // /// - Only informational.
    // /// - deciduous = plants loose leaves in winter.
    // /// - evergreen = Plants don't throw leaves (e.g. pine tree).
    // /// - Not applicable for annual plants.
    // /// - *Fetched from* `PracticalPlants` and merged with `leaves` of Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 23.45%
    // pub deciduous_or_evergreen: Option<DeciduousOrEvergreen>,

    /// - *Used* Displayed in the plant attributes.
    /// - Only informational.
    /// - Fetched from `PracticalPlants`
    /// - informs about the plant physiology
    /// - woody = grows woody parts
    /// - herbaceous = doesn't grow wood, shoots remain soft/green.
    /// - *Database fill ratio:* 22.33%
    /// - *Scraper fill ratio:* 22.47%
    pub herbaceous_or_woody: Option<HerbaceousOrWoody>,

    /// - *Used* in search and attribute
    /// - Determines life span of the plant.
    /// - *Fetched from* `PracticalPlants` and Permapeople (merged with `life_cycle` of Permapeople).
    /// - *Database fill ratio:* 61.91%
    /// - *Scraper fill ratio:* 61.75%
    pub life_cycle: Option<Vec<Option<LifeCycle>>>,

    // /// - Only informational.
    // /// - *Fetched from* `PracticalPlants` and Permapeople (merged with `growth` of Permapeople).
    /// - *Not used*
    /// - *Scraper fill ratio:* 23.56%
    // pub growth_rate: Option<Vec<Option<GrowthRate>>>,

    /// - *Used only informational, is in rw attribute
    /// - *Fetched from* `PracticalPlants` as `mature_size_height` and merged with Permapeople.
    /// - informs about the maximum height that the plant gains in cm
    /// - *Database fill ratio:* 71.95%
    /// - *Scraper fill ratio:* 71.92%
    pub height: Option<i32>,

    // /// - Determines how large the plant can grow in diameter.
    // /// - Other plants should get a warning if planted within this area.
    // /// - *TODO:* replaced with spread, will keep this for now for information
    // /// - *Fetched from* `PracticalPlants` as `mature_size_width` and merged with Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 17.44%
    //pub width: Option<String>,

    // /// - Only informational.
    // /// - *Fetched from* `PracticalPlants`
    /// - *Not used*
    /// - *Scraper fill ratio:* 14.32%
    // pub fertility: Option<Vec<Option<Fertility>>>,

    // /// - Only informational.
    // /// - *Fetched from* PracticalPlants
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.35%
    //pub flower_colour: Option<String>,

    // /// - Only informational.
    // /// - *Fetched from* PracticalPlants
    // /// - a plant can contain flowers of two different sexes, male or female (monoecious), a plant can contain only flowers of one specific sex and therefore needs at least another plant of the other sex to reproduce (dioecious) or can contain flowers that have both the sexes within the same flower (hermaphrodite).
    /// - *Not used*
    /// - *Scraper fill ratio:* 49.30%
    // pub flower_type: Option<FlowerType>,

    /// - Is readonly in attribute
    /// - The creation date of the entry (actual time).
    /// - Only for administration.
    /// - *Database fill ratio:* 100.00%
    /// - *Scraper fill ratio:* 70.78%
    pub created_at: NaiveDateTime,

    /// - Is readonly in attribute
    /// - The last update date of the entry (actual time).
    /// - Only for administration.
    /// - *Database fill ratio:* 100.00%
    /// - *Scraper fill ratio:* 70.78%
    pub updated_at: NaiveDateTime,

    /// - *Used* so that an icon can be shown in the search results. Also displayed in the plant attributes.
    /// - Will be used in watering layer.
    /// - Fetched from `PracticalPlants` and merged with `has_drought_tolerance` of Permapeople.
    /// - *Database fill ratio:* 53.44%
    /// - *Scraper fill ratio:* 53.27%
    pub has_drought_tolerance: Option<bool>,

    // /// - *Fetched from* `PracticalPlants`.
    /// - *Not used*
    /// - *Scraper fill ratio:* 7.46%
    // pub tolerates_wind: Option<bool>,

    // /// - The list of the references of the plant.
    // /// - `references` items link to these items.
    // /// - Only informational.
    /// - *Not used*
    /// - *Scraper fill ratio:* 45.96%
    // pub plant_references: Option<Vec<Option<String>>>,

    // /// - Boolean value indicating whether the plant is a tree.
    // /// - Plants with `is_tree == true` can be used in the tree layer.
    // /// - In plants layer all plants can be used.
    // /// - *Initial value* is to `True` if  herbaceous_or_woody (woody) and life_cycle (perennial)
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.08%
    // pub is_tree: Option<bool>,

    // /// - Only informational.
    // /// - *Initial value* is to `light feeder` if "Nutritionally poor soil" in `environmental_tolerances` is present.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.03%
    // pub nutrition_demand: Option<NutritionDemand>,

    // /// - Number value between -1..6 (-1 should be printed as 00)
    /// - *Not used*
    // /// - *Fill ratio:* 0%
    // pub preferable_permaculture_zone: Option<i16>,

    // /// - When article was modified last time.
    // /// - Only for administration.
    // /// - Date value fetched from `PracticalPlants` page showing the last modification date of the plant.
    /// - *Not used*
    /// - *Scraper fill ratio:* 50.21%
    // pub article_last_modified_at: Option<NaiveDateTime>,

    /// - *Used* To diplay an icon in the search results.
    /// - USDA Hardiness Zone (without subranges).
    /// - Important information.
    /// - Fetched from `PracticalPlants` and Permapeople (merged with `usda_hardiness_zone` of Permapeople).
    /// - *Database fill ratio:* 58.25%
    /// - *Scraper fill ratio:* 58.08%
    pub hardiness_zone: Option<String>,

    /// - Shade tolerance of the plant, to be used together with shade.
    /// - *Used* in shade layer.
    /// - *For example* a plant that has "Full sun", should get a warning if placed in a shade.
    /// - **Fetched from*** `PracticalPlants` and Permapeople (merged with `sun` of `PracticalPlants`)
    /// - Full sun: full sun exposure
    /// - Partial sun/shade: about 3-6 hours of direct sunlight or moderately shaded throughout the day
    /// - Full shade: less than 3 hours of direct sunlight or almost no sunlight/no direct sunlight
    /// - *Database fill ratio:* 77.96%
    /// - *Scraper fill ratio:* 77.93%
    pub light_requirement: Option<Vec<Option<LightRequirement>>>,

    /// - *Used* in hydrology layer.
    /// - *Fetched from* `PracticalPlants` and Permapeople (merged with `water` of `PracticalPlants`).
    /// - water = completely aquatic;
    /// - wet = drowned, (often) flooded or in general very moist, e.g. swamp;
    /// - moist = humid, regular water supply, e.g. flat bed with humus;
    /// - well drained = dry, little water input.
    /// - *Database fill ratio:* 77.93%
    /// - *Scraper fill ratio:* 77.90%
    pub water_requirement: Option<Vec<Option<WaterRequirementEnum>>>,

    // /// - Only informational.
    // /// - *Fetched from* Permapeople (renamed from `propagation`)
    // /// - How to reproduce a plant: cuttings = cut pieces of wood; layering = let low branches reach the soil to root; Seed - direct sow = sow directly the seeds; division = split the rhizomes (roots) into pieces; Spores = plant reproduces via spores (e.g. ferns, funghi); seed - transplant = raise indoors from seed and transplant to outdoors later
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.73%
    // pub propagation_method: Option<Vec<Option<PropagationMethod>>>,

    // /// - Only informational.
    // /// - May be used in search functionality (low priority).
    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 27.55%
    // pub alternate_name: Option<String>,

    // /// - Only informational.
    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.02%
    //pub diseases: Option<String>,

    /// - *Used* so that an icon can be shown in the search results. Also displayed in the plant attributes.
    /// - Important information.
    /// - *Fetched from* Permapeople.
    /// - *Database fill ratio:* 55.02%
    /// - *Scraper fill ratio:* 54.98%
    pub edible: Option<bool>,

    /// - Only informational.
    /// - *Used* Displayed in the plant attributes.
    /// - *Fetched from* Permapeople.
    /// - which organ of the plant can be eaten, e.g. root, leaves.
    /// - *Database fill ratio:* 56.76%
    /// - *Scraper fill ratio:* 56.56%
    pub edible_parts: Option<Vec<Option<String>>>,

    // /// - Only informational.
    // /// - *Fetched from* Permapeople.
    // /// - Reinsaat: `Keimtemperatur` should be copied to `germination_temperature`
    // /// - Germination means that all conditions are right for a seed to start growing. Temperature is one essential factor.
    /// - *Not used*
    /// - *Scraper fill ratio:* 1.60%
    //pub germination_temperature: Option<String>,

    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 29.12%
    //pub introduced_into: Option<String>,

    // /// - Only informational.
    // /// - *Fetched from* Permapeople as \`layer\` and renamed.
    // /// - Habitus describes the shape of a plant.
    /// - *Not used*
    /// - *Scraper fill ratio:* 37.94%
    //pub habitus: Option<String>,

    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.07%
    //pub medicinal_parts: Option<String>,

    // /// - Only informational.
    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 63.83%
    //pub native_to: Option<String>,

    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 68.35%
    //pub plants_for_a_future: Option<String>,

    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 65.01%
    //pub plants_of_the_world_online_link: Option<String>,

    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 11.44%
    //pub plants_of_the_world_online_link_synonym: Option<String>,

    // /// - Only informational.
    // /// - *Fetched from* PracticalPlants as `pollinators` and merged with `pollination` of Permapeople.
    // /// - Pollination is the process that the pollen (male part) gets united with the pistil (female part), e.g. via bees, wind.
    /// - *Not used*
    /// - *Scraper fill ratio:* 38.03%
    //pub pollination: Option<String>,

    // /// - Only informational.
    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.11%
    //pub propagation_transplanting_en: Option<String>,

    // /// - Nearly empty.
    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.01%
    //pub resistance: Option<String>,

    // /// - Only informational.
    // /// - *Fetched from* Permapeople.
    // /// - Root type describes the shape of the roots.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.19%
    //pub root_type: Option<String>,

    // /// - Only informational.
    // /// - *Fetched from* Permapeople as `seed_planting_depth` and renamed.
    // /// - Reinsaat: `Sowing depth` should be copied to `seed_planting_depth_en`
    // /// - When sowing each plant has a specific value how deep the seeds should be covered with soil.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.06%
    //pub seed_planting_depth_en: Option<String>,

    // /// - Only informational.
    // /// - *Fetched from* Permapeople.
    // /// - expected average life span (in years) of a seed of a certain specie.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.51%
    //pub seed_viability: Option<String>,

    // /// - The final part of the URL of the plant on the Permapeople website.
    // /// - This field can be potentially used to construct the `external_url` field traversing through all the parents given by `parent_id`.
    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 70.78%
    //pub slug: Option<String>,

    /// - **Used**
    /// - How far a plant spreads (The 'width' of a plant) in cm
    /// - *Fetched from* Permapeople.
    /// - *Database fill ratio:* 78.38%
    /// - *Scraper fill ratio:* 78.36%
    pub spread: Option<i32>,

    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 1.69%
    //pub utility: Option<String>,

    /// - *Used* so that an icon can be shown in the search results. Also displayed in the plant attributes.
    /// - Important information.
    /// - *Fetched from* Permapeople.
    /// - specific warnings for eather human, animal or environmental well-being, e.g. toxic, invasive.
    /// - *Database fill ratio:* 8.77%
    /// - *Scraper fill ratio:* 8.69%
    pub warning: Option<String>,

    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.05%
    //pub when_to_plant_cuttings_en: Option<String>,

    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.06%
    //pub when_to_plant_division_en: Option<String>,

    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.15%
    //pub when_to_plant_transplant_en: Option<String>,

    // /// - Only informational.
    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.18%
    //pub when_to_sow_indoors_en: Option<String>,

    // /// - Only informational.
    // /// - *Fetched from* Permapeople as `when_to_sow_outdoors` and renamed.
    // /// - Reinsaat: `Sowing` or `Direct Sowing` or `Sowing outdoors` or `Sowing Direct Outdoors` should be copied to `sowing_outdoors_en`
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.27%
    //pub sowing_outdoors_en: Option<String>,

    // /// - Only informational.
    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.44%
    //pub when_to_start_indoors_weeks: Option<String>,

    // /// - Only informational.
    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.09%
    //pub when_to_start_outdoors_weeks: Option<String>,

    // /// - Only informational.
    // /// - *Fetched from* Permapeople.
    // /// - Stratification is the process that a seed must go through to get triggered for germination, e.g. by a certain threshold of minus degrees.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.02%
    //pub cold_stratification_temperature: Option<String>,

    // /// - Only informational.
    // /// - *Fetched from* Permapeople.
    // /// - Suggested change
    // /// - *Fetched from* Permapeople.
    // /// - Stratification is the process that a seed must go through to get triggered for germination, e.g. by a certain amount of time under cold temperatures.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.04%
    //pub cold_stratification_time: Option<String>,

    // /// - Only informational.
    // /// - *Fetched from* Permapeople.
    // /// - Reinsaat: `1st harvest` should be copied to `days_to_harvest`
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.73%
    //pub days_to_harvest: Option<String>,

    // /// - Needed for occupied space and in attributes
    // /// - *TODO:* should be number and then be used for calender
    //pub life_cycle_days: Option<int>,

    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.15%
    //pub habitat: Option<String>,

    // /// - One number means it is spacing between plants and rows. Two numbers means first is spacing between plants, second between rows.
    // /// - Only informational.
    // /// - *Fetched from* Permapeople as `spacing` and from Reinsaat as `Distances` and renamed.
    // /// - Reinsaat: `Distances` or `Spacing` should be copied to `spacing_en`
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.53%
    //pub spacing_en: Option<String>,

    // /// - *Fetched from* Permapeople as `wikipedia` and renamed.
    /// - *Not used*
    /// - *Scraper fill ratio:* 37.12%
    //pub wikipedia_url: Option<String>,

    // /// - Only informational.
    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.20%
    //pub days_to_maturity: Option<String>,

    // /// - Nearly empty.
    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.02%
    //pub pests: Option<String>,

    /// - Only for administration.
    /// - The version of the entry.
    /// - To be incremented after every relevant change.
    /// - *Fetched from* Permapeople.
    /// - *Database fill ratio:* 70.11%
    /// - *Scraper fill ratio:* 70.78%
    pub version: Option<i16>,

    // /// - Only informational.
    // /// - *Fetched from* Permapeople.
    // /// - Germination time describes the time (days, weeks, months) that a seed needs to germinate given the right conditions.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.41%
    //pub germination_time: Option<String>,

    // /// - The description of the entry.
    // /// - *Fetched from* Permapeople.
    /// - *Not used*
    /// - *Scraper fill ratio:* 3.73%
    //pub description: Option<String>,

    // /// - TODO: (not yet in database) add to attributes
    // /// - Short important information to shown.
    //pub info: Option<String>,

    // /// - *Fetched from* permapeople id of the parent entry pointing to the `external_id` column.
    /// - *Not used*
    /// - *Scraper fill ratio:* 1.54%
    //pub parent_id: Option<String>,

    // /// - Enum value indicating the source of the entry.
    /// - *Not used*
    /// - *Scraper fill ratio:* 79.18%
    // pub external_source: Option<ExternalSource>,

    // /// - The external id of the entry used in combination with the `external_source` column.
    /// - *Not used*
    /// - *Scraper fill ratio:* 70.78%
    //pub external_id: Option<String>,

    // /// - The external URL provided by the origin source.
    /// - *Not used*
    /// - *Scraper fill ratio:* 7.55%
    //pub external_url: Option<String>,

    // /// - Only informational.
    // /// - *Fetched from* PracticalPlants as `root_zone_tendency` and merged with root_depth of Permapeople.
    // /// - Root depth can be considered when planning polycultures, e.g. combining shallow roots with deep roots.
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.14%
    //pub root_depth: Option<String>,

    // /// - The article number `Artikelnummer` of the plant in the Reinsaat database.
    /// - *Not used*
    /// - *Scraper fill ratio:* 6.05%
    //pub external_article_number: Option<String>,

    // /// - `Portionsinhalt` should be called `external_portion_content`
    // /// - *Fetched from* Reinsaat.
    /// - *Not used*
    /// - *Scraper fill ratio:* 5.67%
    //pub external_portion_content: Option<String>,

    // /// - Only informational.
    // /// - *Fetched from* Reinsaat as \`Direktsaat\` and renamed.
    // /// - `Direktsaat` or `Aussaat` should be called `sowing_outdoors_de`
    /// - *Not used*
    /// - *Scraper fill ratio:* 0.82%
    //pub sowing_outdoors_de: Option<String>,

    /// - *Used* Displayed in the plant attributes.
    /// - String array of numbers representing a time period.
    /// - The year is divided into 24 periods of half a month each.
    /// - *For example* "\[8,9,10\]" means from the 2nd half of April to the 2nd half of May incl.
    /// - *Fetched from* Reinsaat
    /// - `Aussaat/ Pflanzung Freiland` should be called `sowing_outdoors`
    /// - *Database fill ratio:* 5.73%
    /// - *Scraper fill ratio:* 5.64%
    pub sowing_outdoors: Option<Vec<Option<i16>>>,

    /// - *Used* Displayed in the plant attributes.
    /// - String array of numbers representing a time period.
    /// - The year is divided into 24 periods of half a month each.
    /// - *For example* "\[8,9,10\]" means from the 2nd half of April to the 2nd half of May incl.
    /// - `Ernte` should be called `harvest_time`
    /// - *Fetched from* Reinsaat
    /// - *Database fill ratio:* 5.58%
    /// - *Scraper fill ratio:* 4.97%
    pub harvest_time: Option<Vec<Option<i16>>>,

    /*
    /// - Only informational.
    /// - *Fetched from* Reinsaat.
    /// - `Abstände` should be called `spacing_de`
    /// - *Not used*
    /// - *Scraper fill ratio:* 2.37%
    //pub spacing_de: Option<String>,

    /// - Only informational.
    /// - *Fetched from* Reinsaat.
    /// - *Not used*
    /// - `Saatgutbedarf` should be called `required_quantity_of_seeds_de`
    /// - *Scraper fill ratio:* 1.29%
    //pub required_quantity_of_seeds_de: Option<String>,

    /// - Only informational.
    /// - *Fetched from* Reinsaat.
    /// - `Required quantity of seeds` should be called `required_quantity_of_seeds_en`
    /// - *Not used*
    /// - *Scraper fill ratio:* 2.77%
    //pub required_quantity_of_seeds_en: Option<String>,

    /// - Only informational.
    /// - *Fetched from* Reinsaat.
    /// - `Saattiefe` should be called `seed_planting_depth_de`
    /// - When sowing, each plant has a specific value how deep the seeds should be covered with soil.
    /// - *Not used*
    /// - *Scraper fill ratio:* 2.22%
    //pub seed_planting_depth_de: Option<String>,

    /// - German version of thousand grain weight (German: Tausendkornmasse)
    /// - Only informational.
    /// - *Fetched from* Reinsaat.
    /// - Called `Tausendkornmasse` in Reinsaat
    /// - *Not used*
    /// - *Scraper fill ratio:* 2.12%
    //pub seed_weight_1000_de: Option<String>,

    /// - English version of thousand grain weight (German: Tausendkornmasse)
    /// - Only informational.
    /// - *Fetched from* Reinsaat.
    /// - Called `Thousand seeds mass` in Reinsaat
    /// - *Not used*
    /// - *Scraper fill ratio:* 2.17%
    //pub seed_weight_1000_en: Option<String>,

    /// - Number for thousand grain weight (German: Tausendkornmasse)
    /// - used in `doc/usecases/buy_seeds.md` to calculate seed weight based on number of plants.
    /// - *Fetched from* Permapeople as `1000_seed_weight_g` and renamed.
    /// - *TODO:* merge with data from reinsaat: `Tausendkorngewicht (TKG)` should be copied to `seed_weight` (remove ` g`)
    /// - *Not used*
    /// - *Scraper fill ratio:* 2.90%
    // pub seed_weight_1000: Option<f64>,

    /// - Only informational.
    /// - *Fetched from* Reinsaat.
    /// - `Suitable for professional cultivation` should be called `machine_cultivation_possible`
    /// - *Not used*
    /// - *Scraper fill ratio:* 7.55%
    //pub machine_cultivation_possible: Option<bool>,

    /// - *Fetched from* Reinsaat.
    /// - could be used for plant search and informational.
    /// - `subcategory` from Reinsaat should be copied to `edible_uses_de` and `edible_uses_en` respectively (DE and EN version)
    /// - *Not used*
    /// - *Scraper fill ratio:* 5.10%
    //pub edible_uses_de: Option<String>,
    */
    /// - Hierarchy fields
    /// - Either *Fetched from* `PracticalPlants` and Permapeople
    /// - Or determined from the unique name
    /// - Or set by scraper overrides
    /// - *Database fill ratio:* 100.00%
    /// - *Scraper fill ratio:* 100.00%
    pub rank: TaxonomicRank,
    pub family: Option<i64>,
    pub genus: Option<i64>,
    pub species: Option<i64>,
    pub variety: Option<i64>,

    /// - The path to the icon of the plant.
    /// - *Database fill ratio:* 2.32%
    /// - *Scraper fill ratio:* 2.12%
    pub icon_path: Option<String>,
}

/// The `PlantsAndFamily` entity used for a self join.
#[derive(Queryable)]
pub struct PlantsAndFamily {
    /// The plants entity
    pub plant: Plants,
    /// The plants family name
    pub family_name: Option<String>,
}
/// The `Seed` entity.
#[derive(Identifiable, Queryable)]
#[diesel(table_name = seeds)]
pub struct Seed {
    /// The record id of the seed.
    pub id: i64,
    /// An additional name for the seed.
    pub name: String,
    /// When the seeds were harvested.
    pub harvest_year: i16,
    /// When the seeds should be used by.
    pub use_by: Option<NaiveDate>,
    /// Where the seeds came from.
    pub origin: Option<String>,
    /// What the seeds taste like.
    pub taste: Option<String>,
    /// The yield of the seeds.
    pub yield_: Option<String>,
    /// How many seeds there are.
    pub quantity: Quantity,
    /// The quality of the seeds.
    pub quality: Option<Quality>,
    /// How much the seeds cost.
    pub price: Option<i16>,
    /// How many generations the seeds have been grown.
    pub generation: Option<i16>,
    /// Notes about the seeds.
    pub notes: Option<String>,
    /// The id of the plant this seed belongs to.
    pub plant_id: i64,
    /// The id of the creator of the seed.
    pub created_by: Uuid,
    /// Timestamp indicating when the seed was archived.
    /// Empty if the seed was not archived.
    pub archived_at: Option<NaiveDateTime>,
}

/// The `NewSeed` entity.
#[allow(clippy::missing_docs_in_private_items)] // TODO: See #97.
#[derive(Insertable)]
#[diesel(table_name = seeds)]
pub struct NewSeed {
    pub name: String,
    pub plant_id: i64,
    pub harvest_year: i16,
    pub use_by: Option<NaiveDate>,
    pub origin: Option<String>,
    pub taste: Option<String>,
    pub yield_: Option<String>,
    pub quantity: Quantity,
    pub quality: Option<Quality>,
    pub price: Option<i16>,
    pub generation: Option<i16>,
    pub notes: Option<String>,
    pub created_by: Uuid,
}

/// The `Map` entity.
#[derive(Identifiable, Queryable)]
#[diesel(table_name = maps)]
pub struct Map {
    /// The id of the map.
    pub id: i64,
    /// The name of the map.
    pub name: String,
    /// The date the map is supposed to be deleted.
    pub deletion_date: Option<NaiveDate>,
    /// The date the last time the map view was opened by any user.
    pub last_visit: Option<NaiveDate>,
    /// A flag indicating if this map is marked for deletion.
    pub is_inactive: bool,
    /// The zoom factor of the map.
    pub zoom_factor: i16,
    /// An enum indicating if this map is private or not.
    pub privacy: PrivacyAccessControl,
    /// The description of the map.
    pub description: Option<String>,
    /// The location of the map as a latitude/longitude point.
    pub location: Option<Point>,
    /// The id of the creator of the map.
    pub created_by: Uuid,
    /// The geometry of the map.
    pub geometry: Polygon<Point>,
    /// When the map was created.
    pub created_at: NaiveDateTime,
    /// When a map was last modified, e.g., by modifying plantings.
    pub modified_at: NaiveDateTime,
    /// By whom the map was last modified.
    pub modified_by: Uuid,
}

/// The `NewMap` entity.
#[derive(Insertable)]
#[diesel(table_name = maps)]
pub struct NewMap {
    /// The name of the map.
    pub name: String,
    /// For a new map the same as `created_by`.
    pub deletion_date: Option<NaiveDate>,
    /// The date the last time the map view was opened by any user.
    pub last_visit: Option<NaiveDate>,
    /// A flag indicating if this map is marked for deletion.
    pub is_inactive: bool,
    /// The zoom factor of the map.
    pub zoom_factor: i16,
    /// An enum indicating if this map is private or not.
    pub privacy: PrivacyAccessControl,
    /// The description of the map.
    pub description: Option<String>,
    /// The location of the map as a latitude/longitude point.
    pub location: Option<Point>,
    /// The id of the creator of the map.
    pub created_by: Uuid,
    /// The geometry of the map.
    pub geometry: Polygon<Point>,
    /// The user who last modified the planting.
    pub modified_by: Uuid,
}

/// The `UpdateMap` entity.
#[derive(AsChangeset)]
#[diesel(table_name = maps)]
pub struct UpdateMap {
    /// The name of the map.
    pub name: Option<String>,
    /// An enum indicating if this map is private or not.
    pub privacy: Option<PrivacyAccessControl>,
    /// The description of the map.
    pub description: Option<String>,
    /// The location of the map as a latitude/longitude point.
    pub location: Option<Point>,
}

/// The `UpdateMapGeometry` entity.
#[derive(AsChangeset)]
#[diesel(table_name = maps)]
pub struct UpdateMapGeometry {
    /// New Map Bounds
    pub geometry: Polygon<Point>,
}

/// The `GuidedTourProgress` entity.
#[derive(Identifiable, Queryable)]
#[diesel(primary_key(user_id, step_key), table_name = guided_tour_progress)]
pub struct GuidedTourProgress {
    /// ID of the user who completed the tour step
    pub user_id: Uuid,
    /// Human readable id of the step the user completed
    pub step_key: String,
    /// Time of completion
    pub completed_at: NaiveDateTime,
}

/// Insertable for `guided_tour_progress` (`completed_at` uses DB default).
#[derive(Insertable)]
#[diesel(table_name = guided_tour_progress)]
pub struct NewGuidedTourProgress {
    /// ID of the user who is completing the step
    pub user_id: Uuid,
    /// Human readable id of the step the user is completing
    pub step_key: String,
}

/// The `GuidedTourState` entity.
#[derive(Insertable, Identifiable, Queryable)]
#[diesel(primary_key(user_id), table_name = guided_tour_states)]
pub struct GuidedTourState {
    /// ID of the user
    pub user_id: Uuid,
    /// When the tour was paused
    pub paused_at: Option<NaiveDateTime>,
    /// How often the user has paused the tour already
    pub pause_count: i32,
}

/// The `ApplicationSetting` entity.
#[derive(Identifiable, Queryable)]
#[diesel(primary_key(id), table_name = application_settings)]
pub struct ApplicationSetting {
    /// The id of the setting
    pub id: i32,
    /// The unique key of the setting
    pub key: String,
    /// The value of the setting
    pub value: String,
}

/// The [`MapCollaborator`] entity.
#[derive(Insertable, Identifiable, Queryable)]
#[diesel(primary_key(map_id, user_id), table_name = map_collaborators)]
pub struct MapCollaborator {
    pub map_id: i64,
    pub user_id: Uuid,
    pub created_at: NaiveDateTime,
}