DB Model 2014

NOTE: THIS PAGE IS STILL ACTIVELY BEING EDITED. Many things may and will change in the next days. Please visit it regularly to have the latest information.

From the users' perspective, the database is split into two schemas: admin and gps. The gps schema is meant for data that should be readily available for users, and that they may edit via the services (software tools) offered to that effect. The admin schema is meant to host data only accessible for the administration users of e-Ecology.

The following tables are available

Tracking data

gps.ee_track_session (table)

Each row represents a track session. That means: a coupling between a tracker and a bird for a given period of time. Therefore, it is mandatory for projects to supply this piece of metadata before they can see any tracking data related to a tracker they own.

In order to create a track session, the project must create first an entry in the system for the bird that they are attaching the tracker to, and this is the way for the UvA-BiTS community to make sense of the tracking data that we are receiving. This is why providing the metadata is so important.

By editing the start and end dates, administrators of the project that this track session belongs to, can delimit (and therefore, establish) when the coupling makes sense (or is to be understood as useful).

Whenever a tracker is attached to a bird, a track session must be started to indicate that the tracking data that is received is already live data. If the tracker is separated from the bird, the tracking data ceases to make sense, so the track session's end date should be set to denote it has ended. New track sessions can be started if the tracker is re-attached to a bird (possibly the same as before, or maybe a different one) afterwards.

COLUMN_NAME	TYPE_NAME	IS_NULLABLE	DESCRIPTION
id	int8	NO	Unique identifier. Primary key.
end_date	timestamp	NO	Date at which the track session is not relevant any more
operated_date	timestamp	NO	Recording of the last time the row was edited
remarks	text	YES	Free text for comments
start_date	timestamp	NO	Date before which the track session is not relevant
start_latitude	numeric(11,8)	NO	Latitude where the bird was tagged
start_longitude	numeric(11,8)	NO	Longitude where the bird was tagged
version	int4	YES	Optimistic locking field. Ignore it as a user.
device	int8	NO	Reference to the tracker
individual	int8	NO	Reference to the individual
operator_user	int8	NO	Reference to the user who last edited the row
project	int8	NO	Reference to the project this track session belongs to

gps.ee_track_session_limited (view)

Shows information of the track sessions that your memberships allow you to see.

COLUMN_NAME	TYPE_NAME	IS_NULLABLE	DESCRIPTION
track_session_id	int8	NO	Unique identifier of the track session.
key_name	varchar	NO	The project that the track session belongs to.
device_info_serial	int8	NO	Tracker serial number of the tracker this track session involves.
ring_number	varchar	NO	Ring number of the bird that this track session involves.
track_session_start_date	timestamp	NO	Date before which the track session is not relevant
track_session_end_date	timestamp	NO	Date at which the track session is not relevant any more
remarks	text	YES	Free text for comments
start_latitude	numeric(11,8)	NO	Latitude where the bird was tagged
start_longitude	numeric(11,8)	NO	Longitude where the bird was tagged
project_id	int8	NO	Reference to the project this track session belongs to. Included just to enable joins.
tracker_id	int8	NO	Reference to the tracker this track session involves. Included just to enable joins.
individual_id	int8	NO	Reference to the individual this track session involves. Included just to enable joins.

Other data

admin. ee_user

Each row represents a user.

COLUMN_NAME	TYPE_NAME	IS_NULLABLE	DESCRIPTION
id	int8	NO	Unique identifier. Primary key
address	varchar	YES	String for postal address
email	varchar	NO	e-mail address
encrypted_password	varchar	NO	Encrypted password
login_name	varchar	NO	Login name
mobile_phone	varchar	YES	String for mobile phone number
name	varchar	NO	(first) name
surname	varchar	NO	Surname
version	int4	YES	Optimistic locking field. Ignore it as a user.
operator_user	int8	YES	Id of the user who last edited this user's data.

admin. ee_project

Each row represents a project.

COLUMN_NAME	TYPE_NAME	IS_NULLABLE	DESCRIPTION
id	int8	NO	Unique identifier. Primary key
description	text	YES	String for free description. Updatable by the user.
end_date	timestamp	NO	Date at which the project is not relevant any more
key_name	varchar	NO	Unique key name, of the form species_place
lft	int8	NO	"Modified preorder tree traversal" field. Ignore it as a user.
rgt	int8	NO	"Modified preorder tree traversal" field. Ignore it as a user.
start_date	timestamp	NO	Project start date
station_name	varchar	NO	Where the receiving station is
version	int4	YES	Optimistic locking field. Ignore it as a user.
operator_user	int8	NO	Reference to the user who last edited the project
parent	int8	YES	Reference to the parent project. Only the root project has no parent.

admin. ee_membership

Each row represents the fact that a user has a given role in a given project for a given period of time.

COLUMN_NAME	TYPE_NAME	IS_NULLABLE	DESCRIPTION
id	int8	NO	Unique identifier. Primary key.
comments	text	YES	Free text for comments
label	text	YES	Labels that Willem wants to have for people in projects
role	varchar	NO	Role that the user holds during this period
status	varchar	NO	Status that the row holds during that period. Look at the attached file to know the allowed transitions.
version	int4	YES	Optimistic locking field. Ignore it as a user.
member_user	int8	NO	Reference to the user that this membership applies to
operated_date	timestamp	NO	Date that the row was last modified
operator_user	int8	NO	Reference to the user who last edited this row
project	int8	NO	Reference to the project that this membership applies to

gps. ee_species

Each row represents a species.

COLUMN_NAME	TYPE_NAME	IS_NULLABLE	DESCRIPTION
id	int8	NO	Unique identifier. Primary key.
abbr	varchar	NO	Abbreviation of the species. Should be unique. Used as the prefix of the project's key name.
english_name	varchar	YES	Name in English
latin_name	varchar	NO	Name in Latin
version	int4	YES	Optimistic locking field. Ignore it as a user.

gps. ee_individual

Each row represents a bird.

COLUMN_NAME	TYPE_NAME	IS_NULLABLE	DESCRIPTION
id	int8	NO	Unique identifier. Primary key.
colour_ring	varchar	YES	String for ring colour
end_date	timestamp	NO	Date at which the bird is no longer relevant
mass	numeric(5,0)	YES	Mass (ideally, in grams)
operated_date	timestamp	NO	Recording of the last time the row was edited
remarks	text	YES	Text for user remarks
ring_number	varchar	NO	Ring number
sex	varchar	NO	Sex
start_date	timestamp	NO	Date before which the bird is not relevant
version	int4	YES	Optimistic locking field. Ignore it as user.
operator_user	int8	NO	Reference to the user who last edited the row
species	int8	NO	Reference to the species

gps. ee_tracker

Each row represents a tracker.

COLUMN_NAME	TYPE_NAME	IS_NULLABLE	DESCRIPTION
id	int8	NO	Unique identifier. Primary key.
device_info_serial	int8	NO	Serial number of the product
end_date	timestamp	NO	Date at which the device is not relevant any more
firmware_version	varchar	YES	String for firmware version
mass	numeric(4,2)	YES	Mass (in grams)
start_date	timestamp	NO	Date before which the device is not relevant
version	int4	YES	Optimistic locking field. Ignore it as a user.
x_o	numeric(30,6)	YES	Accelerometer calibration
x_s	numeric(30,6)	YES	Accelerometer calibration
y_o	numeric(30,6)	YES	Accelerometer calibration
y_s	numeric(30,6)	YES	Accelerometer calibration
z_o	numeric(30,6)	YES	Accelerometer calibration
z_s	numeric(30,6)	YES	Accelerometer calibration

admin. ee_individual_ownership

Each row represents the fact that an individual belongs to a project within a specified time period.

COLUMN_NAME	TYPE_NAME	IS_NULLABLE	DESCRIPTION
id	int8	NO	Unique identifier. Primary key.
end_date	timestamp	NO	Date at which the individual ceases to belong to the project
operated_date	timestamp	NO	Recording of the last time the row was edited
start_date	timestamp	NO	Date at which the project begins to own the individual
version	int4	YES	Optimistic locking field. Ignore it as a user.
individual	int8	NO	Reference to the individual
operator_user	int8	NO	Reference to the user who last edited the row
project	int8	NO	Reference to the project this individual belongs to

admin. ee_tracker_ownership

Each row represents the fact that a tracker belongs to a project within a specified time period.

COLUMN_NAME	TYPE_NAME	IS_NULLABLE	DESCRIPTION
id	int8	NO	Unique identifier. Primary key.
end_date	timestamp	NO	Date at which the tracker ceases to belong to the project
operated_date	timestamp	NO	Recording of the last time the row was edited
start_date	timestamp	NO	Date at which the project begins to own the tracker
version	int4	YES	Optimistic locking field. Ignore it as a user.
device	int8	NO	Reference to the tracker
operator_user	int8	NO	Reference to the user who last edited the row
project	int8	NO	Reference to the project this tracker belongs to

gps. ee_tracker_sharing

Each row represents the fact that a tracker's information within a specified period, can be accessed by users belonging to another project.

COLUMN_NAME	TYPE_NAME	IS_NULLABLE	DESCRIPTION
id	int8	NO	Unique identifier. Primary key.
end_date	timestamp	NO	Date at which the tracker information ceases to be available to the receiving project
operated_date	timestamp	NO	Recording of the last time the row was edited
start_date	timestamp	NO	Date at which the tracker information becomes available to the receiving project
version	int4	YES	Optimistic locking field. Ignore it as a user.
operator_user	int8	NO	Reference to the user who last edited the row
project	int8	NO	Reference to the project that receives access to the tracker information
tracker_ownership	int8	NO	Reference to the tracker ownership by virtue of which, the tracker information is shared