summaryrefslogtreecommitdiff
path: root/htdocs/docs/man/dbdef_column.txt
blob: 6747a328ce161031091f9db94061febd8e436fe5 (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
NAME
    FS::dbdef_column - Column object

SYNOPSIS
      use FS::dbdef_column;

      $column_object = new FS::dbdef_column ( $name, $sql_type, '' );
      $column_object = new FS::dbdef_column ( $name, $sql_type, 'NULL' );
      $column_object = new FS::dbdef_column ( $name, $sql_type, '', $length );
      $column_object = new FS::dbdef_column ( $name, $sql_type, 'NULL', $length );

      $name = $column_object->name;
      $column_object->name ( 'name' );

      $name = $column_object->type;
      $column_object->name ( 'sql_type' );

      $name = $column_object->null;
      $column_object->name ( 'NOT NULL' );

      $name = $column_object->length;
      $column_object->name ( $length );

      $sql_line = $column->line;
      $sql_line = $column->line $datasrc;

DESCRIPTION
    FS::dbdef::column objects represend columns in tables (see the
    FS::dbdef_table manpage).

METHODS
    new Creates a new FS::dbdef_column object.

    name
        Returns or sets the column name.

    type
        Returns or sets the column type.

    null
        Returns or sets the column null flag.

    type
        Returns or sets the column length.

    line [ $datasrc ]
        Returns an SQL column definition.

        If passed a DBI $datasrc specifying the DBD::mysql manpage
        or the DBD::Pg manpage, will use engine-specific syntax.

BUGS
SEE ALSO
    the FS::dbdef_table manpage, the FS::dbdef manpage, the DBI
    manpage

VERSION
    $Id: dbdef_column.txt,v 1.5 1999-04-08 13:39:32 ivan Exp $

HISTORY
    class for dealing with column definitions

    ivan@sisd.com 98-apr-17

    now methods can be used to get or set data ivan@sisd.com 98-may-
    11

    mySQL-specific hack for null (what should be default?)
    ivan@sisd.com 98-jun-2

    $Log: dbdef_column.txt,v $
    Revision 1.5  1999-04-08 13:39:32  ivan
    convert from pod for 1.2.0 release
 Revision 1.3 1998/10/13 13:04:17 ivan
    fixed doc to indicate Pg specific syntax too

    Revision 1.2 1998/10/12 23:40:28 ivan added Pg-specific
    behaviour in sub line