Mercurial > hg > ltpda

comparison m-toolbox/html_help/help/ug/repo_whatis_content.html @ 0:f0afece42f48

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import.
author Daniele Nicolodi <nicolodi@science.unitn.it>
date Wed, 23 Nov 2011 19:22:13 +0100
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:f0afece42f48
1 <h2>Introduction</h2>
2
3 <p>
4 An LTPDA repository has at its core a database server (in fact, a <a href="matlab:web('http://www.mysql.com')">MySQL server</a>).
5 A single MySQL server can host multiple databases (LTPDA repositories).
6 A single database/repository comprises a particular set of database tables. These tables hold meta-data
7 about the objects stored in the database.
8 </p>
9
10 <p> Since the core engine is a MySQL database, in principle any MySQL client can be used to interface
11 with the repository. In order to submit and retrieve objects in the proper way (entering all expected
12 meta-data), it is strongly suggested that you use the LTPDA Toolbox client commands <tt>submit</tt> and
13 the <tt>From Repository</tt> constructors, or the <a href="workspaceBrowser.html">LTPDA Workspace Browser</a>.. In
14 addition, the LTPDA Workbench has full built-in support for interacting with LTPDA Repositories.
15 </p>
16
17 <p>
18 Any standard MySQL client can be used to query and search an LTPDA repository.
19 For example, using a web-client or the standard MySQL command-line interface.
20 In addition, the LTPDA Toolbox provides two ways to search the database: using the
21 workspace browser, or the LTPDA Workbench..
22 It is also possible to use the Visual Query Builder provided with the MATLAB Database Toolbox
23 for interacting with a repository.
24 </p>
25
26 <h2>Database primer</h2>
27
28 <p>
29 A MySQL database comprises a collection of tables. Each table has a number of fields.
30 Each field describes the type of data stored in that field (numerical, string, date, etc).
31 When an entry is made in a table a new row is created. Interaction with MySQL databases
32 is done using Structured Query Language (SQL) statements. For examples
33 see <a href="matlab:web('http://dev.mysql.com/doc/refman/5.1/en/examples.html')">MySQL Common Queries</a>.
34 </p>
35
36 <h2>Database design</h2>
37 <p>
38 The database for a single repository uses the tables as shown below:
39 </p>
40
41 <img src="images/db_tables.png" alt="DB Tables">
42
43 <p> As you can see, each object that is submitted to a repository receives a unique ID number. This ID
44 number is used to link together the various pieces of meta-data that are collected about each object. In
45 addition, each object that is submitted is check-summed using the <a
46 href="matlab:web('http://en.wikipedia.org/wiki/MD5')">MD5 algorithm</a>. That way, the integrity of each object can be
47 checked upon retrieval.
48 </p>
49
50 <p>
51 In order to access a particular repository you need:
52 <ul>
53 <li>The IP address of the MySQL host server</li>
54 <li>The name of the repository (the database name)</li>
55 <li>An account on the MySQL host server</li>
56 <li>Permissions to access the desired database/repository</li>
57 </ul>
58 </p>
59
60 <h2>The main database tables</h2>
61
62 <p>An LTPDA repository consists of the following database tables:</p>
63
64 <!-- OBJS table -->
65 <h3><tt>objs</tt> table</h3>
66 <p>The <tt>objs</tt> table stores the XML representation of the submitted object. At this point, each
67 object in the database is assigned a unique identifier. Together with the database name and hostname/ip
68 of the server, this forms a unique tag for all LTPDA objects.</p>
69 <p>
70 <table cellspacing="0" class="body" cellpadding="2" border="1" width="80%">
71 <colgroup>
72 <col width="10%"/>
73 <col width="10%"/>
74 <col width="80%"/>
75 </colgroup>
76 <thead>
77 <tr valign="top">
78 <th class="categorylist">Field</th>
79 <th class="categorylist">Data Type</th>
80 <th class="categorylist">Description</th>
81 </tr>
82 </thead>
83 <tbody>
84 <!-- Field: 'id' -->
85 <tr valign="top">
86 <td bgcolor="#f3f4f5">
87 <p><tt>id</tt></p>
88 </td>
89 <td bgcolor="#f3f4f5">
90 <p><tt>int(11)</tt></p>
91 </td>
92 <td bgcolor="#f3f4f5">
93 <p>A unique identification number for all LTPDA objects in this database. This value is the link between
94 all database tables.</p>
95 </td>
96 </tr>
97 <!-- Field: 'hash' -->
98 <tr valign="top">
99 <td bgcolor="#e3e4e5">
100 <p><tt>hash</tt></p>
101 </td>
102 <td bgcolor="#e3e4e5">
103 <p><tt>text</tt></p>
104 </td>
105 <td bgcolor="#e3e4e5">
106 <p>An MD5 hash of the XML representation of the object.</p>
107 </td>
108 </tr>
109 <!-- Field: 'xml' -->
110 <tr valign="top">
111 <td bgcolor="#f3f4f5">
112 <p><tt>xml</tt></p>
113 </td>
114 <td bgcolor="#f3f4f5">
115 <p><tt>longtext</tt></p>
116 </td>
117 <td bgcolor="#f3f4f5">
118 <p>The XML representation of the object. This field can be dumped directly to an XML file and
119 should be readable in LTPDA.</p>
120 </td>
121 </tr>
122 </tbody>
123 </table>
124 </p>
125
126 <!-- OBJMETA table -->
127 <h3><tt>objmeta</tt> table</h3>
128
129 <p>The <tt>objmeta</tt> table stores various pieces of information associated with the object
130 being submitted. The aim of this table is to provide a lot of useful fields on which to perform
131 searches and queries.</p>
132
133 <p>
134 <table cellspacing="0" class="body" cellpadding="2" border="1" width="80%">
135 <colgroup>
136 <col width="10%"/>
137 <col width="10%"/>
138 <col width="80%"/>
139 </colgroup>
140 <thead>
141 <tr valign="top">
142 <th class="categorylist">Field</th>
143 <th class="categorylist">Data Type</th>
144 <th class="categorylist">Description</th>
145 </tr>
146 </thead>
147 <tbody>
148 <!-- Field: 'id' -->
149 <tr valign="top">
150 <td bgcolor="#f3f4f5">
151 <p><tt>id</tt></p>
152 </td>
153 <td bgcolor="#f3f4f5">
154 <p><tt>int(11)</tt></p>
155 </td>
156 <td bgcolor="#f3f4f5">
157 <p>A unique identification for all entries in this table.</p>
158 </td>
159 </tr>
160 <!-- Field: 'obj_id' -->
161 <tr valign="top">
162 <td bgcolor="#e3e4e5">
163 <p><tt>obj_id</tt></p>
164 </td>
165 <td bgcolor="#e3e4e5">
166 <p><tt>int(11)</tt></p>
167 </td>
168 <td bgcolor="#e3e4e5">
169 <p>The object id of the object in the <tt>objs</tt> table.</p>
170 </td>
171 </tr>
172 <!-- Field: 'obj_type' -->
173 <tr valign="top">
174 <td bgcolor="#f3f4f5">
175 <p><tt>obj_type</tt></p>
176 </td>
177 <td bgcolor="#f3f4f5">
178 <p><tt>text</tt></p>
179 </td>
180 <td bgcolor="#f3f4f5">
181 <p>The (LTPDA) class of this object.</p>
182 </td>
183 </tr>
184 <!-- Field: 'name' -->
185 <tr valign="top">
186 <td bgcolor="#e3e4e5">
187 <p><tt>name</tt></p>
188 </td>
189 <td bgcolor="#e3e4e5">
190 <p><tt>text</tt></p>
191 </td>
192 <td bgcolor="#e3e4e5">
193 <p>The user-assigned name of this object.</p>
194 </td>
195 </tr>
196 <!-- Field: 'created' -->
197 <tr valign="top">
198 <td bgcolor="#f3f4f5">
199 <p><tt>created</tt></p>
200 </td>
201 <td bgcolor="#f3f4f5">
202 <p><tt>datetime</tt></p>
203 </td>
204 <td bgcolor="#f3f4f5">
205 <p>The date and time this object was created.</p>
206 </td>
207 </tr>
208 <!-- Field: 'version' -->
209 <tr valign="top">
210 <td bgcolor="#e3e4e5">
211 <p><tt>version</tt></p>
212 </td>
213 <td bgcolor="#e3e4e5">
214 <p><tt>text</tt></p>
215 </td>
216 <td bgcolor="#e3e4e5">
217 <p>The CVS tag of the object constructor code.</p>
218 </td>
219 </tr>
220 <!-- Field: 'ip' -->
221 <tr valign="top">
222 <td bgcolor="#f3f4f5">
223 <p><tt>ip</tt></p>
224 </td>
225 <td bgcolor="#f3f4f5">
226 <p><tt>text</tt></p>
227 </td>
228 <td bgcolor="#f3f4f5">
229 <p>The IP address of the machine which submitted the object.</p>
230 </td>
231 </tr>
232 <!-- Field: 'hostname' -->
233 <tr valign="top">
234 <td bgcolor="#e3e4e5">
235 <p><tt>hostname</tt></p>
236 </td>
237 <td bgcolor="#e3e4e5">
238 <p><tt>text</tt></p>
239 </td>
240 <td bgcolor="#e3e4e5">
241 <p>The hostname of the machine which submitted the object.</p>
242 </td>
243 </tr>
244 <!-- Field: 'os' -->
245 <tr valign="top">
246 <td bgcolor="#f3f4f5">
247 <p><tt>os</tt></p>
248 </td>
249 <td bgcolor="#f3f4f5">
250 <p><tt>text</tt></p>
251 </td>
252 <td bgcolor="#f3f4f5">
253 <p>The operating system of the machine which submitted the object.</p>
254 </td>
255 </tr>
256 <!-- Field: 'submitted' -->
257 <tr valign="top">
258 <td bgcolor="#e3e4e5">
259 <p><tt>submitted</tt></p>
260 </td>
261 <td bgcolor="#e3e4e5">
262 <p><tt>datetime</tt></p>
263 </td>
264 <td bgcolor="#e3e4e5">
265 <p>The date and time the object was submitted.</p>
266 </td>
267 </tr>
268 <!-- Field: 'experiment_title' -->
269 <tr valign="top">
270 <td bgcolor="#f3f4f5">
271 <p><tt>experiment_title</tt></p>
272 </td>
273 <td bgcolor="#f3f4f5">
274 <p><tt>text</tt></p>
275 </td>
276 <td bgcolor="#f3f4f5">
277 <p>A title for the experiment associated with the object.</p>
278 </td>
279 </tr>
280 <!-- Field: 'experiment_desc' -->
281 <tr valign="top">
282 <td bgcolor="#e3e4e5">
283 <p><tt>experiment_desc</tt></p>
284 </td>
285 <td bgcolor="#e3e4e5">
286 <p><tt>text</tt></p>
287 </td>
288 <td bgcolor="#e3e4e5">
289 <p>A description of the experiment associated with the object.</p>
290 </td>
291 </tr>
292 <!-- Field: 'analysis_desc' -->
293 <tr valign="top">
294 <td bgcolor="#f3f4f5">
295 <p><tt>analysis_desc</tt></p>
296 </td>
297 <td bgcolor="#f3f4f5">
298 <p><tt>text</tt></p>
299 </td>
300 <td bgcolor="#f3f4f5">
301 <p>A description of the analysis associated with the object.</p>
302 </td>
303 </tr>
304 <!-- Field: 'quantity' -->
305 <tr valign="top">
306 <td bgcolor="#e3e4e5">
307 <p><tt>quantity</tt></p>
308 </td>
309 <td bgcolor="#e3e4e5">
310 <p><tt>text</tt></p>
311 </td>
312 <td bgcolor="#e3e4e5">
313 <p>If applicable, the physical quantity associated with the data in the object.</p>
314 </td>
315 </tr>
316 <!-- Field: 'additional_authors' -->
317 <tr valign="top">
318 <td bgcolor="#f3f4f5">
319 <p><tt>additional_authors</tt></p>
320 </td>
321 <td bgcolor="#f3f4f5">
322 <p><tt>text</tt></p>
323 </td>
324 <td bgcolor="#f3f4f5">
325 <p>Any additional people involved in creating this object.</p>
326 </td>
327 </tr>
328 <!-- Field: 'additional_comments' -->
329 <tr valign="top">
330 <td bgcolor="#e3e4e5">
331 <p><tt>additional_comments</tt></p>
332 </td>
333 <td bgcolor="#e3e4e5">
334 <p><tt>text</tt></p>
335 </td>
336 <td bgcolor="#e3e4e5">
337 <p>A free-form field of additional comments.</p>
338 </td>
339 </tr>
340 <!-- Field: 'keywords' -->
341 <tr valign="top">
342 <td bgcolor="#f3f4f5">
343 <p><tt>keywords</tt></p>
344 </td>
345 <td bgcolor="#f3f4f5">
346 <p><tt>text</tt></p>
347 </td>
348 <td bgcolor="#f3f4f5">
349 <p>A list of keywords associated with the object.</p>
350 </td>
351 </tr>
352 <!-- Field: 'reference_ids' -->
353 <tr valign="top">
354 <td bgcolor="#e3e4e5">
355 <p><tt>reference_ids</tt></p>
356 </td>
357 <td bgcolor="#e3e4e5">
358 <p><tt>text</tt></p>
359 </td>
360 <td bgcolor="#e3e4e5">
361 <p>ID numbers of any other objects associated with this object.</p>
362 </td>
363 </tr>
364 <!-- Field: 'validated' -->
365 <tr valign="top">
366 <td bgcolor="#f3f4f5">
367 <p><tt>validated</tt></p>
368 </td>
369 <td bgcolor="#f3f4f5">
370 <p><tt>tinyint(1)</tt></p>
371 </td>
372 <td bgcolor="#f3f4f5">
373 <p>A boolean field indended to indicate validated objects.</p>
374 </td>
375 </tr>
376 <!-- Field: 'vdate' -->
377 <tr valign="top">
378 <td bgcolor="#e3e4e5">
379 <p><tt>vdate</tt></p>
380 </td>
381 <td bgcolor="#e3e4e5">
382 <p><tt>datetime</tt></p>
383 </td>
384 <td bgcolor="#e3e4e5">
385 <p>The date/time the object was validated.</p>
386 </td>
387 </tr>
388 </tbody>
389 </table>
390 </p>
391
392
393 <!-- TRANSACTIONS table -->
394 <h3><tt>transactions</tt> table</h3>
395 <p>The <tt>transactions</tt> table records all user transactions. A transaction corresponds to
396 submitting or retrieving a single or a collection of LTPDA objects.</p>
397 <p>
398 <table cellspacing="0" class="body" cellpadding="2" border="1" width="80%">
399 <colgroup>
400 <col width="10%"/>
401 <col width="10%"/>
402 <col width="80%"/>
403 </colgroup>
404 <thead>
405 <tr valign="top">
406 <th class="categorylist">Field</th>
407 <th class="categorylist">Data Type</th>
408 <th class="categorylist">Description</th>
409 </tr>
410 </thead>
411 <tbody>
412 <!-- Field: 'id' -->
413 <tr valign="top">
414 <td bgcolor="#f3f4f5">
415 <p><tt>id</tt></p>
416 </td>
417 <td bgcolor="#f3f4f5">
418 <p><tt>int(11)</tt></p>
419 </td>
420 <td bgcolor="#f3f4f5">
421 <p>A unique identification number this table entry.</p>
422 </td>
423 </tr>
424 <!-- Field: 'obj_id' -->
425 <tr valign="top">
426 <td bgcolor="#e3e4e5">
427 <p><tt>obj_id</tt></p>
428 </td>
429 <td bgcolor="#e3e4e5">
430 <p><tt>int(11)</tt></p>
431 </td>
432 <td bgcolor="#e3e4e5">
433 <p>The object id of the object in the <tt>objs</tt> table.</p>
434 </td>
435 </tr>
436 <!-- Field: 'user_id' -->
437 <tr valign="top">
438 <td bgcolor="#f3f4f5">
439 <p><tt>user_id</tt></p>
440 </td>
441 <td bgcolor="#f3f4f5">
442 <p><tt>int(11)</tt></p>
443 </td>
444 <td bgcolor="#f3f4f5">
445 <p>The unique ID number of the user who carried out the transaction.</p>
446 </td>
447 </tr>
448 <!-- Field: 'transdate' -->
449 <tr valign="top">
450 <td bgcolor="#e3e4e5">
451 <p><tt>transdate</tt></p>
452 </td>
453 <td bgcolor="#e3e4e5">
454 <p><tt>datetime</tt></p>
455 </td>
456 <td bgcolor="#e3e4e5">
457 <p>The date/time of the transaction.</p>
458 </td>
459 </tr>
460 <!-- Field: 'direction' -->
461 <tr valign="top">
462 <td bgcolor="#f3f4f5">
463 <p><tt>direction</tt></p>
464 </td>
465 <td bgcolor="#f3f4f5">
466 <p><tt>text</tt></p>
467 </td>
468 <td bgcolor="#f3f4f5">
469 <p>The direction of the transaction: 'in' or 'out'.</p>
470 </td>
471 </tr>
472 </tbody>
473 </table>
474 </p>
475
476 <!-- USERS table -->
477 <h3><tt>users</tt> table</h3>
478 <p>The <tt>users</tt> table stores information about the users allowed to access the database.</p>
479 <p>
480 <table cellspacing="0" class="body" cellpadding="2" border="1" width="80%">
481 <colgroup>
482 <col width="10%"/>
483 <col width="10%"/>
484 <col width="80%"/>
485 </colgroup>
486 <thead>
487 <tr valign="top">
488 <th class="categorylist">Field</th>
489 <th class="categorylist">Data Type</th>
490 <th class="categorylist">Description</th>
491 </tr>
492 </thead>
493 <tbody>
494 <!-- Field: 'id' -->
495 <tr valign="top">
496 <td bgcolor="#f3f4f5">
497 <p><tt>id</tt></p>
498 </td>
499 <td bgcolor="#f3f4f5">
500 <p><tt>int(11)</tt></p>
501 </td>
502 <td bgcolor="#f3f4f5">
503 <p>A unique identification number for all entries in this table.</p>
504 </td>
505 </tr>
506 <!-- Field: 'firstname' -->
507 <tr valign="top">
508 <td bgcolor="#e3e4e5">
509 <p><tt>firstname</tt></p>
510 </td>
511 <td bgcolor="#e3e4e5">
512 <p><tt>text</tt></p>
513 </td>
514 <td bgcolor="#e3e4e5">
515 <p>The firstname of the user.</p>
516 </td>
517 </tr>
518 <!-- Field: 'familyname' -->
519 <tr valign="top">
520 <td bgcolor="#f3f4f5">
521 <p><tt>familyname</tt></p>
522 </td>
523 <td bgcolor="#f3f4f5">
524 <p><tt>text</tt></p>
525 </td>
526 <td bgcolor="#f3f4f5">
527 <p>The family name of the user.</p>
528 </td>
529 </tr>
530 <!-- Field: 'username' -->
531 <tr valign="top">
532 <td bgcolor="#e3e4e5">
533 <p><tt>username</tt></p>
534 </td>
535 <td bgcolor="#e3e4e5">
536 <p><tt>text</tt></p>
537 </td>
538 <td bgcolor="#e3e4e5">
539 <p>The username (login name) of the user.</p>
540 </td>
541 </tr>
542 <!-- Field: 'email' -->
543 <tr valign="top">
544 <td bgcolor="#f3f4f5">
545 <p><tt>email</tt></p>
546 </td>
547 <td bgcolor="#f3f4f5">
548 <p><tt>text</tt></p>
549 </td>
550 <td bgcolor="#f3f4f5">
551 <p>A valid e-mail address for the user.</p>
552 </td>
553 </tr>
554 <!-- Field: 'telephone' -->
555 <tr valign="top">
556 <td bgcolor="#e3e4e5">
557 <p><tt>telephone</tt></p>
558 </td>
559 <td bgcolor="#e3e4e5">
560 <p><tt>text</tt></p>
561 </td>
562 <td bgcolor="#e3e4e5">
563 <p>A telephone numnber for the user.</p>
564 </td>
565 </tr>
566 <!-- Field: 'institution' -->
567 <tr valign="top">
568 <td bgcolor="#f3f4f5">
569 <p><tt>institution</tt></p>
570 </td>
571 <td bgcolor="#f3f4f5">
572 <p><tt>text</tt></p>
573 </td>
574 <td bgcolor="#f3f4f5">
575 <p>The institution of the user.</p>
576 </td>
577 </tr>
578 </tbody>
579 </table>
580 </p>
581
582 <!-- COLLECTIONS table -->
583 <h3><tt>collections</tt> table</h3>
584 <p>The <tt>collections</tt> table stores virtual collections of objects submitted to the database.
585 When the user submits one or more objects at the same time, this constitutes a collection. In this
586 case a collection ID number is assigned next to a list of the object IDs in the collection. This
587 allows the user to retrieve collections of objects based on the collection ID alone; no information
588 about the individual object IDs is required.</p>
589 <p>
590 <table cellspacing="0" class="body" cellpadding="2" border="1" width="80%">
591 <colgroup>
592 <col width="10%"/>
593 <col width="10%"/>
594 <col width="80%"/>
595 </colgroup>
596 <thead>
597 <tr valign="top">
598 <th class="categorylist">Field</th>
599 <th class="categorylist">Data Type</th>
600 <th class="categorylist">Description</th>
601 </tr>
602 </thead>
603 <tbody>
604 <!-- Field: 'id' -->
605 <tr valign="top">
606 <td bgcolor="#f3f4f5">
607 <p><tt>id</tt></p>
608 </td>
609 <td bgcolor="#f3f4f5">
610 <p><tt>int(11)</tt></p>
611 </td>
612 <td bgcolor="#f3f4f5">
613 <p>A unique identification number for this collection of objects.</p>
614 </td>
615 </tr>
616 <!-- Field: 'nobjs' -->
617 <tr valign="top">
618 <td bgcolor="#e3e4e5">
619 <p><tt>nobjs</tt></p>
620 </td>
621 <td bgcolor="#e3e4e5">
622 <p><tt>int</tt></p>
623 </td>
624 <td bgcolor="#e3e4e5">
625 <p>The number of objects in the collection.</p>
626 </td>
627 </tr>
628 <!-- Field: 'obj_ids' -->
629 <tr valign="top">
630 <td bgcolor="#f3f4f5">
631 <p><tt>obj_ids</tt></p>
632 </td>
633 <td bgcolor="#f3f4f5">
634 <p><tt>text</tt></p>
635 </td>
636 <td bgcolor="#f3f4f5">
637 <p>A comma separated list of object IDs.</p>
638 </td>
639 </tr>
640 </tbody>
641 </table>
642 </p>
643
644
645 <h2>Additional database tables</h2>
646
647 <p>As well as the main database tables, additional meta-data tables are used to capture extra meta-data
648 about some of the LTPDA objects.</p>
649
650 <!-- AO table -->
651 <h3><tt>ao</tt> table</h3>
652 <p>The <tt>ao</tt> table stores additional meta-data specific to analysis objects.</p>
653 <p>
654 <table cellspacing="0" class="body" cellpadding="2" border="1" width="80%">
655 <colgroup>
656 <col width="10%"/>
657 <col width="10%"/>
658 <col width="80%"/>
659 </colgroup>
660 <thead>
661 <tr valign="top">
662 <th class="categorylist">Field</th>
663 <th class="categorylist">Data Type</th>
664 <th class="categorylist">Description</th>
665 </tr>
666 </thead>
667 <tbody>
668 <!-- Field: 'id' -->
669 <tr valign="top">
670 <td bgcolor="#f3f4f5">
671 <p><tt>id</tt></p>
672 </td>
673 <td bgcolor="#f3f4f5">
674 <p><tt>int(11)</tt></p>
675 </td>
676 <td bgcolor="#f3f4f5">
677 <p>A unique identification number for all entries in the table.</p>
678 </td>
679 </tr>
680 <!-- Field: 'obj_id' -->
681 <tr valign="top">
682 <td bgcolor="#e3e4e5">
683 <p><tt>obj_id</tt></p>
684 </td>
685 <td bgcolor="#e3e4e5">
686 <p><tt>int(11)</tt></p>
687 </td>
688 <td bgcolor="#e3e4e5">
689 <p>The unique ID of the object.</p>
690 </td>
691 </tr>
692 <!-- Field: 'data_type' -->
693 <tr valign="top">
694 <td bgcolor="#f3f4f5">
695 <p><tt>data_type</tt></p>
696 </td>
697 <td bgcolor="#f3f4f5">
698 <p><tt>text</tt></p>
699 </td>
700 <td bgcolor="#f3f4f5">
701 <p>The type/class of the data stored in the AO.</p>
702 </td>
703 </tr>
704 <!-- Field: 'data_id' -->
705 <tr valign="top">
706 <td bgcolor="#e3e4e5">
707 <p><tt>data_id</tt></p>
708 </td>
709 <td bgcolor="#e3e4e5">
710 <p><tt>int(11)</tt></p>
711 </td>
712 <td bgcolor="#e3e4e5">
713 <p>The unique ID of the data object listed in one of the data meta-data tables.</p>
714 </td>
715 </tr>
716 <!-- Field: 'description' -->
717 <tr valign="top">
718 <td bgcolor="#f3f4f5">
719 <p><tt>description</tt></p>
720 </td>
721 <td bgcolor="#f3f4f5">
722 <p><tt>text</tt></p>
723 </td>
724 <td bgcolor="#f3f4f5">
725 <p>The description property of the AO.</p>
726 </td>
727 </tr>
728 <!-- Field: 'mfilename' -->
729 <tr valign="top">
730 <td bgcolor="#e3e4e5">
731 <p><tt>mfilename</tt></p>
732 </td>
733 <td bgcolor="#e3e4e5">
734 <p><tt>text</tt></p>
735 </td>
736 <td bgcolor="#e3e4e5">
737 <p>The filename of any m-file attached to the AO.</p>
738 </td>
739 </tr>
740 <!-- Field: 'mdlfilename' -->
741 <tr valign="top">
742 <td bgcolor="#f3f4f5">
743 <p><tt>mdlfilename</tt></p>
744 </td>
745 <td bgcolor="#f3f4f5">
746 <p><tt>text</tt></p>
747 </td>
748 <td bgcolor="#f3f4f5">
749 <p>The filename of any SIMULINK model file attached to the AO.</p>
750 </td>
751 </tr>
752 </tbody>
753 </table>
754 </p>
755
756 <!-- MIIR table -->
757 <h3><tt>miir</tt> table</h3>
758 <p>The <tt>miir</tt> table stores additional meta-data specific to miir filter objects.</p>
759 <p>
760 <table cellspacing="0" class="body" cellpadding="2" border="1" width="80%">
761 <colgroup>
762 <col width="10%"/>
763 <col width="10%"/>
764 <col width="80%"/>
765 </colgroup>
766 <thead>
767 <tr valign="top">
768 <th class="categorylist">Field</th>
769 <th class="categorylist">Data Type</th>
770 <th class="categorylist">Description</th>
771 </tr>
772 </thead>
773 <tbody>
774 <!-- Field: 'id' -->
775 <tr valign="top">
776 <td bgcolor="#f3f4f5">
777 <p><tt>id</tt></p>
778 </td>
779 <td bgcolor="#f3f4f5">
780 <p><tt>int(11)</tt></p>
781 </td>
782 <td bgcolor="#f3f4f5">
783 <p>A unique identification number for all entries in the table.</p>
784 </td>
785 </tr>
786 <!-- Field: 'obj_id' -->
787 <tr valign="top">
788 <td bgcolor="#e3e4e5">
789 <p><tt>obj_id</tt></p>
790 </td>
791 <td bgcolor="#e3e4e5">
792 <p><tt>int(11)</tt></p>
793 </td>
794 <td bgcolor="#e3e4e5">
795 <p>The unique ID of the object.</p>
796 </td>
797 </tr>
798 <!-- Field: 'in_file' -->
799 <tr valign="top">
800 <td bgcolor="#f3f4f5">
801 <p><tt>in_file</tt></p>
802 </td>
803 <td bgcolor="#f3f4f5">
804 <p><tt>text</tt></p>
805 </td>
806 <td bgcolor="#f3f4f5">
807 <p>The input filename (if applicable) used to create the filter object</p>
808 </td>
809 </tr>
810 <!-- Field: 'fs' -->
811 <tr valign="top">
812 <td bgcolor="#e3e4e5">
813 <p><tt>fs</tt></p>
814 </td>
815 <td bgcolor="#e3e4e5">
816 <p><tt>int(11)</tt></p>
817 </td>
818 <td bgcolor="#e3e4e5">
819 <p>The sample rate of the data the filter is designed for.</p>
820 </td>
821 </tr>
822 </tbody>
823 </table>
824 </p>
825
826 <!-- MFIR table -->
827 <h3><tt>mfir</tt> table</h3>
828 <p>The <tt>mfir</tt> table stores additional meta-data specific to mfir filter objects.</p>
829 <p>
830 <table cellspacing="0" class="body" cellpadding="2" border="1" width="80%">
831 <colgroup>
832 <col width="10%"/>
833 <col width="10%"/>
834 <col width="80%"/>
835 </colgroup>
836 <thead>
837 <tr valign="top">
838 <th class="categorylist">Field</th>
839 <th class="categorylist">Data Type</th>
840 <th class="categorylist">Description</th>
841 </tr>
842 </thead>
843 <tbody>
844 <!-- Field: 'id' -->
845 <tr valign="top">
846 <td bgcolor="#f3f4f5">
847 <p><tt>id</tt></p>
848 </td>
849 <td bgcolor="#f3f4f5">
850 <p><tt>int(11)</tt></p>
851 </td>
852 <td bgcolor="#f3f4f5">
853 <p>A unique identification number for all entries in the table.</p>
854 </td>
855 </tr>
856 <!-- Field: 'obj_id' -->
857 <tr valign="top">
858 <td bgcolor="#e3e4e5">
859 <p><tt>obj_id</tt></p>
860 </td>
861 <td bgcolor="#e3e4e5">
862 <p><tt>int(11)</tt></p>
863 </td>
864 <td bgcolor="#e3e4e5">
865 <p>The unique ID of the object.</p>
866 </td>
867 </tr>
868 <!-- Field: 'in_file' -->
869 <tr valign="top">
870 <td bgcolor="#f3f4f5">
871 <p><tt>in_file</tt></p>
872 </td>
873 <td bgcolor="#f3f4f5">
874 <p><tt>text</tt></p>
875 </td>
876 <td bgcolor="#f3f4f5">
877 <p>The input filename (if applicable) used to create the filter object</p>
878 </td>
879 </tr>
880 <!-- Field: 'fs' -->
881 <tr valign="top">
882 <td bgcolor="#e3e4e5">
883 <p><tt>fs</tt></p>
884 </td>
885 <td bgcolor="#e3e4e5">
886 <p><tt>int(11)</tt></p>
887 </td>
888 <td bgcolor="#e3e4e5">
889 <p>The sample rate of the data the filter is designed for.</p>
890 </td>
891 </tr>
892 </tbody>
893 </table>
894 </p>
895
896 <!-- TSDATA table -->
897 <h3><tt>tsdata</tt> table</h3>
898 <p>The <tt>tsdata</tt> table stores additional meta-data specific to tsdata (time-series data) objects.</p>
899 <p>
900 <table cellspacing="0" class="body" cellpadding="2" border="1" width="80%">
901 <colgroup>
902 <col width="10%"/>
903 <col width="10%"/>
904 <col width="80%"/>
905 </colgroup>
906 <thead>
907 <tr valign="top">
908 <th class="categorylist">Field</th>
909 <th class="categorylist">Data Type</th>
910 <th class="categorylist">Description</th>
911 </tr>
912 </thead>
913 <tbody>
914 <!-- Field: 'id' -->
915 <tr valign="top">
916 <td bgcolor="#f3f4f5">
917 <p><tt>id</tt></p>
918 </td>
919 <td bgcolor="#f3f4f5">
920 <p><tt>int(11)</tt></p>
921 </td>
922 <td bgcolor="#f3f4f5">
923 <p>A unique identification number for all entries in the table.</p>
924 </td>
925 </tr>
926 <!-- Field: 'xunits' -->
927 <tr valign="top">
928 <td bgcolor="#e3e4e5">
929 <p><tt>xunits</tt></p>
930 </td>
931 <td bgcolor="#e3e4e5">
932 <p><tt>text</tt></p>
933 </td>
934 <td bgcolor="#e3e4e5">
935 <p>The X-units associated with this time-series.</p>
936 </td>
937 </tr>
938 <!-- Field: 'yunits' -->
939 <tr valign="top">
940 <td bgcolor="#f3f4f5">
941 <p><tt>yunits</tt></p>
942 </td>
943 <td bgcolor="#f3f4f5">
944 <p><tt>text</tt></p>
945 </td>
946 <td bgcolor="#f3f4f5">
947 <p>The Y-units associated with this time-series.</p>
948 </td>
949 </tr>
950 <!-- Field: 'fs' -->
951 <tr valign="top">
952 <td bgcolor="#e3e4e5">
953 <p><tt>fs</tt></p>
954 </td>
955 <td bgcolor="#e3e4e5">
956 <p><tt>int(11)</tt></p>
957 </td>
958 <td bgcolor="#e3e4e5">
959 <p>The sample rate of the data the filter is designed for.</p>
960 </td>
961 </tr>
962 <!-- Field: 'nsecs' -->
963 <tr valign="top">
964 <td bgcolor="#f3f4f5">
965 <p><tt>nsecs</tt></p>
966 </td>
967 <td bgcolor="#f3f4f5">
968 <p><tt>int</tt></p>
969 </td>
970 <td bgcolor="#f3f4f5">
971 <p>The duration (number of seconds) of data in the object.</p>
972 </td>
973 </tr>
974 <!-- Field: 't0' -->
975 <tr valign="top">
976 <td bgcolor="#e3e4e5">
977 <p><tt>t0</tt></p>
978 </td>
979 <td bgcolor="#e3e4e5">
980 <p><tt>datetime</tt></p>
981 </td>
982 <td bgcolor="#e3e4e5">
983 <p>The date/time associated with the start (first sample) of the time-series.</p>
984 </td>
985 </tr>
986 </tbody>
987 </table>
988 </p>
989
990 <!-- FSDATA table -->
991 <h3><tt>fsdata</tt> table</h3>
992 <p>The <tt>fsdata</tt> table stores additional meta-data specific to fsdata (frequency-series data) objects.</p>
993 <p>
994 <table cellspacing="0" class="body" cellpadding="2" border="1" width="80%">
995 <colgroup>
996 <col width="10%"/>
997 <col width="10%"/>
998 <col width="80%"/>
999 </colgroup>
1000 <thead>
1001 <tr valign="top">
1002 <th class="categorylist">Field</th>
1003 <th class="categorylist">Data Type</th>
1004 <th class="categorylist">Description</th>
1005 </tr>
1006 </thead>
1007 <tbody>
1008 <!-- Field: 'id' -->
1009 <tr valign="top">
1010 <td bgcolor="#f3f4f5">
1011 <p><tt>id</tt></p>
1012 </td>
1013 <td bgcolor="#f3f4f5">
1014 <p><tt>int(11)</tt></p>
1015 </td>
1016 <td bgcolor="#f3f4f5">
1017 <p>A unique identification number for all entries in the table.</p>
1018 </td>
1019 </tr>
1020 <!-- Field: 'xunits' -->
1021 <tr valign="top">
1022 <td bgcolor="#e3e4e5">
1023 <p><tt>xunits</tt></p>
1024 </td>
1025 <td bgcolor="#e3e4e5">
1026 <p><tt>text</tt></p>
1027 </td>
1028 <td bgcolor="#e3e4e5">
1029 <p>The X-units associated with this time-series.</p>
1030 </td>
1031 </tr>
1032 <!-- Field: 'yunits' -->
1033 <tr valign="top">
1034 <td bgcolor="#f3f4f5">
1035 <p><tt>yunits</tt></p>
1036 </td>
1037 <td bgcolor="#f3f4f5">
1038 <p><tt>text</tt></p>
1039 </td>
1040 <td bgcolor="#f3f4f5">
1041 <p>The Y-units associated with this time-series.</p>
1042 </td>
1043 </tr>
1044 <!-- Field: 'fs' -->
1045 <tr valign="top">
1046 <td bgcolor="#e3e4e5">
1047 <p><tt>fs</tt></p>
1048 </td>
1049 <td bgcolor="#e3e4e5">
1050 <p><tt>int(11)</tt></p>
1051 </td>
1052 <td bgcolor="#e3e4e5">
1053 <p>The sample rate of the data the filter is designed for.</p>
1054 </td>
1055 </tr>
1056 </tbody>
1057 </table>
1058 </p>
1059
1060 <!-- CDATA table -->
1061 <h3><tt>cdata</tt> table</h3>
1062 <p>The <tt>cdata</tt> table stores additional meta-data specific to cdata (1D data) objects.</p>
1063 <p>
1064 <table cellspacing="0" class="body" cellpadding="2" border="1" width="80%">
1065 <colgroup>
1066 <col width="10%"/>
1067 <col width="10%"/>
1068 <col width="80%"/>
1069 </colgroup>
1070 <thead>
1071 <tr valign="top">
1072 <th class="categorylist">Field</th>
1073 <th class="categorylist">Data Type</th>
1074 <th class="categorylist">Description</th>
1075 </tr>
1076 </thead>
1077 <tbody>
1078 <!-- Field: 'id' -->
1079 <tr valign="top">
1080 <td bgcolor="#f3f4f5">
1081 <p><tt>id</tt></p>
1082 </td>
1083 <td bgcolor="#f3f4f5">
1084 <p><tt>int(11)</tt></p>
1085 </td>
1086 <td bgcolor="#f3f4f5">
1087 <p>A unique identification number for all entries in the table.</p>
1088 </td>
1089 </tr>
1090 <!-- Field: 'xunits' -->
1091 <tr valign="top">
1092 <td bgcolor="#e3e4e5">
1093 <p><tt>xunits</tt></p>
1094 </td>
1095 <td bgcolor="#e3e4e5">
1096 <p><tt>text</tt></p>
1097 </td>
1098 <td bgcolor="#e3e4e5">
1099 <p>The X-units associated with this time-series.</p>
1100 </td>
1101 </tr>
1102 <!-- Field: 'yunits' -->
1103 <tr valign="top">
1104 <td bgcolor="#f3f4f5">
1105 <p><tt>yunits</tt></p>
1106 </td>
1107 <td bgcolor="#f3f4f5">
1108 <p><tt>text</tt></p>
1109 </td>
1110 <td bgcolor="#f3f4f5">
1111 <p>The Y-units associated with this time-series.</p>
1112 </td>
1113 </tr>
1114 </tbody>
1115 </table>
1116 </p>
1117
1118 <!-- CDATA table -->
1119 <h3><tt>xydata</tt> table</h3>
1120 <p>The <tt>xydata</tt> table stores additional meta-data specific to xydata (2D data) objects.</p>
1121 <p>
1122 <table cellspacing="0" class="body" cellpadding="2" border="1" width="80%">
1123 <colgroup>
1124 <col width="10%"/>
1125 <col width="10%"/>
1126 <col width="80%"/>
1127 </colgroup>
1128 <thead>
1129 <tr valign="top">
1130 <th class="categorylist">Field</th>
1131 <th class="categorylist">Data Type</th>
1132 <th class="categorylist">Description</th>
1133 </tr>
1134 </thead>
1135 <tbody>
1136 <!-- Field: 'id' -->
1137 <tr valign="top">
1138 <td bgcolor="#f3f4f5">
1139 <p><tt>id</tt></p>
1140 </td>
1141 <td bgcolor="#f3f4f5">
1142 <p><tt>int(11)</tt></p>
1143 </td>
1144 <td bgcolor="#f3f4f5">
1145 <p>A unique identification number for all entries in the table.</p>
1146 </td>
1147 </tr>
1148 <!-- Field: 'xunits' -->
1149 <tr valign="top">
1150 <td bgcolor="#e3e4e5">
1151 <p><tt>xunits</tt></p>
1152 </td>
1153 <td bgcolor="#e3e4e5">
1154 <p><tt>text</tt></p>
1155 </td>
1156 <td bgcolor="#e3e4e5">
1157 <p>The X-units associated with this time-series.</p>
1158 </td>
1159 </tr>
1160 <!-- Field: 'yunits' -->
1161 <tr valign="top">
1162 <td bgcolor="#f3f4f5">
1163 <p><tt>yunits</tt></p>
1164 </td>
1165 <td bgcolor="#f3f4f5">
1166 <p><tt>text</tt></p>
1167 </td>
1168 <td bgcolor="#f3f4f5">
1169 <p>The Y-units associated with this time-series.</p>
1170 </td>
1171 </tr>
1172 </tbody>
1173 </table>
1174 </p>