Standardisering av navn

Obs: Innhold under arbeid.

Retningslinjer på navngivning på datasett og kolonner

Akronymer

For å sikre lesbarhet og minst mulig tvetydighet bør du unngå å bruke for mange akronymer.

Casing og spacing

• Små bokstaver benyttes.
• Vi benytter "snake case" for lesbarhet. Det betyr at vi bruker underscore, _, for å skille mellom ord, begreper og definisjoner både i tabellnavn og kolonner. Ett eksempel kan være trafikkdata_trafikkvolum_hourly.
• Hovedspråk er engelsk, men fagbegreper skal ikke oversettes. Eksempelvis ønsker vi å beskrive en tabell hvor observasjonene er fordelt per time med det engelske begrepet hourly, men vi beholder fagbegrepet trafikkdata.
• For fagbegreper som inneholder norske bokstaver, Æ, Ø, Å, skal følgende standard brukes:
  • Æ —> ae
  • Ø —> o
  • Å —> aa

Granularitet

Det bør komme frem i tabellnavnet hva som er granulariteten til radene/innholdet i datasettet.

For eksempel:

• hvis tabellen inneholder trafikkvolum for et byvektsområde på timebasis, bør navnet beskrive dette: trafikkvolum_byvekstomraade_hourly
• hvis tabellen inneholder trafikkvolum for et målepunkt på ukentlig basis, bør navnet beskrive dette: trafikkvolum_maalepunkt_weekly
• hvis tabellen inneholder data på laveste granularitet (én rad per observasjon), bør navnet beskrive dette: passeringer_per_maalepunkt

Dersom det er gjort beregninger i en tabell eller kolonne, bør det synliggjøres for å få frem hvilken granularitet datasettet har. Bruk følgende forkortelser:

Forkortelse	Beskrivelse
avg	Average (gjennomsnitt)
aggr	Aggregate
med	Median

Navnelengde

Det legges vekt på lesbarhet fremfor plassbesparelse, f.eks i en vurdering ved bruk av forkortelser mot et lengre tabell- eller kolonnenavn.

Bruk gjerne kortest mulig navn på tabeller og kolonner, men husk at det fortsatt må være lesbart og lett å forstå. Fyllord skal unngås. I en situasjon hvor man skal vurdere komprimering av ord mot lesbarhet, skal lesbarhet være prioritert.

For eksempel:

• customer_orders er et bedre valg enn tbl_cust_ordr_data
• Datofelter skriver vi ut ordet date, og ikke eksempelvis d, dt eller lignende. Dette grunnet at date er et kort ord fra før, og det bør dermed ikke være behov for at dette komprimeres ytterligere. I motsetning til d eller dt er det ingen tvetydighet på hva navnet på tabellen eller kolonnen beskriver.

Tabell- og kolonnenavn

Ikke bruk tabell- eller kolonnenavn som reserverte ord i SQL, f.eks. slik som select, date og from.