blob: 9b8274b29641f93778ed9b7244b62e4f01bbf6eb (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
<HTML>
<HEAD>
<TITLE>FS::dbdef - Database objects</TITLE>
<LINK REV="made" HREF="mailto:ivan@rootwood.sisd.com">
</HEAD>
<BODY>
<!-- INDEX BEGIN -->
<UL>
<LI><A HREF="#NAME">NAME</A>
<LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
<LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
<LI><A HREF="#METHODS">METHODS</A>
<LI><A HREF="#BUGS">BUGS</A>
<LI><A HREF="#SEE_ALSO">SEE ALSO</A>
</UL>
<!-- INDEX END -->
<HR>
<P>
<H1><A NAME="NAME">NAME</A></H1>
<P>
FS::dbdef - Database objects
<P>
<HR>
<H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
<P>
<PRE> use FS::dbdef;
</PRE>
<P>
<PRE> $dbdef = new FS::dbdef (@dbdef_table_objects);
$dbdef = load FS::dbdef "filename";
</PRE>
<P>
<PRE> $dbdef->save("filename");
</PRE>
<P>
<PRE> $dbdef->addtable($dbdef_table_object);
</PRE>
<P>
<PRE> @table_names = $dbdef->tables;
</PRE>
<P>
<PRE> $FS_dbdef_table_object = $dbdef->table;
</PRE>
<P>
<HR>
<H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
<P>
FS::dbdef objects are collections of FS::dbdef_table objects and represnt a
database (a collection of tables).
<P>
<HR>
<H1><A NAME="METHODS">METHODS</A></H1>
<DL>
<DT><STRONG><A NAME="item_new">new TABLE, TABLE, ...</A></STRONG><DD>
<P>
Creates a new FS::dbdef object
<DT><STRONG><A NAME="item_load">load FILENAME</A></STRONG><DD>
<P>
Loads an FS::dbdef object from a file.
<DT><STRONG><A NAME="item_save">save FILENAME</A></STRONG><DD>
<P>
Saves an FS::dbdef object to a file.
<DT><STRONG><A NAME="item_addtable">addtable TABLE</A></STRONG><DD>
<P>
Adds this FS::dbdef_table object.
<DT><STRONG><A NAME="item_tables">tables</A></STRONG><DD>
<P>
Returns the names of all tables.
<DT><STRONG><A NAME="item_table">table TABLENAME</A></STRONG><DD>
<P>
Returns the named FS::dbdef_table object.
<H1><A NAME="BUGS">BUGS</A></H1>
<P>
Each FS::dbdef object should have a name which corresponds to its name
within the SQL database engine.
<H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
<P>
<A HREF="../FS/dbdef_table.html">FS::dbdef_table</A>, <A HREF="../FS/Record.html">FS::Record</A>,
</DL>
</BODY>
</HTML>
|
