X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FSQL%2FTranslator%2FProducer%2FPostgreSQL.pm;h=eb12613347ce9c1abec486e0c277a738fc97301a;hb=b08b5416f45bfbe381637ee3091202524c78ecab;hp=4d147a5dbf01e8511996d6dad83c140b245fa779;hpb=d529894ef96e6c243cecd566e1b6b6d3325b8127;p=dbsrgits%2FSQL-Translator.git diff --git a/lib/SQL/Translator/Producer/PostgreSQL.pm b/lib/SQL/Translator/Producer/PostgreSQL.pm index 4d147a5..eb12613 100644 --- a/lib/SQL/Translator/Producer/PostgreSQL.pm +++ b/lib/SQL/Translator/Producer/PostgreSQL.pm @@ -1,10 +1,9 @@ package SQL::Translator::Producer::PostgreSQL; # ------------------------------------------------------------------- -# $Id: PostgreSQL.pm,v 1.2 2002-11-22 03:03:40 kycl4rk Exp $ +# $Id: PostgreSQL.pm,v 1.27 2006-11-10 21:21:51 mwz444 Exp $ # ------------------------------------------------------------------- -# Copyright (C) 2002 Ken Y. Clark , -# darren chamberlain +# Copyright (C) 2002-4 SQLFairy Authors # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License as @@ -21,27 +20,51 @@ package SQL::Translator::Producer::PostgreSQL; # 02111-1307 USA # ------------------------------------------------------------------- +=head1 NAME + +SQL::Translator::Producer::PostgreSQL - PostgreSQL producer for SQL::Translator + +=head1 SYNOPSIS + + my $t = SQL::Translator->new( parser => '...', producer => 'PostgreSQL' ); + $t->translate; + +=head1 DESCRIPTION + +Creates a DDL suitable for PostgreSQL. Very heavily based on the Oracle +producer. + +=cut + use strict; -use vars qw($VERSION $DEBUG); -$VERSION = sprintf "%d.%02d", q$Revision: 1.2 $ =~ /(\d+)\.(\d+)/; +use warnings; +use vars qw[ $DEBUG $WARN $VERSION ]; +$VERSION = sprintf "%d.%02d", q$Revision: 1.27 $ =~ /(\d+)\.(\d+)/; $DEBUG = 1 unless defined $DEBUG; +use SQL::Translator::Schema::Constants; +use SQL::Translator::Utils qw(header_comment); use Data::Dumper; -my %translate = ( +my %translate; +my $max_id_length; + +BEGIN { + + %translate = ( # # MySQL types # bigint => 'bigint', - double => 'double precision', - decimal => 'decimal', - float => 'double precision', + double => 'numeric', + decimal => 'numeric', + float => 'numeric', int => 'integer', mediumint => 'integer', smallint => 'smallint', tinyint => 'smallint', - char => 'char', - varchar => 'varchar', + char => 'character', + varchar => 'character varying', longtext => 'text', mediumtext => 'text', text => 'text', @@ -50,8 +73,8 @@ my %translate = ( blob => 'bytea', mediumblob => 'bytea', longblob => 'bytea', - enum => 'varchar', - set => 'varchar', + enum => 'character varying', + set => 'character varying', date => 'date', datetime => 'timestamp', time => 'date', @@ -61,113 +84,645 @@ my %translate = ( # # Oracle types # -); + number => 'integer', + char => 'character', + varchar2 => 'character varying', + long => 'text', + CLOB => 'bytea', + date => 'date', + # + # Sybase types + # + int => 'integer', + money => 'money', + varchar => 'character varying', + datetime => 'timestamp', + text => 'text', + real => 'numeric', + comment => 'text', + bit => 'bit', + tinyint => 'smallint', + float => 'numeric', +); -sub import { - warn "loading " . __PACKAGE__ . "...\n"; + $max_id_length = 62; } +my %reserved = map { $_, 1 } qw[ + ALL ANALYSE ANALYZE AND ANY AS ASC + BETWEEN BINARY BOTH + CASE CAST CHECK COLLATE COLUMN CONSTRAINT CROSS + CURRENT_DATE CURRENT_TIME CURRENT_TIMESTAMP CURRENT_USER + DEFAULT DEFERRABLE DESC DISTINCT DO + ELSE END EXCEPT + FALSE FOR FOREIGN FREEZE FROM FULL + GROUP HAVING + ILIKE IN INITIALLY INNER INTERSECT INTO IS ISNULL + JOIN LEADING LEFT LIKE LIMIT + NATURAL NEW NOT NOTNULL NULL + OFF OFFSET OLD ON ONLY OR ORDER OUTER OVERLAPS + PRIMARY PUBLIC REFERENCES RIGHT + SELECT SESSION_USER SOME TABLE THEN TO TRAILING TRUE + UNION UNIQUE USER USING VERBOSE WHEN WHERE +]; + +# my $max_id_length = 62; +my %used_identifiers = (); +my %global_names; +my %unreserve; +my %truncated; + +=pod + +=head1 PostgreSQL Create Table Syntax + + CREATE [ [ LOCAL ] { TEMPORARY | TEMP } ] TABLE table_name ( + { column_name data_type [ DEFAULT default_expr ] [ column_constraint [, ... ] ] + | table_constraint } [, ... ] + ) + [ INHERITS ( parent_table [, ... ] ) ] + [ WITH OIDS | WITHOUT OIDS ] +where column_constraint is: + + [ CONSTRAINT constraint_name ] + { NOT NULL | NULL | UNIQUE | PRIMARY KEY | + CHECK (expression) | + REFERENCES reftable [ ( refcolumn ) ] [ MATCH FULL | MATCH PARTIAL ] + [ ON DELETE action ] [ ON UPDATE action ] } + [ DEFERRABLE | NOT DEFERRABLE ] [ INITIALLY DEFERRED | INITIALLY IMMEDIATE ] + +and table_constraint is: + + [ CONSTRAINT constraint_name ] + { UNIQUE ( column_name [, ... ] ) | + PRIMARY KEY ( column_name [, ... ] ) | + CHECK ( expression ) | + FOREIGN KEY ( column_name [, ... ] ) REFERENCES reftable [ ( refcolumn [, ... ] ) ] + [ MATCH FULL | MATCH PARTIAL ] [ ON DELETE action ] [ ON UPDATE action ] } + [ DEFERRABLE | NOT DEFERRABLE ] [ INITIALLY DEFERRED | INITIALLY IMMEDIATE ] + +=head1 Create Index Syntax + + CREATE [ UNIQUE ] INDEX index_name ON table + [ USING acc_method ] ( column [ ops_name ] [, ...] ) + [ WHERE predicate ] + CREATE [ UNIQUE ] INDEX index_name ON table + [ USING acc_method ] ( func_name( column [, ... ]) [ ops_name ] ) + [ WHERE predicate ] + +=cut + +# ------------------------------------------------------------------- sub produce { - my ( $translator, $data ) = @_; - debug("Beginning production\n"); - my $create = sprintf "--\n-- Created by %s\n-- Created on %s\n-- \n\n", - __PACKAGE__, scalar localtime; - - for my $table ( keys %{ $data } ) { - debug( "Looking at table '$table'\n" ); - my $table_data = $data->{$table}; - my @fields = sort { - $table_data->{'fields'}->{$a}->{'order'} - <=> - $table_data->{'fields'}->{$b}->{'order'} - } keys %{ $table_data->{'fields'} }; - - $create .= "--\n-- Table: $table\n--\n"; - $create .= "CREATE TABLE $table (\n"; + my $translator = shift; + $DEBUG = $translator->debug; + $WARN = $translator->show_warnings; + my $no_comments = $translator->no_comments; + my $add_drop_table = $translator->add_drop_table; + my $schema = $translator->schema; - # - # Fields - # - my @field_statements; - for my $field ( @fields ) { - debug("Looking at field '$field'\n"); - my $field_data = $table_data->{'fields'}->{ $field }; - my @fdata = ("", $field); - - # data type and size - push @fdata, sprintf "%s%s", - $field_data->{'data_type'}, - ( defined $field_data->{'size'} ) - ? "($field_data->{'size'})" : ''; - - # Null? - push @fdata, "NOT NULL" unless $field_data->{'null'}; - - # Default? XXX Need better quoting! - my $default = $field_data->{'default'}; - if ( defined $default ) { - push @fdata, "DEFAULT '$default'"; -# if (int $default eq "$default") { -# push @fdata, "DEFAULT $default"; -# } else { -# push @fdata, "DEFAULT '$default'"; -# } - } + my $qt = ''; + $qt = '"' if ($translator->quote_table_names); + my $qf = ''; + $qf = '"' if ($translator->quote_field_names); + + my $output; + $output .= header_comment unless ($no_comments); +# my %used_index_names; - # auto_increment? - push @fdata, "auto_increment" if $field_data->{'is_auto_inc'}; + my (@table_defs, @fks); + for my $table ( $schema->get_tables ) { - # primary key? - push @fdata, "PRIMARY KEY" if $field_data->{'is_primary_key'}; + my ($table_def, $fks) = create_table($table, + { quote_table_names => $qt, + quote_field_names => $qf, + no_comments => $no_comments, + add_drop_table => $add_drop_table,}); + push @table_defs, $table_def; + push @fks, @$fks; - push @field_statements, join( " ", @fdata ); + } + + $output = join("\n\n", @table_defs); + if ( @fks ) { + $output .= "--\n-- Foreign Key Definitions\n--\n\n" unless $no_comments; + $output .= join( "\n\n", @fks ) . "\n"; + } + if ( $WARN ) { + if ( %truncated ) { + warn "Truncated " . keys( %truncated ) . " names:\n"; + warn "\t" . join( "\n\t", sort keys %truncated ) . "\n"; } - $create .= join( ",\n", @field_statements ); + + if ( %unreserve ) { + warn "Encounted " . keys( %unreserve ) . + " unsafe names in schema (reserved or invalid):\n"; + warn "\t" . join( "\n\t", sort keys %unreserve ) . "\n"; + } + } + + return $output; +} + +# ------------------------------------------------------------------- +sub mk_name { + my $basename = shift || ''; + my $type = shift || ''; + my $scope = shift || ''; + my $critical = shift || ''; + my $basename_orig = $basename; +# my $max_id_length = 62; + my $max_name = $type + ? $max_id_length - (length($type) + 1) + : $max_id_length; + $basename = substr( $basename, 0, $max_name ) + if length( $basename ) > $max_name; + my $name = $type ? "${type}_$basename" : $basename; + + if ( $basename ne $basename_orig and $critical ) { + my $show_type = $type ? "+'$type'" : ""; + warn "Truncating '$basename_orig'$show_type to $max_id_length ", + "character limit to make '$name'\n" if $WARN; + $truncated{ $basename_orig } = $name; + } + + $scope ||= \%global_names; + if ( my $prev = $scope->{ $name } ) { + my $name_orig = $name; + $name .= sprintf( "%02d", ++$prev ); + substr($name, $max_id_length - 3) = "00" + if length( $name ) > $max_id_length; + + warn "The name '$name_orig' has been changed to ", + "'$name' to make it unique.\n" if $WARN; + + $scope->{ $name_orig }++; + } + + $scope->{ $name }++; + return $name; +} + +# ------------------------------------------------------------------- +sub unreserve { + my $name = shift || ''; + my $schema_obj_name = shift || ''; + + my ( $suffix ) = ( $name =~ s/(\W.*)$// ) ? $1 : ''; + + # also trap fields that don't begin with a letter + return $name if (!$reserved{ uc $name }) && $name =~ /^[a-z]/i; + + if ( $schema_obj_name ) { + ++$unreserve{"$schema_obj_name.$name"}; + } + else { + ++$unreserve{"$name (table name)"}; + } + + my $unreserve = sprintf '%s_', $name; + return $unreserve.$suffix; +} + +# ------------------------------------------------------------------- +sub next_unused_name { + my $name = shift || ''; + my $used_names = shift || ''; + + my %used_names = %$used_names; + + if ( !defined($used_names{$name}) ) { + $used_names{$name} = $name; + return $name; + } + + my $i = 2; + while ( defined($used_names{$name . $i}) ) { + ++$i; + } + $name .= $i; + $used_names{$name} = $name; + return $name; +} + +sub create_table +{ + my ($table, $options) = @_; + + my $qt = $options->{quote_table_names} || ''; + my $qf = $options->{quote_field_names} || ''; + my $no_comments = $options->{no_comments} || 0; + my $add_drop_table = $options->{add_drop_table} || 0; + + my $table_name = $table->name or next; + $table_name = mk_name( $table_name, '', undef, 1 ); + my $table_name_ur = $qt ? $table_name : unreserve($table_name); + $table->name($table_name_ur); + +# print STDERR "$table_name table_name\n"; + my ( @comments, @field_defs, @sequence_defs, @constraint_defs, @fks ); + + push @comments, "--\n-- Table: $table_name_ur\n--" unless $no_comments; + + if ( $table->comments and !$no_comments ){ + my $c = "-- Comments: \n-- "; + $c .= join "\n-- ", $table->comments; + $c .= "\n--"; + push @comments, $c; + } + + # + # Fields + # + my %field_name_scope; + for my $field ( $table->get_fields ) { + push @field_defs, create_field($field, { quote_table_names => $qt, + quote_field_names => $qf, + table_name => $table_name_ur, + constraint_defs => \@constraint_defs,}); + } + + # + # Index Declarations + # + my @index_defs = (); + # my $idx_name_default; + for my $index ( $table->get_indices ) { + my ($idef, $constraints) = create_index($index, + { + quote_field_names => $qf, + quote_table_names => $qt, + table_name => $table_name, + }); + push @index_defs, $idef; + push @constraint_defs, @$constraints; + } + + # + # Table constraints + # + my $c_name_default; + for my $c ( $table->get_constraints ) { + my ($cdefs, $fks) = create_constraint($c, + { + quote_field_names => $qf, + quote_table_names => $qt, + table_name => $table_name, + }); + push @constraint_defs, @$cdefs; + push @fks, @$fks; + } + + my $create_statement; + $create_statement = join("\n", @comments); + $create_statement .= qq[DROP TABLE $qt$table_name_ur$qt;\n] + if $add_drop_table; + $create_statement .= qq[CREATE TABLE $qt$table_name_ur$qt (\n]. + join( ",\n", map { " $_" } @field_defs, @constraint_defs ). + "\n);" + ; + + $create_statement .= "\n" . join(";\n", @index_defs) . "\n"; + + return $create_statement, \@fks; +} + +{ + + my %field_name_scope; + + sub create_field + { + my ($field, $options) = @_; + + my $qt = $options->{quote_table_names} || ''; + my $qf = $options->{quote_field_names} || ''; + my $table_name = $field->table->name; + my $constraint_defs = $options->{constraint_defs} || []; + + $field_name_scope{$table_name} ||= {}; + my $field_name = mk_name( + $field->name, '', $field_name_scope{$table_name}, 1 + ); + my $field_name_ur = $qf ? $field_name : unreserve($field_name, $table_name ); + $field->name($field_name_ur); + my $field_comments = $field->comments + ? "-- " . $field->comments . "\n " + : ''; + + my $field_def = $field_comments.qq[$qf$field_name_ur$qf]; # - # Other keys + # Datatype # - my @indices = @{ $table_data->{'indices'} || [] }; - for ( my $i = 0; $i <= $#indices; $i++ ) { - $create .= ",\n"; - my $key = $indices[$i]; - my ( $name, $type, $fields ) = @{ $key }{ qw( name type fields ) }; - if ( $type eq 'primary_key' ) { - $create .= " PRIMARY KEY (@{$fields})" - } - else { - local $" = ", "; - $create .= " KEY $name (@{$fields})" - } + my @size = $field->size; + my $data_type = lc $field->data_type; + my %extra = $field->extra; + my $list = $extra{'list'} || []; + # todo deal with embedded quotes + my $commalist = join( ', ', map { qq['$_'] } @$list ); + my $seq_name; + + $field_def .= ' '. convert_datatype($field); + + # + # Default value -- disallow for timestamps + # +# my $default = $data_type =~ /(timestamp|date)/i +# ? undef : $field->default_value; + my $default = $field->default_value; + if ( defined $default ) { + my $qd = "'"; + $qd = '' if ($default eq 'now()' || + $default eq 'CURRENT_TIMESTAMP'); + $field_def .= sprintf( ' DEFAULT %s', + ( $field->is_auto_increment && $seq_name ) + ? qq[nextval('"$seq_name"'::text)] : + ( $default =~ m/null/i ) ? 'NULL' : "$qd$default$qd" + ); } # - # Footer + # Not null constraint # - $create .= "\n);\n\n"; + $field_def .= ' NOT NULL' unless $field->is_nullable; + + return $field_def; } +} + +{ + my %used_index_names; + + sub create_index + { + my ($index, $options) = @_; + + my $qt = $options->{quote_table_names} ||''; + my $qf = $options->{quote_field_names} ||''; + my $table_name = $index->table->name; +# my $table_name_ur = $qt ? unreserve($table_name) : $table_name; + + my ($index_def, @constraint_defs); + + $used_index_names{$table_name} ||= {}; + my $name = $index->name || ''; + if ( $name ) { + $name = next_unused_name($name, $used_index_names{$table_name}); + $used_index_names{$name} = $name; + } + + my $type = $index->type || NORMAL; + my @fields = + map { $_ =~ s/\(.+\)//; $_ } + map { $qt ? $_ : unreserve($_, $table_name ) } + $index->fields; + next unless @fields; + + my $def_start = qq[Constraint "$name" ]; + if ( $type eq PRIMARY_KEY ) { + push @constraint_defs, "${def_start}PRIMARY KEY ". + '(' .$qf . join( $qf. ', '.$qf, @fields ) . $qf . ')'; + } + elsif ( $type eq UNIQUE ) { + push @constraint_defs, "${def_start}UNIQUE " . + '(' . $qf . join( $qf. ', '.$qf, @fields ) . $qf.')'; + } + elsif ( $type eq NORMAL ) { + $index_def = + "CREATE INDEX ${qf}${name}${qf} on ${qt}${table_name}${qt} (". + join( ', ', map { qq[$qf$_$qf] } @fields ). + ');' + ; + } + else { + warn "Unknown index type ($type) on table $table_name.\n" + if $WARN; + } - return $create; + return $index_def, \@constraint_defs; + } + + sub create_constraint + { + my ($c, $options) = @_; + + my $qf = $options->{quote_field_names} ||''; + my $qt = $options->{quote_table_names} ||''; + my $table_name = $c->table->name; + my (@constraint_defs, @fks); + + my $name = $c->name || ''; + if ( $name ) { + $name = next_unused_name($name, \%used_index_names); + $used_index_names{$name} = $name; + } + + my @fields = + map { $_ =~ s/\(.+\)//; $_ } + map { $qt ? $_ : unreserve( $_, $table_name )} + $c->fields; + + my @rfields = + map { $_ =~ s/\(.+\)//; $_ } + map { $qt ? $_ : unreserve( $_, $table_name )} + $c->reference_fields; + + next if !@fields && $c->type ne CHECK_C; + my $def_start = $name ? qq[Constraint "$name" ] : ''; + if ( $c->type eq PRIMARY_KEY ) { + push @constraint_defs, "${def_start}PRIMARY KEY ". + '('.$qf . join( $qf.', '.$qf, @fields ) . $qf.')'; + } + elsif ( $c->type eq UNIQUE ) { + $name = next_unused_name($name, \%used_index_names); + $used_index_names{$name} = $name; + push @constraint_defs, "${def_start}UNIQUE " . + '('.$qf . join( $qf.', '.$qf, @fields ) . $qf.')'; + } + elsif ( $c->type eq CHECK_C ) { + my $expression = $c->expression; + push @constraint_defs, "${def_start}CHECK ($expression)"; + } + elsif ( $c->type eq FOREIGN_KEY ) { + my $def .= "ALTER TABLE ${qt}${table_name}${qt} ADD FOREIGN KEY (" . + join( ', ', map { qq[$qf$_$qf] } @fields ) . ')' . + "\n REFERENCES " . $qt . $c->reference_table . $qt; + + if ( @rfields ) { + $def .= ' ('.$qf . join( $qf.', '.$qf, @rfields ) . $qf.')'; + } + + if ( $c->match_type ) { + $def .= ' MATCH ' . + ( $c->match_type =~ /full/i ) ? 'FULL' : 'PARTIAL'; + } + + if ( $c->on_delete ) { + $def .= ' ON DELETE '.join( ' ', $c->on_delete ); + } + + if ( $c->on_update ) { + $def .= ' ON UPDATE '.join( ' ', $c->on_update ); + } + + push @fks, "$def;"; + } + + return \@constraint_defs, \@fks; + } } -use Carp; -sub debug { - if ( $DEBUG ) { - map { carp "[" . __PACKAGE__ . "] $_" } @_; +sub convert_datatype +{ + my ($field) = @_; + + my @size = $field->size; + my $data_type = lc $field->data_type; + + if ( $data_type eq 'enum' ) { +# my $len = 0; +# $len = ($len < length($_)) ? length($_) : $len for (@$list); +# my $chk_name = mk_name( $table_name.'_'.$field_name, 'chk' ); +# push @$constraint_defs, +# qq[Constraint "$chk_name" CHECK ($qf$field_name$qf ]. +# qq[IN ($commalist))]; + $data_type = 'character varying'; + } + elsif ( $data_type eq 'set' ) { + $data_type = 'character varying'; + } + elsif ( $field->is_auto_increment ) { + if ( defined $size[0] && $size[0] > 11 ) { + $data_type = 'bigserial'; + } + else { + $data_type = 'serial'; + } + undef @size; + } + else { + $data_type = defined $translate{ $data_type } ? + $translate{ $data_type } : + $data_type; + } + + if ( $data_type =~ /timestamp/i ) { + if ( defined $size[0] && $size[0] > 6 ) { + $size[0] = 6; + } + } + + if ( $data_type eq 'integer' ) { + if ( defined $size[0] && $size[0] > 0) { + if ( $size[0] > 10 ) { + $data_type = 'bigint'; + } + elsif ( $size[0] < 5 ) { + $data_type = 'smallint'; + } + else { + $data_type = 'integer'; + } + } + else { + $data_type = 'integer'; + } } + + # + # PG doesn't need a size for integers or text + # + undef @size if $data_type =~ m/(integer|smallint|bigint|text)/; + + if ( defined $size[0] && $size[0] > 0 ) { + $data_type .= '(' . join( ',', @size ) . ')'; + } + elsif (defined $size[0] && $data_type eq 'timestamp' ) { + $data_type .= '(' . join( ',', @size ) . ')'; + } + + + return $data_type; +} + + +sub alter_field +{ + my ($from_field, $to_field) = @_; + + die "Can't alter field in another table" + if($from_field->table->name ne $to_field->table->name); + + my @out; + push @out, sprintf('ALTER TABLE %s ALTER COLUMN %s SET NOT NULL;', + $to_field->table->name, + $to_field->name) if(!$to_field->is_nullable and + $from_field->is_nullable); + + my $from_dt = convert_datatype($from_field); + my $to_dt = convert_datatype($to_field); + push @out, sprintf('ALTER TABLE %s ALTER COLUMN %s TYPE %s;', + $to_field->table->name, + $to_field->name, + $to_dt) if($to_dt ne $from_dt); + + push @out, sprintf('ALTER TABLE %s RENAME COLUMN %s TO %s;', + $to_field->table->name, + $from_field->name, + $to_field->name) if($from_field->name ne $to_field->name); + + push @out, sprintf('ALTER TABLE %s ALTER COLUMN %s SET DEFAULT %s;', + $to_field->table->name, + $to_field->name, + $to_field->default_value) + if(defined $to_field->default_value && + $from_field->default_value ne $to_field->default_value); + + return wantarray ? @out : join("\n", @out); + +} + +sub add_field +{ + my ($new_field) = @_; + + my $out = sprintf('ALTER TABLE %s ADD COLUMN %s;', + $new_field->table->name, + create_field($new_field)); + return $out; + +} + +sub drop_field +{ + my ($old_field) = @_; + + my $out = sprintf('ALTER TABLE %s DROP COLUMN %s;', + $old_field->table->name, + $old_field->name); + + return $out; } 1; -__END__ -=head1 NAME +# ------------------------------------------------------------------- +# Life is full of misery, loneliness, and suffering -- +# and it's all over much too soon. +# Woody Allen +# ------------------------------------------------------------------- + +=pod + +=head1 SEE ALSO -SQL::Translator::Producer::PostgreSQL - PostgreSQL-specific producer for SQL::Translator +SQL::Translator, SQL::Translator::Producer::Oracle. =head1 AUTHOR -Ken Y. Clark Ekclark@cpan.orgE +Ken Y. Clark Ekclark@cpan.orgE. =cut