it-swarm.com.de

Offizielle PostgreSQL-Kapitalisierungskonventionen

Gibt es eine offizielle PostreSQL-Konvention zur Großschreibung von DB-, Tabellen- und Feldnamen?

Die Beispiele auf der offiziellen Seite schlagen Kleinbuchstaben vor und _ Worttrennung, und ich frage mich, ob diese Richtlinie offiziell ist.

CREATE TABLE films (
    code        char(5) CONSTRAINT firstkey PRIMARY KEY,
    title       varchar(40) NOT NULL,
    did         integer NOT NULL,
    date_prod   date,
    kind        varchar(10),
    len         interval hour to minute
);
14
Adam Matan

Ich werde im Grunde Veraces Kommentare widerspiegeln und dies erklären, was es halboffiziell macht:

Es gibt niemanden Best Practice, der alle Umstände abdeckt. Im Folgenden werden die folgenden Annahmen getroffen (und was zu tun ist, wenn Sie dies nicht getan haben):

  • Sie haben dies bereits mit Ihrem Team besprochen (Menschen, die alleine arbeiten, müssen sich oft nur entscheiden)
  • Es gibt noch keine formalisierte Stildefinition für SQL in Ihrem Team (sonst würden Sie uns nicht fragen)
  • Es gibt keine formalisierte Stildefinition für Code (Befolgen Sie dieselben grundlegenden Konventionen, die bereits für andere Sprachen festgelegt wurden, und formalisieren Sie einen Stil).

Der Rest ist also etwas eigensinnig, basiert aber auf Erfahrung

  1. Wenn es um Tabellennamen geht
    1. Sie sollten sich für einzelne Entitätsnamen entscheiden (dies erleichtert die Dokumentation).
    2. Sie sollten hier Pascal Case verwenden
  2. Wenn es um Feldnamen geht
    1. Verwenden Sie camelCase für Ihre Feldnamen
    2. Verwenden Sie kurze Singularnamen, es sei denn, die Definition ist als Plural definitiv sinnvoll (fast nie).
  3. Wenn es um Ihre eigenen Funktionen oder Namen gespeicherter Prozeduren geht
    1. Verwenden Sie underscore_separation
    2. Verwenden Sie für die Parametrierung die Feldbenennung
  4. Wenn es um eingebaute Datenbankfunktionen oder Sprachnamen geht (zB SELECT)
    1. Verwenden Sie ALL CAPS, es sei denn, es muss eine bestimmte Großschreibung erforderlich sein
    2. Kennen Sie die APIs für Ihre Sprache, um zu wissen, was sinnvoll oder erforderlich ist
  5. Wenn es um Abstände geht
    1. Viele Leute verwenden die Spaltenausrichtung für Schlüsselwörter und die Einrückung für Dinge, die keine Schlüsselwörter sind
    2. Viele Leute verwenden Kommas am Anfang der Zeile, wenn die Felder in jeder Zeile getrennt sind (dies erleichtert das Auskommentieren eines bestimmten Felds aus einer Auswahlliste).
    3. Verwenden Sie niemals Leerzeichen als Teil der Namen von Dingen, auch nicht für Rückgabewert-Header.
  6. Wenn es um Interpunktion geht
    1. Klammern - BENUTZEN SIE SIE. Sie sind KOSTENLOS. Das verspreche ich.
    2. Semikolons - BENUTZEN SIE SIE. Sie werden dich nicht brechen. Sie zwingen Sie, Ihren Code auszudenken. Und sie sind gute Hygiene.
    3. Carriage Returns - Wieder sind sie kostenlos ;-) Und machen Sie Ihren Code lesbar.

Sie sollten auch erkennen, dass die Community für Postgres, während ich versuche, Ihnen bei der Anwendung eines generischen Styleguides zu helfen, im Allgemeinen nicht camelCase oder PascalCase verwendet, sondern underscore_separation. Das wirklich wichtige Bit soll sicherstellen, dass Sie überall einen bestimmten Stil festlegen und verwenden, um konsistent zu sein .

21
jcolebrand

Ein schnelles Google zeigt viele Websites an, die Best Practices angeben. Ich würde nur zwei Dinge sagen - benutze niemals [~ # ~] [~ # ~] Leerzeichen "Mein Tabellenname" (Portierung wird unmöglich aufgrund unterschiedlicher Escape-Mechanismen (gilt auch für nicht alphanumerische Zeichen). Bei solchen Mechaniken muss man normalerweise auch den Fall respektieren. Es gibt genügend Buchstaben und Wörter in der englischen (oder Ihrer eigenen) Sprache und die Bezeichnerlängen sind lang genug (ich kenne kein System mit identifier_length <32, PostgreSQL ist 64). Verwenden Sie niemals SQL-Schlüsselwörter (die je nach RDBMS variieren), die dasselbe bewirken.

Aussagen wie

SELECT "Field" FROM "Table";

kann gültig sein! Das absolut Kritische ist, eine klare und relativ einfache Konvention zu haben und sich dann daran zu halten. Wie Sie herausfinden werden, haben die Menschen unterschiedliche Meinungen - lesen Sie das Thema durch und wählen Sie aus, was sich für Sie "richtig anfühlt". Siehe diese Seiten 1 , 2 , , 4 , 5 , .. . (Es gibt viele mehr).

4
Vérace