Skip to content

Latest commit

 

History

History
992 lines (897 loc) · 89.2 KB

metadatamodel.rst

File metadata and controls

992 lines (897 loc) · 89.2 KB
Raw

Metadata Model

This covers all the objects and their relationships to other objects in the model.

All The Objects

Journals

Column Type Reference Attributes
id AutoField NOT NULL, PRIMARY KEY
name CharField NOT NULL
impact_factor FloatField NOT NULL
website_url CharField NOT NULL
encoding CharField NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

Users

Column Type Reference Attributes
id AutoField NOT NULL, PRIMARY KEY
first_name CharField NOT NULL
middle_initial CharField NOT NULL
last_name CharField NOT NULL
network_id CharField NULL
email_address CharField NOT NULL
encoding CharField NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

Institutions

Column Type Reference Attributes
id AutoField NOT NULL, PRIMARY KEY
name TextField NOT NULL
association_cd CharField NOT NULL
is_foreign BooleanField NOT NULL
encoding CharField NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

Projects

Column Type Reference Attributes
id CharField NOT NULL, PRIMARY KEY
title TextField NOT NULL
short_name CharField NULL
abstract TextField NULL
science_theme CharField NULL
project_type CharField NULL
submitted_date ExtendDateTimeField NOT NULL
accepted_date ExtendDateField NULL
actual_start_date ExtendDateField NULL
actual_end_date ExtendDateField NULL
closed_date ExtendDateField NULL
suspense_date ExtendDateField NULL
encoding CharField NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

Instruments

Column Type Reference Attributes
id AutoField NOT NULL, PRIMARY KEY
display_name CharField NOT NULL
name CharField NOT NULL
name_short CharField NOT NULL
active BooleanField NOT NULL
encoding CharField NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

Citations

Column Type Reference Attributes
id AutoField NOT NULL, PRIMARY KEY
article_title TextField NOT NULL
journal ForeignKeyField Journals.id NOT NULL
journal_volume IntegerField NOT NULL
journal_issue IntegerField NOT NULL
page_range CharField NOT NULL
abstract_text TextField NOT NULL
xml_text TextField NOT NULL
release_authorization_id CharField NOT NULL
doi_reference CharField NOT NULL
encoding CharField NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

Contributors

Column Type Reference Attributes
id AutoField NOT NULL, PRIMARY KEY
user ForeignKeyField Users.id NOT NULL
first_name CharField NOT NULL
middle_initial CharField NOT NULL
last_name CharField NOT NULL
dept_code CharField NOT NULL
institution ForeignKeyField Institutions.id NOT NULL
encoding CharField NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

Datasets

Column Type Reference Attributes
id AutoField NOT NULL, PRIMARY KEY
description TextField NULL
display_name CharField NOT NULL
suspense_date ExtendDateField NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

Relationships

Column Type Reference Attributes
uuid UUIDField NOT NULL, PRIMARY KEY
name CharField NOT NULL
display_name CharField NOT NULL
description TextField NOT NULL
encoding CharField NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

DataSources

Column Type Reference Attributes
uuid UUIDField NOT NULL, PRIMARY KEY
name CharField NOT NULL
uri CharField NOT NULL
display_name CharField NOT NULL
description TextField NOT NULL
encoding CharField NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

Keywords

Column Type Reference Attributes
id AutoField NOT NULL, PRIMARY KEY
keyword CharField NOT NULL
encoding CharField NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

Groups

Column Type Reference Attributes
id AutoField NOT NULL, PRIMARY KEY
name CharField NOT NULL
is_admin BooleanField NOT NULL
display_name CharField NOT NULL
description TextField NOT NULL
encoding CharField NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

AnalyticalTools

Column Type Reference Attributes
id AutoField NOT NULL, PRIMARY KEY
name CharField NOT NULL
encoding CharField NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

InstrumentUser

Column Type Reference Attributes
uuid UUIDField NOT NULL, PRIMARY KEY
instrument ForeignKeyField Instruments.id NOT NULL
user ForeignKeyField Users.id NOT NULL
relationship ForeignKeyField Relationships.uuid NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

InstitutionUser

Column Type Reference Attributes
uuid UUIDField NOT NULL, PRIMARY KEY
user ForeignKeyField Users.id NOT NULL
institution ForeignKeyField Institutions.id NOT NULL
relationship ForeignKeyField Relationships.uuid NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

CitationContributor

Column Type Reference Attributes
citation ForeignKeyField Citations.id NOT NULL
author ForeignKeyField Contributors.id NOT NULL
author_precedence IntegerField NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

CitationKeyword

Column Type Reference Attributes
citation ForeignKeyField Citations.id NOT NULL
keyword ForeignKeyField Keywords.id NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

ProjectInstrument

Column Type Reference Attributes
uuid UUIDField NOT NULL, PRIMARY KEY
project ForeignKeyField Projects.id NOT NULL
instrument ForeignKeyField Instruments.id NOT NULL
relationship ForeignKeyField Relationships.uuid NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

ProjectUser

Column Type Reference Attributes
uuid UUIDField NOT NULL, PRIMARY KEY
user ForeignKeyField Users.id NOT NULL
project ForeignKeyField Projects.id NOT NULL
relationship ForeignKeyField Relationships.uuid NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

ProjectGroup

Column Type Reference Attributes
group ForeignKeyField Groups.id NOT NULL
project ForeignKeyField Projects.id NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

CitationProject

Column Type Reference Attributes
citation ForeignKeyField Citations.id NOT NULL
project ForeignKeyField Projects.id NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

Transactions

Column Type Reference Attributes
id AutoField NOT NULL, PRIMARY KEY
description TextField NULL
suspense_date ExtendDateField NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

TransSIP

Column Type Reference Attributes
id ForeignKeyField Transactions.id NOT NULL, PRIMARY KEY
submitter ForeignKeyField Users.id NOT NULL
instrument ForeignKeyField Instruments.id NOT NULL
project ForeignKeyField Projects.id NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

TransSAP

Column Type Reference Attributes
id ForeignKeyField Transactions.id NOT NULL, PRIMARY KEY
submitter ForeignKeyField Users.id NOT NULL
analytical_tool ForeignKeyField AnalyticalTools.id NOT NULL
project ForeignKeyField Projects.id NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

Files

Column Type Reference Attributes
id AutoField NOT NULL, PRIMARY KEY
name CharField NOT NULL
subdir CharField NOT NULL
ctime ExtendDateTimeField NOT NULL
mtime ExtendDateTimeField NOT NULL
hashsum CharField NOT NULL
hashtype CharField NOT NULL
size BigIntegerField NOT NULL
transaction ForeignKeyField Transactions.id NOT NULL
mimetype CharField NOT NULL
encoding CharField NOT NULL
suspense_date ExtendDateField NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

Keys

Column Type Reference Attributes
id AutoField NOT NULL, PRIMARY KEY
key CharField NOT NULL
display_name CharField NOT NULL
description TextField NOT NULL
encoding CharField NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

Values

Column Type Reference Attributes
id AutoField NOT NULL, PRIMARY KEY
value CharField NOT NULL
display_name CharField NOT NULL
description TextField NOT NULL
encoding CharField NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

FileKeyValue

Column Type Reference Attributes
file ForeignKeyField Files.id NOT NULL
key ForeignKeyField Keys.id NOT NULL
value ForeignKeyField Values.id NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

TransactionKeyValue

Column Type Reference Attributes
transaction ForeignKeyField Transactions.id NOT NULL
key ForeignKeyField Keys.id NOT NULL
value ForeignKeyField Values.id NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

UserGroup

Column Type Reference Attributes
user ForeignKeyField Users.id NOT NULL
group ForeignKeyField Groups.id NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

DatasetFile

Column Type Reference Attributes
dataset ForeignKeyField Datasets.id NOT NULL
file ForeignKeyField Files.id NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

DatasetProjectUser

Column Type Reference Attributes
uuid UUIDField NOT NULL, PRIMARY KEY
dataset ForeignKeyField Datasets.id NOT NULL
user ForeignKeyField Users.id NOT NULL
project ForeignKeyField Projects.id NOT NULL
relationship ForeignKeyField Relationships.uuid NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

InstrumentGroup

Column Type Reference Attributes
instrument ForeignKeyField Instruments.id NOT NULL
group ForeignKeyField Groups.id NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

AToolProject

Column Type Reference Attributes
project ForeignKeyField Projects.id NOT NULL
analytical_tool ForeignKeyField AnalyticalTools.id NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

AToolTransaction

Column Type Reference Attributes
transaction ForeignKeyField Transactions.id NOT NULL
analytical_tool ForeignKeyField AnalyticalTools.id NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

TransactionUser

Column Type Reference Attributes
uuid UUIDField NOT NULL, PRIMARY KEY
user ForeignKeyField Users.id NOT NULL
transaction ForeignKeyField Transactions.id NOT NULL
relationship ForeignKeyField Relationships.uuid NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

DOIEntries

Column Type Reference Attributes
doi CharField NOT NULL, PRIMARY KEY
status CharField NOT NULL
released BooleanField NOT NULL
site_url CharField NOT NULL
encoding CharField NOT NULL
creator ForeignKeyField Users.id NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

DOIAuthors

Column Type Reference Attributes
id AutoField NOT NULL, PRIMARY KEY
last_name CharField NOT NULL
first_name CharField NOT NULL
email CharField NULL
affiliation CharField NULL
orcid CharField NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

DOITransaction

Column Type Reference Attributes
doi ForeignKeyField DOIEntries.doi NOT NULL, PRIMARY KEY
transaction ForeignKeyField TransactionUser.uuid NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

CitationTransaction

Column Type Reference Attributes
citation ForeignKeyField Citations.id NOT NULL
transaction ForeignKeyField TransactionUser.uuid NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

CitationDOI

Column Type Reference Attributes
doi ForeignKeyField DOIEntries.doi NOT NULL
citation ForeignKeyField Citations.id NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

DOIAuthorMapping

Column Type Reference Attributes
author ForeignKeyField DOIAuthors.id NOT NULL
doi ForeignKeyField DOIEntries.doi NOT NULL
author_order IntegerField NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

DOIInfo

Column Type Reference Attributes
doi ForeignKeyField DOIEntries.doi NOT NULL
key CharField NOT NULL
value CharField NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

InstrumentDataSource

Column Type Reference Attributes
instrument ForeignKeyField Instruments.id NOT NULL
data_source ForeignKeyField DataSources.uuid NOT NULL
relationship ForeignKeyField Relationships.uuid NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

InstrumentKeyValue

Column Type Reference Attributes
instrument ForeignKeyField Instruments.id NOT NULL
key ForeignKeyField Keys.id NOT NULL
value ForeignKeyField Values.id NOT NULL
relationship ForeignKeyField Relationships.uuid NOT NULL
created ExtendDateTimeField NOT NULL
updated ExtendDateTimeField NOT NULL
deleted ExtendDateTimeField NULL

Note

This document is generated by the GenMetadataModelMD.py script and needs to be regenerated whenever changes are made to the model.