Skip to content

Latest commit

 

History

History
89 lines (87 loc) · 3.35 KB

Centralized Cruise Database - DB Naming Conventions.md

File metadata and controls

89 lines (87 loc) · 3.35 KB
Raw

Centralized Cruise Database Naming Conventions

Overview:

When developing a database it is important to use consistent naming conventions so that database objects and associated fields are easily understandable. Consistent prefixes can be used to differentiate between the core data objects being managed in the database and the data objects for the various modules installed. Consistent object suffixes indicate what each object represents and what type of data each field contains. Oracle requires object names and field names to have a maximum of 30 characters so abbreviations are required to keep the length within the acceptable range, consistent abbreviations improve the usability of the database. The underscore character should be used to separate the various abbreviations for objects/fields. The PIFSC-ITS DB naming and coding standards defines database naming standards for PIFSC. For all installed database modules refer to the corresponding modules’ database naming convention documentation. This document defines the database naming conventions for the Centralized Cruise Database (CCD).

Naming Conventions:

  • Object Prefixes:

    • CCD: Centralized Cruise Database

  • Object Suffixes:

    • BRI: Before Row Insert (for triggers)
    • BRU: Before Row Update (for triggers)
    • FN: Function
    • HIST: Historical table
    • PKG: Package
    • SEQ: Sequence
    • SP: Stored Procedure
    • V: View

  • Field Suffixes:

    • CODE: Code field
    • DATE: Date field
    • DESC: Description field
    • ID: Primary/foreign keys (e.g. LOC_ID, SPECIES_ID)
    • YN: Yes/No field (Boolean)

  • Abbreviations:

    • AGG: Aggregate
    • ANNOT: Annotated
    • APP: Application
    • BR: <BR> web tag
    • CAT: Category/Catalog
    • CD: Comma-delimited
    • CMP: Compare
    • CNAME: Common Name
    • CONT: Contact
    • DAS: Days at Sea
    • DB: Database
    • DELIM: Delimited
    • DESC: Description
    • DIV: Division
    • DOC: Documentation
    • DOI: Digital Object Identifier
    • DTM: Date/Time
    • DVM: Data Validation Module
    • ECO: Ecosystem
    • ESA: Endangered Species Act
    • EVAL: Evaluation
    • EXP: Expected
    • FINSS: Fisheries Independent Surveys System
    • FISC: Fiscal
    • FREQ: Frequency
    • FSSI: Fish Stock Sustainability Index
    • FY: Fiscal Year
    • GEO: Geographic
    • INP: InPort
    • INV: Invalid
    • ISS: Issue
    • LEN: Length
    • MIN: Minimal
    • MISS: Missing
    • MMPA: Marine Mammal Protection Act
    • MOD: Modified
    • NUM: Number
    • OBJ: Objective
    • OPTS: Options
    • ORG: Organization
    • ORIG: Original
    • OTH: Other
    • PCT: Percentage
    • PLAT: Platform
    • PRE: Preset
    • PRES: Presentation
    • PRIM: Primary
    • PTA: Point in Time Architecture
    • QC: Quality Control
    • RC: Return Carriage
    • REG: Regional
    • RNG: Range
    • RPT: Report
    • SCD: Semicolon-delimited
    • SCI: Science
    • SNAME: Scientific Name
    • SPP: Species
    • STD: Standard
    • SUMM: Summary
    • SVY: Survey
    • TGT: Target
    • TRUNC: Truncated
    • TZ : Time Zone
    • URL: Uniform Resource Locator
    • VAL: Value