Db command tutorial

db command tutorial

The db command is unique to sme server. It is used to add settings to the various configuration databases which are then incorporated into the standard configuration files in /etc/.... via the template expansion process.

To display the syntax, at a command prompt type

db

then press Enter, which displays the usage:

/sbin/e-smith/db dbfile keys
/sbin/e-smith/db dbfile print [key]
/sbin/e-smith/db dbfile show [key]
/sbin/e-smith/db dbfile get key
/sbin/e-smith/db dbfile set key type [prop1 val1] [prop2 val2] ...
/sbin/e-smith/db dbfile setdefault key type [prop1 val1] [prop2 val2] ...
/sbin/e-smith/db dbfile delete key
/sbin/e-smith/db dbfile printtype [key]
/sbin/e-smith/db dbfile gettype key
/sbin/e-smith/db dbfile settype key type
/sbin/e-smith/db dbfile printprop key [prop1] [prop2] [prop3] ...
/sbin/e-smith/db dbfile getprop key prop
/sbin/e-smith/db dbfile setprop key prop1 val1 [prop2 val2] [prop3 val3] ...
/sbin/e-smith/db dbfile delprop key prop1 [prop2] [prop3] ...

Note that on a properly setup sme7.x (path wise) you do not need to include the /sbin/e-smith/ part.

Note also that from sme6 onwards, a shortcut for

db configuration

is

config

Note this only applies to this one often used database file, all others must be referred to using the format

db dbname xxxx yyyy zzzz

All database files are in

/home/e-smith/db

Here are a few examples to demonstrate usage and syntax correlation

db dbname show

Using real db names - for the database in /home/e-smith/db/configuration

db configuration show
db configuration show |more
db configuration keys

• An example for the imap service

[root@sme8dev64 ~]# db configuration show imap

imap=service
   ConcurrencyLimit=400
   ConcurrencyLimitPerIP=12
   TCPPort=143
   access=private
   status=enabled

[root@sme8dev64 ~]# db configuration getprop imap status

which gives something like

enabled

[root@sme8dev64 ~]# db configuration getprop dansguardian ConcurrencyLimitPerIP

which gives something like

12

You could also do

[root@sme8dev64 ~]# config show dansguardian

imap=service
   ConcurrencyLimit=400
   ConcurrencyLimitPerIP=12
   TCPPort=143
   access=private
   status=enabled

Compare the above displayed actual element values of the db command with the syntax result from issuing the db command where each element or piece equates to:

db = command configuration = database name show = part of a command keys = part of a command imap = key status = property enabled = value ConcurrencyLimitPerIP = property 12 = value

Apply the above "reasoning" to any database and the the syntax presented by issuing db then makes sense.

Note that missing (or no) properties and values do not necessarily mean no value is in the /etc/file.conf system, as the template code can have a default value in the absence of a specific db value.

Note to determine what db settings are supported by sme code, or what the default values are, refer to (ie read) the code that is in the particular template or custom template associated with a /etc/file.conf

Look in /etc/e-smith/templates/... and /etc/e-smith/templates-custom/.... and subfolders and template fragments applicable to particular /etc/file.conf configuration files.

show all available database

To show a list of existing databases do

cd /home/e-smith/db
ls -al

which gives something like for offical databases

total 304 -rw-r----- 1 root admin 1921 f�vr. 18 2014 accounts -rw-r--r-- 1 root admin 0 f�vr. 2 2013 backups -rw-r----- 1 root admin 8816 nov. 4 19:38 configuration -rw-r----- 1 root admin 361 f�vr. 2 2013 domains -rw-r----- 1 root admin 816 f�vr. 7 2013 hosts drwxr-x--- 2 root ldap 4096 f�vr. 22 2013 ldap -rw-r----- 1 root admin 3098 f�vr. 2 2013 mailpatterns drwxr-x--- 2 root root 4096 avril 27 2014 mysql drwxr-xr-x 2 root root 4096 nov. 3 21:42 navigation -rw-r----- 1 root admin 299 f�vr. 2 2013 networks -rw-r----- 1 root admin 0 mars 11 2010 portforward_tcp -rw-r----- 1 root admin 0 mars 11 2010 portforward_udp -rw-r----- 1 root admin 271 f�vr. 2 2013 spamassassin -rw-r--r-- 1 root root 201371 nov. 4 04:04 yum_available -rw-r--r-- 1 root root 37419 nov. 4 04:04 yum_installed -rw-r----- 1 root admin 4459 f�vr. 18 2014 yum_repositories -rw-r--r-- 1 root root 70 nov. 4 04:04 yum_updates

To show the keys for the two main databases do:

db configuration keys |more

That can be abbreviated to

config keys |more

db accounts keys |more

Note after using the |more switch, press Enter to scroll down a line at a time, or press Space to scroll down a page at a time

Create a db key

the generic command is :

/sbin/e-smith/db dbfile set key type [prop1 val1] [prop2 val2] ...

dbfile : choose the database in /home/e-smith/db
key : the name of key
type : generally 'service' or configuration but it can be other things as webbapps or url or ...

If you want to create a keys called 'plop' in the configuration database with a type as 'configuration you can do like this

db configuration set plop configuration Name wordpress PublicAccess private status enabled DbName wordpress DbUser wordpress WpLang en

you can see the result

config show plop

or

db configuration show
 plop=configuration
   DbName=wordpress
   DbUser=wordpress
   Name=wordpress
   PublicAccess=private
   WpLang=en
   status=enabled

References

See the Howto section for a couple of articles on db commands that should give useful info ie

http://wiki.contribs.org/DB_Variables_Configuration

and

http://wiki.contribs.org/Useful_Commands

and refer to the Developers Guide for technical information if needed

---