/[webpac]/openisis/current/doc/Options.txt
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Contents of /openisis/current/doc/Options.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 237 - (show annotations)
Mon Mar 8 17:43:12 2004 UTC (16 years, 7 months ago) by dpavlin
File MIME type: text/plain
File size: 2937 byte(s)
initial import of openisis 0.9.0 vendor drop

1 The options record contains the complete metadata of a database.
2 It uses tags in the range 800-899.
3 If there is an .opt file for the Db,
4 it contains a plaintext record of database options.
5
6 Else, from a new-style plaintext database, record 0 is used.
7 However, only the options range 850-899 has persistent properties of a database;
8 other options are stored in record 0 not or only as a hint.
9
10
11 Database options fall into several groups:
12 - files and modes
13 - tuning options
14 - charset and collation
15 - field definition
16 - miscellaneous info
17 - named views and index definition
18
19
20 * files and modes
21
22 | tag | Cname | name | description
23 | 800 | DNAME | db | short name of db
24 | 801 | DTYPE | format | aligned, naligned or autoformat (default)
25 | 802 | DRO | ro | if 1/0/absent, open read/write/as of file permissions
26 | 803 | DPATH | dbpath | path to database
27 | 804 | DDUMP | internaldump | (unused)
28 | 811 | DFDT | fdt | path to (traditional) fdt
29 | 810 | DENC | encoding | encoding (character set) of data
30
31
32
33 * field definition
34
35 The compact field definition as described in
36 > Meta
37 uses field 890.
38 | tag | C-name | name | description
39 | 890 | FDEF | fdef | field definition
40
41
42 In a long form, each field, subfield, enum value or other field
43 related information is representated as a record using tags in
44 the range 860-879.
45
46
47 C-name is the name of the constant in C code (with prefix OPENISIS_),
48 field is the corresponding field in the struct OpenIsisFd,
49 name is the tags name as it can be used in Fdt-aware environments like Tcl.
50
51 | tag | C-name | field | name | description
52 | 860 | FDID | id | tag | key: the tag described by this entry
53 | 861 | FDSUB | subf | subfield | key: the subfield described (or absent)
54 | 862 | FDTYPE | type | type | code for field type; see table below
55 | 863 | FDREP | rep | repeatable | whether field is repeatable (0/1)
56 | 864 | FDNUMC | slen | numchilds | number of subfields (redundant)
57 | 865 | FDLEN | len | length | max length or enum value
58 | 866 | FDNAME | name | name | tags identifier name; max 30
59 | 867 | FDDESC | desc | description | tags verbose name; max 30
60 | 868 | FDPAT | pat | pattern | pattern for field
61 | 869 | FDDFLT | dflt | default | default value
62 | 870 | FDINFO | info | info | embedded record with additional info
63 | 871 | FDCHLD | subs | children | embedded record for subfields (unused)
64
65
66 Tags used to define a database
67 | tag | C-name | name | description
68 | 880 | FDT_LEN | flen | number of embedded FD records
69 | 881 | FDT_FD | fd | embedded FD record with fields 860-879
70 | 882 | FDT_REC | frec | embedded FDT header record with fields 850-852
71
72
73 For informational purposes, traditional FDT parameters are mapped.
74 | tag | Cnam | description
75 | 850 | DFMT | worksheets from the FDT's W line
76 | 851 | DPFT | printformats from the FDT's F line
77 | 852 | DFST | field selection table from the FDT's S line
78
79 ---
80 $Id: Options.txt,v 1.3 2003/06/30 09:49:00 kripke Exp $

  ViewVC Help
Powered by ViewVC 1.1.26