2012-11-06 8 views
10

So habe ich etwasmongodb Schema-Design Namenskonvention

exports.create = function(projectJSON){ 

var project = new ProjectModel({ 
    id : projectJSON.id, 
    projectName : projectJSON.projectName , 
    authorName : projectJSON.authorName, 
    firstPostDate : projectJSON.firstPostDate 

}) 
} 

Ist die oben Namenskonvention für ein Mehrwortelement firstPostDate richtig genannt, oder sie mit _ in Kapitälchen entfernt sein?

Ich sehe, dass andere Blogs bevorzugen es in Kapitälchen sein ..

EDIT:

Auch las ich, dass Elemente statt Plural also singulär sein sollte:

`comment` instead of `comments` for a blog schema design 

Antwort

15

I Verwenden Sie Google's JSON Style Guide selbst und sie schlagen vor, camelCase zB firstPostDate zu verwenden. Im Folgenden ist der Abschnitt Auszug

Name Format

Eigenschaftsnamen zu den folgenden Richtlinien entsprechen müssen:

  • Eigenschaftsnamen aussagekräftige Namen mit definierten Semantik sein sollten.
  • Eigenschaftsnamen müssen camel-cased, ascii strings sein.
  • Das erste Zeichen muss ein Buchstabe, ein Unterstrich (_) oder ein Dollarzeichen ($) sein.
  • Nachfolgende Zeichen können ein Buchstabe, eine Ziffer, ein Unterstrich oder ein Dollarzeichen sein.
  • Reservierte JavaScript-Schlüsselwörter sollten vermieden werden (Eine Liste der reservierten JavaScript-Schlüsselwörter finden Sie weiter unten).

Diese Richtlinien spiegeln die Richtlinien für die Benennung von JavaScript-Bezeichnern wider. Dadurch können JavaScript-Clients mithilfe der Punktnotation auf Eigenschaften zugreifen. (zum Beispiel result.thisIsAnInstanceVariable). Hier ist ein Beispiel für ein Objekt mit einer Eigenschaft:

{ 
    "thisPropertyIsAnIdentifier": "identifier value" 
} 
+0

so wenn es nur ein riesiges Schema mit vielen anderen Dokumenten eingebettet ist, soll das erste Zeichen '' anstelle von nur _id' wird id' richtig? und die ID in den eingebetteten Dokumenten muss keinen Unterstrich haben? – bouncingHippo

+0

@bouncingHippo Unfähig zu verstehen, was Sie sagen. Alle Dokumente auf hoher Ebene in Mongo wurden automatisch erstellt. Ich glaube nicht, dass du es umbenennen kannst. –

+0

sagen wir "thisPropertyIsAnIdentifier" 'ist eine Zeichenkette, im Schemadesign, sollte es nicht sein" thisPropertyIsAnIdentifier ":" String "'? – bouncingHippo

5

Verkürzen der Feldnamen ist nicht erforderlich.

prüfen docs:

Kürzen Feldnamen reduziert Ausdruckskraft und bietet keine erheblichen Nutzen für größere Dokumente und wo Dokument Kopf ist nicht von signifikanter Bedeutung. Kürzere Feldnamen reduzieren die Größe von Indizes nicht, da Indizes eine vordefinierte Struktur haben. In allgemein ist es nicht notwendig, kurze Feldnamen zu verwenden.

1

Namenskonvention für die Sammlung

Um eine Sammlung einige Vorsichtsmaßnahmen zu nennen 1. Eine Sammlung mit leeren String genommen werden („“) ist kein gültiger Kollektionsnamen. 2. Ein Sammlungsname sollte nicht das Nullzeichen enthalten, da dies das Ende des Sammlungsnamens definiert. 3.Der Sammlungsname sollte nicht mit dem Präfix "system." Beginnen, da dies für interne Sammlungen reserviert ist. 4. Es wäre gut, das Zeichen "$" im Sammlungsnamen nicht zu enthalten, da verschiedene für die Datenbank verfügbare Treiber "$" im Sammlungsnamen nicht unterstützen.

Für weitere Informationen besuchen Sie bitte den Link: http://www.learnit.net.in/2016/03/schema-design-and-naming-conventions-in.html