Difference between revisions of "SME Server db property naming convention"

From SME Server
Jump to navigationJump to search
Line 5: Line 5:
 
* Single property names are always in ''lowercase' e.g.
 
* Single property names are always in ''lowercase' e.g.
 
  db configuration sshd setprop ''access'' private
 
  db configuration sshd setprop ''access'' private
where '''access''' is completely in lowercase
+
where '''access''' is a single word string and completely in lowercase
  
  
* Composite property names are ''capatalized per word'' of the composite property name e.g.
+
* Composite property names are ''capitalized per word'' of the composite property name e.g.
 
  db configuration sshd setprop ''PermitRootLogin'' yes
 
  db configuration sshd setprop ''PermitRootLogin'' yes
where '''PermitRootLogin''' is capatalized per composite word.
+
where '''PermitRootLogin''' is a composite string and capitalized per composite word.
 +
 
 +
 
 +
* Composite property names that include abbreviations have capitalized abbreviations e.g.
 +
db configuration sshd setprop ''TCPPort'' 22
 +
where '''TCPPort''' is a composite string with capitalized abbreviation and capitalized per composite word.

Revision as of 19:46, 28 December 2014

Warning.png Work in Progress:
This page is a Work in Progress. The contents off this page may be in flux, please have a look at this page history the to see list of changes.


The db Property naming convention is as follows:

  • Single property names are always in lowercase' e.g.
db configuration sshd setprop access private

where access is a single word string and completely in lowercase


  • Composite property names are capitalized per word of the composite property name e.g.
db configuration sshd setprop PermitRootLogin yes

where PermitRootLogin is a composite string and capitalized per composite word.


  • Composite property names that include abbreviations have capitalized abbreviations e.g.
db configuration sshd setprop TCPPort 22

where TCPPort is a composite string with capitalized abbreviation and capitalized per composite word.