api.logbook

Description

Stores generated logbook

Columns

Name	Type	Default	Nullable	Parents	Comment
_from	text		true		Name of the location where the log started, usually a moorage name
_from_lat	double precision		true
_from_lng	double precision		true
_from_moorage_id	integer		true	api.moorages	Link api.moorages with api.logbook via FOREIGN KEY and REFERENCES
_from_time	timestamp with time zone		false
_to	text		true		Name of the location where the log ended, usually a moorage name
_to_lat	double precision		true
_to_lng	double precision		true
_to_moorage_id	integer		true	api.moorages	Link api.moorages with api.logbook via FOREIGN KEY and REFERENCES
_to_time	timestamp with time zone		true
active	boolean	false	true
avg_speed	double precision		true		avg speed in knots
distance	numeric		true		Distance in Nautical Miles converted mobilitydb meters to NM
duration	interval		true		Duration in ISO 8601 format
extra	jsonb		true		Computed SignalK metrics such as runtime, current level, etc.
id	integer		false
max_speed	double precision		true		max speed in knots
max_wind_speed	double precision		true		true wind speed converted in knots, m/s from signalk plugin
name	text		true
notes	text		true
trip	tgeogpoint		true		MobilityDB trajectory, speed in m/s, distance in meters
trip_awa	tfloat		true		AWA (Apparent Wind Angle) in degrees converted from radians by signalk plugin
trip_aws	tfloat		true		AWS (Apparent Wind Speed), windSpeedApparent in knots converted by signalk plugin
trip_batt_charge	tfloat		true		Battery Charge
trip_batt_voltage	tfloat		true		Battery Voltage
trip_cog	tfloat		true		COG - Course Over Ground True in degrees converted from radians by signalk plugin
trip_depth	tfloat		true		Depth in meters, raw from signalk plugin
trip_heading	tfloat		true		Heading True in degrees converted from radians, raw from signalk plugin
trip_hum_out	tfloat		true		Humidity outside
trip_notes	ttext		true
trip_pres_out	tfloat		true		Pressure outside
trip_sog	tfloat		true		SOG - Speed Over Ground in knots converted by signalk plugin
trip_solar_power	tfloat		true		solar powerPanel
trip_solar_voltage	tfloat		true		solar voltage
trip_status	ttext		true
trip_tank_level	tfloat		true		Tank currentLevel
trip_temp_out	tfloat		true		Temperature outside in Kelvin, raw from signalk plugin
trip_temp_water	tfloat		true		Temperature water in Kelvin, raw from signalk plugin
trip_twd	tfloat		true		TWD - True Wind Direction in degrees converted from radians, raw from signalk plugin
trip_tws	tfloat		true		TWS - True Wind Speed in knots converted from m/s, raw from signalk plugin
user_data	jsonb	‘{}’::jsonb	true		User-defined data Log-specific data including actual tags, observations, images and custom fields
vessel_id	text		false	api.metadata	Unique identifier for the vessel associated with the api.metadata entry

Constraints

Name	Type	Definition	Comment
logbook__from_moorage_id_fkey	FOREIGN KEY	FOREIGN KEY (_from_moorage_id) REFERENCES api.moorages(id) ON DELETE RESTRICT
logbook__from_time_not_null	n	NOT NULL _from_time
logbook__to_moorage_id_fkey	FOREIGN KEY	FOREIGN KEY (_to_moorage_id) REFERENCES api.moorages(id) ON DELETE RESTRICT
logbook_id_not_null	n	NOT NULL id
logbook_pkey	PRIMARY KEY	PRIMARY KEY (id)
logbook_vessel_id_fkey	FOREIGN KEY	FOREIGN KEY (vessel_id) REFERENCES api.metadata(vessel_id) ON DELETE RESTRICT	Link api.stays with api.metadata via vessel_id using FOREIGN KEY and REFERENCES
logbook_vessel_id_not_null	n	NOT NULL vessel_id

Indexes

Name	Definition
logbook_active_idx	CREATE INDEX logbook_active_idx ON api.logbook USING btree (active)
logbook_extra_idx	CREATE INDEX logbook_extra_idx ON api.logbook USING gin (extra)
logbook_from_moorage_id_idx	CREATE INDEX logbook_from_moorage_id_idx ON api.logbook USING btree (_from_moorage_id)
logbook_from_moorage_time_idx	CREATE INDEX logbook_from_moorage_time_idx ON api.logbook USING btree (_from_moorage_id, _from_time DESC) WHERE (_from_moorage_id IS NOT NULL)
logbook_from_time_idx	CREATE INDEX logbook_from_time_idx ON api.logbook USING btree (_from_time)
logbook_log_view_idx	CREATE INDEX logbook_log_view_idx ON api.logbook USING btree (_from_time DESC) WHERE ((_to_time IS NOT NULL) AND (trip IS NOT NULL))
logbook_logs_view_idx	CREATE INDEX logbook_logs_view_idx ON api.logbook USING btree (_from_time DESC) WHERE ((_to_time IS NOT NULL) AND (name IS NOT NULL))
logbook_pkey	CREATE UNIQUE INDEX logbook_pkey ON api.logbook USING btree (id)
logbook_to_moorage_id_idx	CREATE INDEX logbook_to_moorage_id_idx ON api.logbook USING btree (_to_moorage_id)
logbook_to_moorage_time_idx	CREATE INDEX logbook_to_moorage_time_idx ON api.logbook USING btree (_to_moorage_id, _to_time DESC) WHERE (_to_moorage_id IS NOT NULL)
logbook_to_time_idx	CREATE INDEX logbook_to_time_idx ON api.logbook USING btree (_to_time)
logbook_trip_idx	CREATE INDEX logbook_trip_idx ON api.logbook USING gist (trip)
logbook_user_data_idx	CREATE INDEX logbook_user_data_idx ON api.logbook USING gin (user_data)
logbook_vessel_active_idx	CREATE INDEX logbook_vessel_active_idx ON api.logbook USING btree (vessel_id, active, _from_time DESC) WHERE (active = true)
logbook_vessel_id_idx	CREATE INDEX logbook_vessel_id_idx ON api.logbook USING btree (vessel_id)
logbook_vessel_time_idx	CREATE INDEX logbook_vessel_time_idx ON api.logbook USING btree (vessel_id, _from_time DESC, _to_time DESC) INCLUDE (name, distance, duration)

Triggers

Name	Definition	Comment
logbook_delete_trigger	CREATE TRIGGER logbook_delete_trigger BEFORE DELETE ON api.logbook FOR EACH ROW EXECUTE FUNCTION logbook_delete_trigger_fn()	BEFORE DELETE ON api.logbook run function public.logbook_delete_trigger_fn to delete reference and logbook_ext need to deleted.
logbook_update_user_data_trigger	CREATE TRIGGER logbook_update_user_data_trigger BEFORE UPDATE ON api.logbook FOR EACH ROW EXECUTE FUNCTION update_tbl_userdata_added_at_trigger_fn()	BEFORE UPDATE ON api.logbook run function public.update_tbl_userdata_added_at_trigger_fn to update the user_data field with current date in ISO format when polar or images change

Relations

erDiagram

"api.logbook" }o--o| "api.moorages" : "FOREIGN KEY (_from_moorage_id) REFERENCES api.moorages(id) ON DELETE RESTRICT"
"api.logbook" }o--o| "api.moorages" : "FOREIGN KEY (_to_moorage_id) REFERENCES api.moorages(id) ON DELETE RESTRICT"
"api.stays" }o--o| "api.moorages" : "FOREIGN KEY (moorage_id) REFERENCES api.moorages(id) ON DELETE RESTRICT"
"api.moorages" }o--o| "api.stays_at" : "FOREIGN KEY (stay_code) REFERENCES api.stays_at(stay_code) ON DELETE RESTRICT"
"api.moorages" }o--|| "api.metadata" : "FOREIGN KEY (vessel_id) REFERENCES api.metadata(vessel_id) ON DELETE RESTRICT"
"api.logbook" }o--|| "api.metadata" : "FOREIGN KEY (vessel_id) REFERENCES api.metadata(vessel_id) ON DELETE RESTRICT"
"api.metadata" |o--|| "auth.vessels" : "FOREIGN KEY (vessel_id) REFERENCES auth.vessels(vessel_id) ON DELETE RESTRICT"
"api.metrics" }o--|| "api.metadata" : "FOREIGN KEY (vessel_id) REFERENCES api.metadata(vessel_id) ON DELETE RESTRICT"
"api.stays" }o--|| "api.metadata" : "FOREIGN KEY (vessel_id) REFERENCES api.metadata(vessel_id) ON DELETE RESTRICT"

"api.logbook" {
  text _from "Name of the location where the log started, usually a moorage name"
  double_precision _from_lat ""
  double_precision _from_lng ""
  integer _from_moorage_id FK "Link api.moorages with api.logbook via FOREIGN KEY and REFERENCES"
  timestamp_with_time_zone _from_time ""
  text _to "Name of the location where the log ended, usually a moorage name"
  double_precision _to_lat ""
  double_precision _to_lng ""
  integer _to_moorage_id FK "Link api.moorages with api.logbook via FOREIGN KEY and REFERENCES"
  timestamp_with_time_zone _to_time ""
  boolean active ""
  double_precision avg_speed "avg speed in knots"
  numeric distance "Distance in Nautical Miles converted mobilitydb meters to NM"
  interval duration "Duration in ISO 8601 format"
  jsonb extra "Computed SignalK metrics such as runtime, current level, etc."
  integer id ""
  double_precision max_speed "max speed in knots"
  double_precision max_wind_speed "true wind speed converted in knots, m/s from signalk plugin"
  text name ""
  text notes ""
  tgeogpoint trip "MobilityDB trajectory, speed in m/s, distance in meters"
  tfloat trip_awa "AWA (Apparent Wind Angle) in degrees converted from radians by signalk plugin"
  tfloat trip_aws "AWS (Apparent Wind Speed), windSpeedApparent in knots converted by signalk plugin"
  tfloat trip_batt_charge "Battery Charge"
  tfloat trip_batt_voltage "Battery Voltage"
  tfloat trip_cog "COG - Course Over Ground True in degrees converted from radians by signalk plugin"
  tfloat trip_depth "Depth in meters, raw from signalk plugin"
  tfloat trip_heading "Heading True in degrees converted from radians, raw from signalk plugin"
  tfloat trip_hum_out "Humidity outside"
  ttext trip_notes ""
  tfloat trip_pres_out "Pressure outside"
  tfloat trip_sog "SOG - Speed Over Ground in knots converted by signalk plugin"
  tfloat trip_solar_power "solar powerPanel"
  tfloat trip_solar_voltage "solar voltage"
  ttext trip_status ""
  tfloat trip_tank_level "Tank currentLevel"
  tfloat trip_temp_out "Temperature outside in Kelvin, raw from signalk plugin"
  tfloat trip_temp_water "Temperature water in Kelvin, raw from signalk plugin"
  tfloat trip_twd "TWD - True Wind Direction in degrees converted from radians, raw from signalk plugin"
  tfloat trip_tws "TWS - True Wind Speed in knots converted from m/s, raw from signalk plugin"
  jsonb user_data "User-defined data Log-specific data including actual tags, observations, images and custom fields"
  text vessel_id FK "Unique identifier for the vessel associated with the api.metadata entry"
}
"api.moorages" {
  text country ""
  geography_Point_4326_ geog "postgis geography type default SRID 4326 Unit: degres"
  boolean home_flag ""
  integer id ""
  double_precision latitude ""
  double_precision longitude ""
  text name ""
  jsonb nominatim "Output of the nominatim reverse geocoding service, see https://nominatim.org/release-docs/develop/api/Reverse/"
  text notes ""
  jsonb overpass "Output of the overpass API, see https://wiki.openstreetmap.org/wiki/Overpass_API"
  integer stay_code FK "Link api.stays_at with api.moorages via FOREIGN KEY and REFERENCES"
  jsonb user_data "User-defined data Mooring-specific data including images and custom fields"
  text vessel_id FK "Unique identifier for the vessel associated with the api.metadata entry"
}
"api.stays" {
  boolean active ""
  timestamp_with_time_zone arrived ""
  timestamp_with_time_zone departed ""
  interval duration "Best to use standard ISO 8601"
  geography_Point_4326_ geog "postgis geography type default SRID 4326 Unit: degres"
  integer id ""
  double_precision latitude ""
  double_precision longitude ""
  integer moorage_id FK "Link api.moorages with api.stays via FOREIGN KEY and REFERENCES"
  text name ""
  text notes ""
  integer stay_code FK "Link api.stays_at with api.stays via FOREIGN KEY and REFERENCES"
  jsonb user_data "User-defined data Stay-specific data including images and custom fields"
  text vessel_id FK "Unique identifier for the vessel associated with the api.metadata entry"
}
"api.stays_at" {
  text description ""
  integer stay_code ""
}
"api.metadata" {
  boolean active "trigger monitor online/offline"
  jsonb available_keys "Signalk paths with unit for custom mapping"
  double_precision beam ""
  jsonb configuration "User-defined Signalk path mapping for metrics"
  timestamp_with_time_zone created_at ""
  double_precision height ""
  text ip "Store vessel ip address"
  double_precision length ""
  text mmsi "Maritime Mobile Service Identity (MMSI) number associated with the vessel, link to public.mid"
  text name ""
  text platform ""
  text plugin_version ""
  numeric ship_type "Type of ship associated with the vessel, link to public.aistypes"
  text signalk_version ""
  timestamp_with_time_zone time ""
  timestamp_with_time_zone updated_at ""
  jsonb user_data "User-defined data including vessel polar (theoretical performance), make/model, and preferences"
  text vessel_id FK "Link auth.vessels with api.metadata via FOREIGN KEY and REFERENCES"
}
"auth.vessels" {
  timestamp_with_time_zone created_at ""
  numeric mmsi "MMSI can be optional but if present must be a valid one and unique but must be in numeric range between 100000000 and 800000000"
  text name ""
  citext owner_email FK ""
  name role ""
  timestamp_with_time_zone updated_at ""
  text vessel_id ""
}
"api.metrics" {
  double_precision anglespeedapparent ""
  text client_id "Deprecated client_id to be removed"
  double_precision courseovergroundtrue ""
  double_precision latitude "With CONSTRAINT but allow NULL value to be ignored silently by trigger"
  double_precision longitude "With CONSTRAINT but allow NULL value to be ignored silently by trigger"
  jsonb metrics ""
  double_precision speedoverground ""
  text status ""
  timestamp_with_time_zone time ""
  text vessel_id FK "Unique identifier for the vessel associated with the api.metadata entry"
  double_precision windspeedapparent ""
}

Generated by tbls

Keyboard shortcuts

Postgsail Documentation

api.logbook

Description

Columns

Constraints

Indexes

Triggers

Relations