Template:ChadoTable library synonym

Revision as of 19:22, 24 November 2010 by Clements (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This template is a Chado Table Template. It defines a single table from the Chado schema, and every Chado table has a template like this one. This template is automatically included in two places:

  1. The module page for the module the table is a part of. This is where updates and comments should be posted.
  2. The Chado Tables page, which lists all tables.

You can include this template anywhere you want to show the table description.

Table: library_synonym
Module: Library

library_synonym columns
FK Name Type Description
library_synonym_id serial PRIMARY KEY
synonym synonym_id integer UNIQUE#1


library library_id integer UNIQUE#1


pub pub_id integer UNIQUE#1

The pub_id link is for relating the usage of a given synonym to the publication in which it was used.

is_current boolean NOT NULL

The is_current bit indicates whether the linked synonym is the current -official- symbol for the linked library.

is_internal boolean NOT NULL

Typically a synonym exists so that somebody querying the database with an obsolete name can find the object they are looking for under its current name. If the synonym has been used publicly and deliberately (e.g. in a paper), it my also be listed in reports as a synonym. If the synonym was not used deliberately (e.g., there was a typo which went public), then the is_internal bit may be set to "true" so that it is known that the synonym is "internal" and should be queryable but should not be listed in reports as a valid synonym.

Tables referencing library_synonym via foreign key constraints:

  • None.