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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
package FS::dbdef_table;
use strict;
#use Carp;
use Exporter;
use vars qw(@ISA);
use FS::dbdef_column;
@ISA = qw(Exporter);
=head1 NAME
FS::dbdef_table - Table objects
=head1 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;
=head1 DESCRIPTION
FS::dbdef_table objects represent a single database table.
=head1 METHODS
=over 4
=item new
Creates a new FS::dbdef_table object.
=cut
sub new {
my($proto,$name,$primary_key,$unique,$index,@columns)=@_;
my(%columns) = map { $_->name, $_ } @columns;
#check $primary_key, $unique and $index to make sure they are $columns ?
# (and sanity check?)
my $class = ref($proto) || $proto;
my $self = {
'name' => $name,
'primary_key' => $primary_key,
'unique' => $unique,
'index' => $index,
'columns' => \%columns,
};
bless ($self, $class);
}
=item addcolumn
Adds this FS::dbdef_column object.
=cut
sub addcolumn {
my($self,$column)=@_;
${$self->{'columns'}}{$column->name}=$column; #sanity check?
}
=item name
Returns or sets the table name.
=cut
sub name {
my($self,$value)=@_;
if ( defined($value) ) {
$self->{name} = $value;
} else {
$self->{name};
}
}
=item primary_key
Returns or sets the primary key.
=cut
sub primary_key {
my($self,$value)=@_;
if ( defined($value) ) {
$self->{primary_key} = $value;
} else {
#$self->{primary_key};
#hmm. maybe should untaint the entire structure when it comes off disk
# cause if you don't trust that, ?
$self->{primary_key} =~ /^(\w*)$/
#aah!
or die "Illegal primary key ", $self->{primary_key}, " in dbdef!\n";
$1;
}
}
=item unique
Returns or sets the FS::dbdef_unique object.
=cut
sub unique {
my($self,$value)=@_;
if ( defined($value) ) {
$self->{unique} = $value;
} else {
$self->{unique};
}
}
=item index
Returns or sets the FS::dbdef_index object.
=cut
sub index {
my($self,$value)=@_;
if ( defined($value) ) {
$self->{'index'} = $value;
} else {
$self->{'index'};
}
}
=item columns
Returns a list consisting of the names of all columns.
=cut
sub columns {
my($self)=@_;
keys %{$self->{'columns'}};
}
=item column "column"
Returns the column object (see L<FS::dbdef_column>) for "column".
=cut
sub column {
my($self,$column)=@_;
$self->{'columns'}->{$column};
}
=item sql_create_table [ $datasrc ]
Returns an array of SQL statments to create this table.
If passed a DBI $datasrc specifying L<DBD::mysql>, will use MySQL-specific
syntax. Non-standard syntax for other engines (if applicable) may also be
supported in the future.
=cut
sub sql_create_table {
my($self,$datasrc)=@_;
my(@columns)=map { $self->column($_)->line($datasrc) } $self->columns;
push @columns, "PRIMARY KEY (". $self->primary_key. ")"
if $self->primary_key;
if ( $datasrc =~ /mysql/ ) { #yucky mysql hack
push @columns, map "UNIQUE ($_)", $self->unique->sql_list;
push @columns, map "INDEX ($_)", $self->index->sql_list;
}
"CREATE TABLE ". $self->name. " ( ". join(", ", @columns). " )",
( map {
my($index) = $_ . "_index";
$index =~ s/,\s*/_/g;
"CREATE UNIQUE INDEX $index ON ". $self->name. " ($_)"
} $self->unique->sql_list ),
( map {
my($index) = $_ . "_index";
$index =~ s/,\s*/_/g;
"CREATE INDEX $index ON ". $self->name. " ($_)"
} $self->index->sql_list ),
;
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::dbdef>, L<FS::dbdef_unique>, L<FS::dbdef_index>, L<FS::dbdef_unique>,
L<DBI>
=head1 HISTORY
class for dealing with table definitions
ivan@sisd.com 98-apr-18
gained extra functions (should %columns be an IxHash?)
ivan@sisd.com 98-may-11
sql_create_table returns a list of statments, not just one, and now it
does indices (plus mysql hack) ivan@sisd.com 98-jun-2
untaint primary_key... hmm. is this a hack around a bigger problem?
looks like, did the same thing singles in colgroup!
ivan@sisd.com 98-jun-4
pod ivan@sisd.com 98-sep-24
=cut
1;
|
