From 2c816f314a8f3cc46e72e31f34ed97b4e11d0449 Mon Sep 17 00:00:00 2001 From: ivan Date: Wed, 4 Aug 1999 12:13:27 +0000 Subject: new HTML manpages --- htdocs/docs/man/FS/dbdef_table.html | 144 ++++++++++++++++++++++++++++++++++++ 1 file changed, 144 insertions(+) create mode 100644 htdocs/docs/man/FS/dbdef_table.html (limited to 'htdocs/docs/man/FS/dbdef_table.html') diff --git a/htdocs/docs/man/FS/dbdef_table.html b/htdocs/docs/man/FS/dbdef_table.html new file mode 100644 index 000000000..7056b0f9b --- /dev/null +++ b/htdocs/docs/man/FS/dbdef_table.html @@ -0,0 +1,144 @@ + + +FS::dbdef_table - Table objects + + + + + + + +

+ + +

NAME

+FS::dbdef_table - Table objects + +

SYNOPSIS

  use FS::dbdef_table;
+

  $dbdef_table = new FS::dbdef_table (
+    "table_name",
+    "primary_key",
+    $FS_dbdef_unique_object,
+    $FS_dbdef_index_object,
+    @FS_dbdef_column_objects,
+  );
+

  $dbdef_table->addcolumn ( $FS_dbdef_column_object );
+

  $table_name = $dbdef_table->name;
+  $dbdef_table->name ("table_name");
+

  $table_name = $dbdef_table->primary_keye;
+  $dbdef_table->primary_key ("primary_key");
+

  $FS_dbdef_unique_object = $dbdef_table->unique;
+  $dbdef_table->unique ( $FS_dbdef_unique_object );
+

  $FS_dbdef_index_object = $dbdef_table->index;
+  $dbdef_table->index ( $FS_dbdef_index_object );
+

  @column_names = $dbdef->columns;
+

  $FS_dbdef_column_object = $dbdef->column;
+

  @sql_statements = $dbdef->sql_create_table;
+  @sql_statements = $dbdef->sql_create_table $datasrc;
+

DESCRIPTION

+FS::dbdef_table objects represent a single database table. + +

METHODS

new

+Creates a new FS::dbdef_table object. + +

addcolumn

+Adds this FS::dbdef_column object. + +

name

+Returns or sets the table name. + +

primary_key

+Returns or sets the primary key. + +

unique

+Returns or sets the FS::dbdef_unique object. + +

index

+Returns or sets the FS::dbdef_index object. + +

columns

+Returns a list consisting of the names of all columns. + +

column "column"

+Returns the column object (see FS::dbdef_column) for ``column''. + +

sql_create_table [ $datasrc ]

+Returns an array of SQL statments to create this table. + +

+If passed a DBI $datasrc specifying DBD::mysql, will use MySQL-specific syntax. Non-standard syntax for other engines (if +applicable) may also be supported in the future. + +

BUGS

VERSION