updated documentation a bit
[spider.git] / html / adminmanual-5.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2 <HTML>
3 <HEAD>
4  <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9">
5  <TITLE>The DXSpider Administration Manual v1.48: Databases</TITLE>
6  <LINK HREF="adminmanual-6.html" REL=next>
7  <LINK HREF="adminmanual-4.html" REL=previous>
8  <LINK HREF="adminmanual.html#toc5" REL=contents>
9 <link rel=stylesheet href="style.css" type="text/css" title="default stylesheet">
10 </HEAD>
11 <BODY>
12 <A HREF="adminmanual-6.html">Next</A>
13 <A HREF="adminmanual-4.html">Previous</A>
14 <A HREF="adminmanual.html#toc5">Contents</A>
15 <HR>
16 <H2><A NAME="s5">5. Databases</A></H2>
17
18 <P>Spider allows the creation of local or remote databases.  It supports
19 chained databases, allowing several different databases to be scanned
20 with one simple command.  Importing of databases is limited at present
21 to the standard AK1A databases such as OBLAST and the DB0SDX QSL 
22 database but will expand with time.
23 <P>
24 <H2><A NAME="ss5.1">5.1 Creating databases</A>
25 </H2>
26
27 <P>Creating a database could not be more simple.  All the commands are
28 sent from the cluster prompt as the <EM>sysop</EM> user.
29 <P>To create a database you use the command <EM>dbcreate</EM>.  It can
30 be used in 3 different ways like so ..
31 <P>
32 <BLOCKQUOTE><CODE>
33 <PRE>
34 dbcreate &lt;name>
35 </PRE>
36 </CODE></BLOCKQUOTE>
37 <P>To simply create a database locally, you just tell the command the
38 name of the database.  This does not create the actual database, it
39 simply defines it to say that it exists.
40 <P>
41 <BLOCKQUOTE><CODE>
42 <PRE>
43 dbcreate &lt;name> chain &lt;name> [&lt;name>...]
44 </PRE>
45 </CODE></BLOCKQUOTE>
46 <P>This creates a chained database entry.  The first database will be
47 scanned, then the second, the third etc...
48 <P>
49 <BLOCKQUOTE><CODE>
50 <PRE>
51 dbcreate &lt;name> remote &lt;name>
52 </PRE>
53 </CODE></BLOCKQUOTE>
54 <P>This creates a remote entry.  the first name field is the database
55 name at the remote node, then the remote switch, then the actual
56 node_call of the remote node, for example...
57 <P>
58 <BLOCKQUOTE><CODE>
59 <PRE>
60 dbcreate buckmaster remote gb7dxc
61 </PRE>
62 </CODE></BLOCKQUOTE>
63 <P>Remote databases cannot be chained, however, the last database in a
64 chain can be a remote database.
65 <P>
66 <H2><A NAME="ss5.2">5.2 Importing databases</A>
67 </H2>
68
69 <P>The only databases that Spider can currently import are the standard
70 AK1A databases such as OBLAST or the DB0SDX qsl and address database.
71 This will be added to with time.
72 <P>To import such a database, first put the file somewhere useful like /tmp
73 and then issue the following command ...
74 <P>
75 <BLOCKQUOTE><CODE>
76 <PRE>
77 dbimport oblast /tmp/OBLAST.FUL
78 </PRE>
79 </CODE></BLOCKQUOTE>
80 <P>This will update the existing local oblast database or create it if
81 it does not exist.
82 <P>
83 <H2><A NAME="ss5.3">5.3 Checking available databases</A>
84 </H2>
85
86 <P>Once a database is created, you will want to check that it has been
87 added.  To do this use the <EM>dbavail</EM> command.  This will
88 output the available databases.  For example ...
89 <P>
90 <BLOCKQUOTE><CODE>
91 <PRE>
92 dbavail
93 DB Name          Location   Chain
94 qsl              Local
95 buck             GB7ADX
96 hftest           GB7DXM
97 G0VGS de GB7MBC  3-Feb-2001 1925Z >
98 </PRE>
99 </CODE></BLOCKQUOTE>
100 <P>
101 <H2><A NAME="ss5.4">5.4 Looking up databases</A>
102 </H2>
103
104 <P>To look for information in a defined database, simply use the <EM>dbshow</EM>
105 command, for example ...
106 <P>
107 <BLOCKQUOTE><CODE>
108 <PRE>
109 dbshow buckmaster G0YLM
110 </PRE>
111 </CODE></BLOCKQUOTE>
112 <P>will show the information for the callsign G0YLM from the buckmaster
113 database if it exists.  To make things more standard for the users
114 you can add an entry in the Aliases file so that it looks like a standard 
115 <EM>show</EM> command like this ...
116 <P>
117 <BLOCKQUOTE><CODE>
118 <PRE>
119 '^sh\w*/buc', 'dbshow buckmaster', 'dbshow',
120 </PRE>
121 </CODE></BLOCKQUOTE>
122 <P>Now you can simply use show/buckmaster or an abreviation.
123 <P>
124 <H2><A NAME="ss5.5">5.5 Removing databases</A>
125 </H2>
126
127 <P>To delete an existing database you use the <EM>dbremove</EM> command.
128 For example ...
129 <P>
130 <BLOCKQUOTE><CODE>
131 <PRE>
132 dbremove oblast
133 </PRE>
134 </CODE></BLOCKQUOTE>
135 <P>would remove the oblast database and its associated datafile from the
136 system.  There are no warnings or recovery possible from this command.
137 If you remove a database it ceases to exist and would have to be created
138 from scratch if you still required it.
139 <P>
140 <HR>
141 <A HREF="adminmanual-6.html">Next</A>
142 <A HREF="adminmanual-4.html">Previous</A>
143 <A HREF="adminmanual.html#toc5">Contents</A>
144 </BODY>
145 </HTML>