1 package DBIx::DBSchema::Column;
6 use DBIx::DBSchema::_util qw(_load_driver _dbh);
12 DBIx::DBSchema::Column - Column objects
16 use DBIx::DBSchema::Column;
18 #named params with a hashref (preferred)
19 $column = new DBIx::DBSchema::Column ( {
20 'name' => 'column_name',
29 $column = new DBIx::DBSchema::Column ( $name, $sql_type, $nullability, $length, $default, $local );
31 $name = $column->name;
32 $column->name( 'name' );
34 $sql_type = $column->type;
35 $column->type( 'sql_type' );
37 $null = $column->null;
38 $column->null( 'NULL' );
39 $column->null( 'NOT NULL' );
42 $length = $column->length;
43 $column->length( '10' );
44 $column->length( '8,2' );
46 $default = $column->default;
47 $column->default( 'Roo' );
49 $sql_line = $column->line;
50 $sql_line = $column->line($datasrc);
52 $sql_add_column = $column->sql_add_column;
53 $sql_add_column = $column->sql_add_column($datasrc);
57 DBIx::DBSchema::Column objects represent columns in tables (see
58 L<DBIx::DBSchema::Table>).
66 =item new [ name [ , type [ , null [ , length [ , default [ , local ] ] ] ] ] ]
68 Creates a new DBIx::DBSchema::Column object. Takes a hashref of named
69 parameters, or a list. B<name> is the name of the column. B<type> is the SQL
70 data type. B<null> is the nullability of the column (intrepreted using Perl's
71 rules for truth, with one exception: `NOT NULL' is false). B<length> is the
72 SQL length of the column. B<default> is the default value of the column.
73 B<local> is reserved for database-specific information.
75 Note: If you pass a scalar reference as the B<default> rather than a scalar value, it will be dereferenced and quoting will be forced off. This can be used to pass SQL functions such as C<$now()> or explicit empty strings as C<''> as
82 my $class = ref($proto) || $proto;
88 #carp "Old-style $class creation without named parameters is deprecated!";
89 #croak "FATAL: old-style $class creation no longer supported;".
90 # " use named parameters";
92 $self = { map { $_ => shift } qw(name type null length default local) };
95 #croak "Illegal name: ". $self->{'name'}
96 # if grep $self->{'name'} eq $_, @reserved_words;
98 $self->{'null'} =~ s/^NOT NULL$//i;
99 $self->{'null'} = 'NULL' if $self->{'null'};
101 bless ($self, $class);
107 Returns or sets the column name.
113 if ( defined($value) ) {
114 #croak "Illegal name: $name" if grep $name eq $_, @reserved_words;
115 $self->{'name'} = $value;
123 Returns or sets the column type.
129 if ( defined($value) ) {
130 $self->{'type'} = $value;
138 Returns or sets the column null flag (the empty string is equivalent to
145 if ( defined($value) ) {
146 $value =~ s/^NOT NULL$//i;
147 $value = 'NULL' if $value;
148 $self->{'null'} = $value;
154 =item length [ LENGTH ]
156 Returns or sets the column length.
162 if ( defined($value) ) {
163 $self->{'length'} = $value;
169 =item default [ LOCAL ]
171 Returns or sets the default value.
177 if ( defined($value) ) {
178 $self->{'default'} = $value;
185 =item local [ LOCAL ]
187 Returns or sets the database-specific field.
193 if ( defined($value) ) {
194 $self->{'local'} = $value;
200 =item table_obj [ TABLE_OBJ ]
202 Returns or sets the table object (see L<DBIx::DBSchema::Table>). Typically
203 set internally when a column object is added to a table object.
209 if ( defined($value) ) {
210 $self->{'table_obj'} = $value;
212 $self->{'table_obj'};
218 Returns the table name, or the empty string if this column has not yet been
225 $self->{'table_obj'} ? $self->{'table_obj'}->name : '';
228 =item line [ DATABASE_HANDLE | DATA_SOURCE [ USERNAME PASSWORD [ ATTR ] ] ]
230 Returns an SQL column definition.
232 The data source can be specified by passing an open DBI database handle, or by
233 passing the DBI data source name, username and password.
235 Although the username and password are optional, it is best to call this method
236 with a database handle or data source including a valid username and password -
237 a DBI connection will be opened and the quoting and type mapping will be more
240 If passed a DBI data source (or handle) such as `DBI:mysql:database' or
241 `DBI:Pg:dbname=database', will use syntax specific to that database engine.
242 Currently supported databases are MySQL and PostgreSQL. Non-standard syntax
243 for other engines (if applicable) may also be supported in the future.
248 my($self, $dbh) = ( shift, _dbh(@_) );
250 my $driver = $dbh ? _load_driver($dbh) : '';
251 my $driver_class = "DBIx::DBSchema::DBD::${driver}";
258 %typemap = eval "\%${driver_class}::typemap" if $driver;
259 my $type = defined( $typemap{uc($self->type)} )
260 ? $typemap{uc($self->type)}
264 # set default for the callback...
268 my $orig_default = $self->default;
269 if ( $driver_class->can("_column_value_needs_quoting") ) {
270 if ($driver_class->_column_value_needs_quoting($self)) {
271 $default = $dbh->quote($self->default);
273 $default = ref($self->default) ? ${$self->default} : $self->default;
275 } elsif ( defined($self->default) && !ref($self->default) && $self->default ne ''
277 # false laziness: nicked from FS::Record::_quote
278 && ( $self->default !~ /^\-?\d+(\.\d+)?$/
279 || $type =~ /(char|binary|blob|text)$/i
282 $default = $dbh->quote($self->default);
284 $default = ref($self->default) ? ${$self->default} : $self->default;
286 $self->default($default);
289 # callback into the database-specific driver
292 my $dbd = "DBIx::DBSchema::DBD::$driver";
293 my $hashref = $dbd->column_callback( $dbh, $self->table_name, $self );
295 $self->default($orig_default);
297 $type = $hashref->{'effective_type'}
298 if $hashref->{'effective_type'};
300 my $null = $self->null;
302 #we seem to do this for mysql/Pg/SQLite, i think this should be the default
303 #add something to $hashref if drivers need to overrdide?
304 $null ||= "NOT NULL";
306 $null =~ s/^NULL$// unless $hashref->{'explicit_null'};
308 $default = $hashref->{'effective_default'}
309 if $hashref->{'effective_default'};
311 my $local = $self->local;
312 $local = $hashref->{'effective_local'}
313 if $hashref->{'effective_local'};
321 $type. ( ( defined($self->length) && $self->length )
322 ? '('.$self->length.')'
326 ( ( defined($default) && $default ne '' )
327 ? 'DEFAULT '. $default
330 ( defined($local) ? $local : ''),
335 =item sql_add_column [ DBH ]
337 Returns a list of SQL statements to add this column to an existing table. (To
338 create a new table, see L<DBIx::DBSchema::Table/sql_create_table> instead.)
340 The data source can be specified by passing an open DBI database handle, or by
341 passing the DBI data source name, username and password.
343 Although the username and password are optional, it is best to call this method
344 with a database handle or data source including a valid username and password -
345 a DBI connection will be opened and the quoting and type mapping will be more
348 If passed a DBI data source (or handle) such as `DBI:Pg:dbname=database', will
349 use PostgreSQL-specific syntax. Non-standard syntax for other engines (if
350 applicable) may also be supported in the future.
355 my($self, $dbh) = ( shift, _dbh(@_) );
357 die "$self: this column is not assigned to a table"
358 unless $self->table_name;
360 my $driver = $dbh ? _load_driver($dbh) : '';
363 my $table = $self->table_name;
365 my $dbd = "DBIx::DBSchema::DBD::$driver";
366 my $hashref = $dbd->add_column_callback( $dbh, $table, $self );
369 if ( $hashref->{'effective_type'} ) {
370 $real_type = $self->type;
371 $self->type($hashref->{'effective_type'});
374 my $real_null = undef;
375 if ( exists($hashref->{'effective_null'}) ) {
376 $real_null = $self->null;
377 $self->null($hashref->{'effective_null'});
380 push @sql, "ALTER TABLE $table ADD COLUMN ". $self->line($dbh);
382 push @sql, @{ $hashref->{'sql_after'} } if $hashref->{'sql_after'};
384 push @sql, "ALTER TABLE $table ADD PRIMARY KEY ( ".
385 $self->table_obj->primary_key. " )"
386 if $self->name eq $self->table_obj->primary_key;
388 $self->type($real_type) if $real_type;
389 $self->null($real_null) if defined $real_null;
395 =item sql_alter_column PROTOTYPE_COLUMN [ DATABASE_HANDLE | DATA_SOURCE [ USERNAME PASSWORD [ ATTR ] ] ]
397 Returns a list of SQL statements to alter this column so that it is identical
398 to the provided prototype column, also a DBIx::DBSchema::Column object.
400 #Optionally, the data source can be specified by passing an open DBI database
401 #handle, or by passing the DBI data source name, username and password.
403 #If passed a DBI data source (or handle) such as `DBI:Pg:dbname=database', will
404 #use PostgreSQL-specific syntax. Non-standard syntax for other engines (if
405 #applicable) may also be supported in the future.
407 #If not passed a data source (or handle), or if there is no driver for the
408 #specified database, will attempt to use generic SQL syntax.
411 Or should, someday. Right now it knows how to change NOT NULL into NULL and
416 sub sql_alter_column {
417 my( $self, $new, $dbh ) = ( shift, shift, _dbh(@_) );
419 my $table = $self->table_name;
420 die "$self: this column is not assigned to a table"
423 my $name = $self->name;
425 my $driver = $dbh ? _load_driver($dbh) : '';
429 my $dbd = "DBIx::DBSchema::DBD::$driver";
430 my $hashref = $dbd->alter_column_callback( $dbh, $table, $self, $new );
436 if ( $hashref->{'sql_alter_null' } ) {
438 push @sql, $hashref->{'sql_alter_null'};
442 # change nullability from NOT NULL to NULL
443 if ( ! $self->null && $new->null ) {
445 push @sql, "ALTER TABLE $table ALTER COLUMN $name DROP NOT NULL";
449 # change nullability from NULL to NOT NULL...
450 # this one could be more complicated, need to set a DEFAULT value and update
452 if ( $self->null && ! $new->null ) {
454 push @sql, "ALTER TABLE $table ALTER COLUMN $name SET NOT NULL";
460 # change other stuff...
465 =item sql_drop_column [ DBH ]
467 Returns a list of SQL statements to drop this column from an existing table.
469 The optional database handle or DBI data source/username/password is not yet
474 sub sql_drop_column {
475 my( $self, $dbh ) = ( shift, _dbh(@_) );
477 my $table = $self->table_name;
478 my $name = $self->name;
480 ("ALTER TABLE $table DROP COLUMN $name"); # XXX what about indexes???
487 Ivan Kohler <ivan-dbix-dbschema@420.am>
491 Copyright (c) 2000-2006 Ivan Kohler
492 Copyright (c) 2007 Freeside Internet Services, Inc.
494 This program is free software; you can redistribute it and/or modify it under
495 the same terms as Perl itself.
499 The new() method should warn that
500 "Old-style $class creation without named parameters is deprecated!"
502 Better documentation is needed for sql_add_column
504 line() and sql_add_column() hav database-specific foo that should be abstracted
505 into the DBIx::DBSchema:DBD:: modules.
509 L<DBIx::DBSchema::Table>, L<DBIx::DBSchema>, L<DBIx::DBSchema::DBD>, L<DBI>