HOWTO · PostgreSQL
PostgreSQL-Namenskonventionen
Lernen Sie eine einheitliche Methode kennen, um PostgreSQL-Datenbanken, Tabellen, Sequenzen, Schlüssel, Constraints und Indizes zu benennen, und erfahren Sie, wie sich Bezeichner in Anführungszeichen verhalten.
Auf dieser Seite
Wählen Sie für Ihr Projekt eine gut lesbare Namenskonvention und wenden Sie sie einheitlich auf Datenbanken, Tabellen, Sequenzen, Primärschlüssel, Constraints und Indizes an. PostgreSQL schreibt keinen einheitlichen Stil vor; eine konsistente Benennung erleichtert es Entwicklern, Objekte zu finden und zu pflegen.
PostgreSQL-Namenskonventionen
Die Bezeichnerregeln von PostgreSQL sind unabhängig von Stilentscheidungen. SQL-Schlüsselwörter großzuschreiben, ist eine Formatierungskonvention. Für Bezeichner sind kleingeschriebene Wörter, die durch Unterstriche getrennt werden, eine praktische Standardwahl, zum Beispiel customer_order oder created_at. Verwenden Sie aussagekräftige Namen und ein einheitliches Muster für Tabellen, Spalten, Sequenzen, Constraints und Indizes. Namen wie customer_order_pkey, customer_order_status_check und customer_order_created_at_idx lassen die Rolle eines Objekts leichter erkennen.
Ein nicht in Anführungszeichen gesetzter Bezeichner wird in Kleinbuchstaben umgewandelt. Daher bezeichnen Employee, EMPLOYEE und employee denselben Namen. Ein Bezeichner in doppelten Anführungszeichen behält seine Groß- und Kleinschreibung bei: "Employee" ist ein anderer Name und muss bei jeder Referenz mit denselben doppelten Anführungszeichen und derselben Schreibweise angegeben werden. Bevorzugen Sie kleingeschriebene Bezeichner ohne Anführungszeichen, damit Abfragen und Werkzeuge einfacher bleiben. Vermeiden Sie reservierte Wörter als Namen. Ein Wort wird nicht allein dadurch unbrauchbar, dass es in Anführungszeichen steht; dadurch entsteht jedoch eine zusätzliche Pflicht zum Zitieren, und SQL kann schwieriger zu warten sein.
Richten Sie das Muster nach der Rolle des jeweiligen Objekts aus. Ein Tabellenname ist üblicherweise ein Substantiv im Singular oder Plural, wobei Sie sich im gesamten Schema für eine Form entscheiden sollten. Spaltennamen beschreiben den gespeicherten Wert; ein Sequenzname kann die Tabelle und den Schlüssel erkennen lassen, für die die Sequenz Werte liefert. Nehmen Sie bei Constraints und Indizes die Tabelle oder Spalte sowie ein Suffix wie _pkey, _key, _check oder `_idx in den Namen auf. Diese Suffixe sind Konventionen und keine Anforderungen von PostgreSQL. PostgreSQL kann Namen für nicht ausdrücklich benannte Constraints und Indizes erzeugen. Ausdrückliche Namen erleichtern jedoch das Lesen von Migrationen, Fehlermeldungen und Wartungsabfragen. Halten Sie Namen möglichst kurz und beachten Sie die Bezeichnerlängenbegrenzung von PostgreSQL: Längere Namen werden abgeschnitten, sodass ähnlich benannte Objekte miteinander kollidieren können.
Die folgende Abfolge ist für eine interaktive psql-Sitzung gedacht, die mit einer Datenbank verbunden ist, in der Ihre Rolle Datenbanken erstellen darf. Führen Sie zuerst den Befehl zum Erstellen der Datenbank aus und wechseln Sie anschließend mit dem psql-Meta-Befehl dorthin. Mit den folgenden SQL-Anweisungen erstellen Sie die Sequenz, die Tabelle, Primärschlüssel- und eindeutige Constraints sowie einen zusätzlichen Index. Die abschließenden psql-Befehle zeigen die Definitionen der Datenbank, der Sequenz und der Tabelle an. Für diesen Walkthrough benötigen Sie eine laufende PostgreSQL-Instanz; die Befehle sind kein Protokoll einer tatsächlichen Serversitzung.
- Erstellen Sie eine separate Demonstrationsdatenbank mit
CREATE DATABASE naming_demo;. - Verbinden Sie sich mit ihr über
\connect naming_demo. - Erstellen Sie die Sequenz für den Schlüssel mit
CREATE SEQUENCE employee_id_seq;. - Erstellen Sie die Tabelle mit
CREATE TABLE employee (employee_id integer DEFAULT nextval('employee_id_seq'::regclass), first_name text NOT NULL, last_name text NOT NULL, email_address text NOT NULL, CONSTRAINT employee_pkey PRIMARY KEY (employee_id), CONSTRAINT employee_email_address_key UNIQUE (email_address));. - Ordnen Sie die Sequenz der Schlüsselspalte zu:
ALTER SEQUENCE employee_id_seq OWNED BY employee.employee_id;. - Fügen Sie einen separat benannten Index hinzu:
CREATE INDEX employee_last_name_idx ON employee (last_name);. - Lassen Sie sich die Datenbank mit
\l naming_demo, die Sequenz mit\ds employee_id_seqund die Tabelle mit\d employeeanzeigen. Die Tabellenbeschreibung führt Spalten, Constraints und Indizes auf, darunteremployee_pkey,employee_email_address_keyundemployee_last_name_idx.
Namen in Anführungszeichen sind nützlich, wenn ein bestehendes Schema gemischte Groß- und Kleinschreibung oder Satzzeichen erfordert. Sie schaffen jedoch eine dauerhafte Konvention: Bei jeder Referenz müssen Sie die genaue Schreibweise beibehalten und doppelte Anführungszeichen verwenden. Ein in Anführungszeichen gesetzter Name, der einem Schlüsselwort entspricht, kann dort verwendet werden, wo PostgreSQL es zulässt. Leser können ihn jedoch leicht mit SQL-Syntax verwechseln. Bevorzugen Sie eine Alternative wie user_account, um diese zusätzliche Hürde zu vermeiden. Kleingeschriebene Namen ohne Anführungszeichen passen zum Umwandlungsverhalten von PostgreSQL und sind in Abfragen, Skripten und Datenbankwerkzeugen meist einfacher zu verwenden.
Dieses Python-Beispiel formatiert einige Beispielnamen. Es veranschaulicht eine Namenskonvention und stellt keine Verbindung zu PostgreSQL her. Führen Sie das Beispiel aus:
objects = ["customer order", "created at", "customer order pkey"]
names = [name.replace(" ", "_") for name in objects]
print("\n".join(names))
customer_order
created_at
customer_order_pkey