Date | 2010-03-01 |
Version | 5 |
This document provides an overview of the Blacknest Data System (BDS) Database Schema.
The BDS Database holds information on all of the Seismic data and associated metadata. The database will be implemented as a MySQL database. Generally the database is not directly accessed. It is normally only accessed by the BDS Data Engine in response to API requests.
Name | Type | Attributes | Description |
---|---|---|---|
id | Integer | unique, not_null, auto_increment | Unique ID for this entry |
name | String | Primary | The parameter name |
value | String | The parameters value |
|
description | String | A description | |
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, |
DateTime this record was last updated |
Name | Type | Attributes | Description |
---|---|---|---|
id | String | primary, unique, auto_increment | Unique ID for this entry |
group | String | primary | The group name |
description | String | The groups description | |
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, |
DateTime this record was last updated |
Name | Type | Attributes | Description |
---|---|---|---|
id | Integer | primary, unique, auto_increment | Unique ID for this entry. (Used as the userId) |
user | String | primary | The users login ID |
password | String | The users login password (Encrypted) | |
name | String | The users full name | |
groups | String | The list of groups the user belongs to. (comma separated list of names) | |
String | The users email address | ||
telephone | String | The users telephone number | |
address | String | The users postal number | |
enabled | Boolean | If this user is enabled | |
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on updateCURRENT_TIMESTAMP |
DateTime this record was last updated |
Name | Type | Attributes | Description |
---|---|---|---|
id | Integer | primary, unique, auto_increment | Unique ID for this entry. (Used as the userId) |
group | String | A group that can access this data | |
startTime | String | The Start time | |
endTime | String | The End time | |
network | String | The Network name | |
station | String | The Station/Array name | |
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, |
DateTime this record was last updated |
Name | Type | Attributes | Description |
---|---|---|---|
id | Integer | unique, not_null, auto_increment | Unique ID for this entry |
network | String | Primary | The Network name |
description | String | The Network description | |
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, |
DateTime this record was last updated |
Name | Type | Attributes | Description |
---|---|---|---|
id | Integer | unique, not_null, auto_increment | Unique ID for this entry |
network | String | Primary | The Network name |
station | String | The Station/Array name | |
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, |
DateTime this record was last updated |
Name | Type | Attributes | Description |
---|---|---|---|
id | Integer | unique, not_null, auto_increment | Unique ID for this entry |
station | String | The Station/Array name | |
alias |
String |
A station alias used for output in data formats |
|
type | String | The station type (Station, Array) | |
description | String | A description | |
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, |
DateTime this record was last updated |
Name | Type | Attributes | Description |
---|---|---|---|
id | Integer | unique, not_null, auto_increment | Unique ID for this entry |
array | String | The Array name | |
station | String | The station name | |
channel | String | The channel name | |
order | Integer | The station/channel order within the array | |
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, |
DateTime this record was last updated |
Name | Type | Attributes | Description |
---|---|---|---|
id | Integer | unique, not_null, auto_increment | Unique ID for this entry |
startTime | String | Primary | The Start time |
endTime | String | Primary | The End time |
network | String | Primary | The Network name |
station | String | Primary | The Station/Array name |
datum | String | The Datum for the Latitude/Longitude normally WGS84 | |
latitude | Double | The Latitude in degrees using the datum. | |
longitude | Double | The Longitude in degrees using the datum. | |
elevation | Double | The ground level elevation in metres from the WGS84 ellipsoid (Sea level) | |
arrayOffsetEast | Double | For a station in an array, this is the offset from the array's centre in km (These should be moved to ArrayChannels) | |
arrayOffsetNorth | Double | For a station in an array, this is the offset from the array's centre in km (These should be moved to ArrayChannels) | |
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, |
DateTime this record was last updated |
Name | Type | Attributes | Description |
---|---|---|---|
id | Integer | unique, not_null, auto_increment | Unique ID for this entry |
startTime | String | Primary | The Start time for this channel, when it came into existence |
endTime | String | Primary | The End time for this channel, when it ceased existence |
network | String | Primary | The Network name |
station | String | Primary | The Station/Array name |
channel | String | The Channels primary identifier (Usually the channelType and channelAux combined with a "_") | |
channelType | String | The Channels Type. Three characters such as (BHZ) | |
channelAux | String | The Channels Auxiliary identifier. Could be the location ID (Usually two digits, e.g. "01") | |
description | String | A Description | |
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, |
DateTime this record was last updated |
Name | Type | Attributes | Description |
---|---|---|---|
id | Integer | unique, not_null, auto_increment | Unique ID for this entry |
source | String | Primary | The Source name |
alias | String | A short alias for the source name. | |
description | String | A Description | |
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, |
DateTime this record was last updated |
Name | Type | Attributes | Description |
---|---|---|---|
id | Integer | unique, not_null, auto_increment | Unique ID for this entry |
startTime | String | Primary | The Start time |
endTime | String | Primary | The End time |
source | String | Primary | The Source name |
priority | Int | The priority. Higher valude is higher priority |
|
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, |
DateTime this record was last updated |
Name | Type | Attributes | Description |
---|---|---|---|
id | Integer | unique, not_null, auto_increment | Unique ID for this entry |
startTime | String | Primary | The Start time for this channel |
endTime | String | Primary | The End time for this channel |
network | String | Primary | The Network name |
station | String | Primary | The Station/Array name |
channel | String | Primary | The Channels primary identifier |
source |
String | Primary | The Source of the data this metadata is for |
name |
String |
Primary | The Calibration name to handle multiple Calibrations. Currently supports "Main" and "Measured" |
samplingFrequency | Double | The Sampling frequency used | |
calibrationFrequency | Double | The frequency that the CalibrationFactor value is valid for (Hz) | |
calibrationFactor | Double | The scaling value to apply to the data to normalise to nanometres. This is a measured value at the calibration frequency. For seisometers it is in nanometres/count. The calibrationUnits specify the actual units. | |
calibrationUnits | String | Unit for calibration Factor, e.g. nanometers. (Maybe we should remove this and always have the calibrationFactor in nanometers/count ?) | |
depth | Double | The depth below ground level (m) | |
verticalAngle | Double | The Sensor's placement vertical angle in degrees degrees with zero = vertically up (degrees) | |
horizontalAngle | Double | The Sensor's placement horizontal angle in degrees clockwise from north (degrees) | |
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, |
DateTime this record was last updated |
Name | Type | Attributes | Description |
---|---|---|---|
id | Integer | unique, not_null, auto_increment | Unique ID for this entry |
startTime | String | Primary | The Start time |
endTime | String | Primary | The End time |
channelId | Integer | Primary | The Channel id |
source |
String | Primary | The Source of the data this metadata is for |
digitiserId | Integer | The Digitiser in use | |
sensorId | Integer | The Sensor in use | |
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, |
DateTime this record was last updated |
Name | Type | Attributes | Description |
---|---|---|---|
id | Integer | unique, not_null, auto_increment | Unique ID for this entry |
startTime | String | Primary | The Start time, when it came into existence |
endTime | String | Primary | The End time, when it ceased existence |
name | String | The digitiser's model name. Only used when there is a unique physical digitiser | |
type | String | The digitiser type. Only used when there is a unique physical digitiser | |
serialNumber | String | The digitisers's serial number. Only used when there is a unique physical digitiser | |
numberChannels | Integer | The number of supported channels, for cross checking | |
baseSamplingFrequency | Double | The main sampling frequency (Hz). This could be 0. The SamplingFrequency in Calibrations will be used for data. | |
initialSamplingFrequency | Double | The initial pre-decimation sampling frequency (Hz) | |
gain | Double | The overall gain of the digitiser at the manufacturers calibration frequency (counts/volt?). (For information only) | |
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, |
DateTime this record was last updated |
Name | Type | Attributes | Description |
---|---|---|---|
id | Integer | unique, not_null, auto_increment | Unique ID for this entry |
startTime | String | Primary | The Start time, when it came into existence |
endTime | String | Primary | The End time, when it ceased existence |
name | String | The sensor name. | |
type | String | The type of sensor. (Seismometer, Hydrophone etc) | |
serialNumber | String | The sensor's serial number. Only used when there is a unique physical sensor | |
numberChannels | Integer | The number of supported channels, for cross checking | |
gain | Double | The overall gain of the sensor at the manufacturers calibration frequency. (For information only) | |
gainUnits | String | Units in which gain is quoted, e.g. volts per (m/s), volts per Pa | |
oldId | Integer | Original databases instrument id. | |
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, |
DateTime this record was last updated |
Name | Type | Attributes | Description |
---|---|---|---|
id | Integer | unique, not_null, auto_increment | Unique ID for this entry |
startTime | String | Primary | The Start time |
endTime | String | Primary | The End time |
network | String | Primary | The Network name |
station | String | Primary | The Station/Array name |
channel | String | Primary | The Channels primary identifier |
source |
String | Primary | The Source of the data this metadata is for |
name | String | The responses name (Sensor,Digitiser,Anti-Aliasing filter, post filter etc) | |
type | String | The type of response (PoleZero,AmplitudePhase or FIR Coefficients) | |
data | Blob | PoleZero, AmplitudePhase or FIR Coefficient data. This is stored in an encoded HEX/ASCII format. We could store as a more reabable ASCII) | |
gain | Double | Overall gain at gain frequency. (For information) | |
gainFrequency | Double | Frequency that gain is valid for. (For information) | |
decimation | Double | Decimation performed post filter. (For information) | |
symmetry | String | Symmetry for FIR coefficients (A = asymmetric, B = symmetric[odd], C = symmetric[even]) | |
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, |
DateTime this record was last updated |
Used to keep the list of data files managed by the BDS.
Name | Type | Attributes | Description |
---|---|---|---|
id | Integer | unique, auto_increment,Primary | Unique integer ID |
startTime | String | Primary | The Start time |
endTime | String | Primary | The End time |
location | String | The location of the data. This could be a local archive or even a remote archive | |
format | String | The data's format | |
url | String | File location. This can embody a protocol, host, path and filename. | |
comment | String | A general comment string. | |
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, |
DateTime this record was last updated |
Used to keep the list of all of the data channels and which file they are in.
Name | Type | Attributes | Description |
---|---|---|---|
id | Integer | unique, auto_increment,Primary | Unique integer ID |
startTime | String | Primary | The Start time |
endTime | String | Primary | The End time |
network | String | Primary | The Network organisation the original data is from |
station | String | Primary | The Station/Array name |
source | String | Primary | Some information on the source of this data (Master, Tape, Processed ...). This would allow multiple sources of data from the same Array and TimePeriod. It could also support processed data. |
channel | String | Primary | The Data channel name |
sampleRate | Double | The Sample rate | |
sampleFormat | Integer | The format of each sample (Int16, Int32, Float32 etc) | |
dataFileId | Integer | The Data Files ID | |
dataFileChannel | Integer | The channel number within the data file | |
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, |
DateTime this record was last updated |
Name | Type | Attributes | Description |
---|---|---|---|
id | Integer | unique, auto_increment,Primary | Unique integer ID |
type | String | The entry type: (Log, Outage, Note, Warning etc) | |
time | String | The time the entry was made | |
user | String | The user who made the entry | |
title | String | A Title for the note | |
description | String | A Comment for the note | |
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, |
DateTime this record was last updated |
Name | Type | Attributes | Description |
---|---|---|---|
id | Integer | unique, auto_increment,Primary | Unique integer ID |
changeGroupId | Integer | The Change Group ID | |
type | String | The entry type: (Log, Outage, Note, Warning etc) | |
time | String | The time the change was made | |
table | String | The Table that was altered. (Should be have a list of tables ?) | |
rowId | Integer | The tables entry that was altered (We would need a unique ID in each record for this)(Should this be in effect a list ?) | |
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, |
DateTime this record was last updated |
Name | Type | Attributes | Description |
---|---|---|---|
id | Integer | unique, auto_increment,Primary | Unique integer ID |
type | String | The Change type | |
time | String | The time the change was made | |
user | String | The User that made the change | |
title | String | A Title for the change | |
description | String | A Comment for the change | |
lastUpdate | Timestamp | default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, |
DateTime this record was last updated |