htdocs/docs/man/FS/dbdef.html

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