overhaul of index representation: indices (both normal and unique) are now named...
[DBIx-DBSchema.git] / DBSchema / Column.pm
index 7b4382b..5f0d7d1 100644 (file)
@@ -1,15 +1,11 @@
 package DBIx::DBSchema::Column;
 
 use strict;
-use vars qw(@ISA $VERSION);
-#use Carp;
-#use Exporter;
-use DBIx::DBSchema::_util qw(_load_driver);
+use vars qw($VERSION);
+use Carp;
+use DBIx::DBSchema::_util qw(_load_driver _dbh);
 
-#@ISA = qw(Exporter);
-@ISA = qw();
-
-$VERSION = '0.06';
+$VERSION = '0.09';
 
 =head1 NAME
 
@@ -89,6 +85,10 @@ sub new {
   if ( ref($_[0]) ) {
     $self = shift;
   } else {
+    #carp "Old-style $class creation without named parameters is deprecated!";
+    #croak "FATAL: old-style $class creation no longer supported;".
+    #      " use named parameters";
+
     $self = { map { $_ => shift } qw(name type null length default local) };
   }
 
@@ -245,14 +245,8 @@ for other engines (if applicable) may also be supported in the future.
 =cut
 
 sub line {
-  my($self,$dbh) = (shift, shift);
+  my($self, $dbh) = ( shift, _dbh(@_) );
 
-  my $created_dbh = 0;
-  unless ( ref($dbh) || ! @_ ) {
-    $dbh = DBI->connect( $dbh, @_ ) or die $DBI::errstr;
-    my $gratuitous = $DBI::errstr; #surpress superfluous `used only once' error
-    $created_dbh = 1;
-  }
   my $driver = $dbh ? _load_driver($dbh) : '';
 
   my %typemap;
@@ -285,7 +279,7 @@ sub line {
     $null =~ s/^NULL$//;
   }
 
-  my $r = join(' ',
+  join(' ',
     $self->name,
     $type. ( ( defined($self->length) && $self->length )
              ? '('.$self->length.')'
@@ -301,14 +295,13 @@ sub line {
       : ''
     ),
   );
-  $dbh->disconnect if $created_dbh;
-  $r;
 
 }
 
-=item sql_add_column
+=item sql_add_column [ DBH ] 
 
-Returns a list of SQL statements to add this column.
+Returns a list of SQL statements to add this column to an existing table.  (To
+create a new table, see L<DBIx::DBSchema::Table/sql_create_table> instead.)
 
 The data source can be specified by passing an open DBI database handle, or by
 passing the DBI data source name, username and password.  
@@ -325,23 +318,13 @@ applicable) may also be supported in the future.
 =cut
 
 sub sql_add_column {
-  my($self, $dbh) = (shift, shift);
+  my($self, $dbh) = ( shift, _dbh(@_) );
 
   die "$self: this column is not assigned to a table"
     unless $self->table_name;
 
-  #false laziness w/Table::sql_create_driver
-  my $created_dbh = 0;
-  unless ( ref($dbh) || ! @_ ) {
-    $dbh = DBI->connect( $dbh, @_ ) or die $DBI::errstr;
-    my $gratuitous = $DBI::errstr; #surpress superfluous `used only once' error
-    $created_dbh = 1;
-  }
-
   my $driver = $dbh ? _load_driver($dbh) : '';
 
-  #eofalse
-
   my @after_add = ();
 
   my $real_type = '';
@@ -352,10 +335,16 @@ sub sql_add_column {
     push @after_add, sub {
       my($table, $column) = @_;
 
-      #needs more work for old Pg
+      #needs more work for old Pg?
+      
+      my $pg_server_version = $dbh->{'pg_server_version'};
+      unless ( $pg_server_version =~ /\d/ ) {
+        warn "WARNING: no pg_server_version!  Assuming >= 7.3\n";
+        $pg_server_version = 70300;
+      }
 
       my $nextval;
-      if ( $dbh->{'pg_server_version'} > 70300 ) {
+      if ( $pg_server_version >= 70300 ) {
         $nextval = "nextval('public.${table}_${column}_seq'::text)";
       } else {
         $nextval = "nextval('${table}_${column}_seq'::text)";
@@ -377,7 +366,14 @@ sub sql_add_column {
     $real_null = $self->null;
     $self->null('NULL');
 
-    if ( $dbh->{'pg_server_version'} > 70300 ) {
+    my $pg_server_version = $dbh->{'pg_server_version'};
+    unless ( $pg_server_version =~ /\d/ ) {
+      warn "WARNING: no pg_server_version!  Assuming >= 7.3\n";
+      $pg_server_version = 70300;
+    }
+
+    if ( $pg_server_version >= 70300 ) { #this did work on 7.3
+    #if ( $pg_server_version > 70400 ) {
 
       push @after_add, sub {
         my($table, $column) = @_;
@@ -412,7 +408,105 @@ sub sql_add_column {
   $self->type($real_type) if $real_type;
   $self->null($real_null) if defined $real_null;
 
-  $dbh->disconnect if $created_dbh;
+  @r;
+
+}
+
+=item sql_alter_column PROTOTYPE_COLUMN  [ DATABASE_HANDLE | DATA_SOURCE [ USERNAME PASSWORD [ ATTR ] ] ]
+
+Returns a list of SQL statements to alter this column so that it is identical
+to the provided prototype column, also a DBIx::DBSchema::Column object.
+
+ #Optionally, the data source can be specified by passing an open DBI database
+ #handle, or by passing the DBI data source name, username and password.  
+ #
+ #If passed a DBI data source (or handle) such as `DBI:Pg:dbname=database', will
+ #use PostgreSQL-specific syntax.  Non-standard syntax for other engines (if
+ #applicable) may also be supported in the future.
+ #
+ #If not passed a data source (or handle), or if there is no driver for the
+ #specified database, will attempt to use generic SQL syntax.
+
+
+Or should, someday.  Right now it knows how to change NOT NULL into NULL and
+vice-versa.
+
+=cut
+
+sub sql_alter_column {
+  my( $self, $new, $dbh ) = ( shift, shift, _dbh(@_) );
+
+  my $table = $self->table_name;
+  die "$self: this column is not assigned to a table"
+    unless $table;
+
+  my $name = $self->name;
+
+  my $driver = $dbh ? _load_driver($dbh) : '';
+
+  my @r = ();
+
+  # change the name...
+
+  # change the type...
+
+  # change nullability from NOT NULL to NULL
+  if ( ! $self->null && $new->null ) {
+
+    my $alter = "ALTER TABLE $table ALTER COLUMN $name DROP NOT NULL";
+
+    if ( $driver eq 'Pg' ) {
+
+      my $pg_server_version = $dbh->{'pg_server_version'};
+      unless ( $pg_server_version =~ /\d/ ) {
+        warn "WARNING: no pg_server_version!  Assuming >= 7.3\n";
+        $pg_server_version = 70300;
+      }
+
+      if ( $pg_server_version < 70300 ) {
+        $alter = "UPDATE pg_attribute SET attnotnull = FALSE
+                    WHERE attname = '$name'
+                      AND attrelid = ( SELECT oid FROM pg_class
+                                         WHERE relname = '$table'
+                                     )";
+      }
+
+    }
+
+    push @r, $alter;
+
+  }
+
+  # change nullability from NULL to NOT NULL...
+  # this one could be more complicated, need to set a DEFAULT value and update
+  # the table first...
+  if ( $self->null && ! $new->null ) {
+
+    my $alter = "ALTER TABLE $table ALTER COLUMN $name SET NOT NULL";
+
+    if ( $driver eq 'Pg' ) {
+
+      my $pg_server_version = $dbh->{'pg_server_version'};
+      unless ( $pg_server_version =~ /\d/ ) {
+        warn "WARNING: no pg_server_version!  Assuming >= 7.3\n";
+        $pg_server_version = 70300;
+      }
+
+      if ( $pg_server_version < 70300 ) {
+        push @r, "UPDATE pg_attribute SET attnotnull = TRUE
+                    WHERE attname = '$name'
+                      AND attrelid = ( SELECT oid FROM pg_class
+                                         WHERE relname = '$table'
+                                     )";
+      }
+
+    }
+
+    push @r, $alter;
+  
+  }
+
+  # change other stuff...
 
   @r;
 
@@ -426,13 +520,16 @@ Ivan Kohler <ivan-dbix-dbschema@420.am>
 
 =head1 COPYRIGHT
 
-Copyright (c) 2000-2005 Ivan Kohler
+Copyright (c) 2000-2006 Ivan Kohler
 All rights reserved.
 This program is free software; you can redistribute it and/or modify it under
 the same terms as Perl itself.
 
 =head1 BUGS
 
+The new() method should warn that 
+"Old-style $class creation without named parameters is deprecated!"
+
 Better documentation is needed for sql_add_column
 
 line() and sql_add_column() hav database-specific foo that should be abstracted