[dbsrgits/DBIx-Class-Schema-Loader.git] / lib / DBIx / Class / Schema / Loader / DBI / Pg.pm

package DBIx::Class::Schema::Loader::DBI::Pg;

use strict;
use warnings;
use base qw/
    DBIx::Class::Schema::Loader::DBI::Component::QuotedDefault
    DBIx::Class::Schema::Loader::DBI
/;
use mro 'c3';
use DBIx::Class::Schema::Loader::Table ();

our $VERSION = '0.07010';

=head1 NAME

DBIx::Class::Schema::Loader::DBI::Pg - DBIx::Class::Schema::Loader::DBI
PostgreSQL Implementation.

=head1 DESCRIPTION

See L<DBIx::Class::Schema::Loader> and L<DBIx::Class::Schema::Loader::Base>.

=cut

sub _setup {
    my $self = shift;

    $self->next::method(@_);

    $self->{db_schema} ||= ['public'];

    if (not defined $self->preserve_case) {
        $self->preserve_case(0);
    }
    elsif ($self->preserve_case) {
        $self->schema->storage->sql_maker->quote_char('"');
        $self->schema->storage->sql_maker->name_sep('.');
    }
}

sub _tables_list {
    my ($self, $opts) = @_;

    my $dbh = $self->schema->storage->dbh;

    my @tables;

    foreach my $schema (@{ $self->db_schema }) {
        my @raw_tables = $dbh->tables(undef, $schema, '%', '%');

        foreach my $table_name (@raw_tables) {
            my $schema_quoted = $table_name =~ /^"/;

            if ($schema_quoted) {
                $table_name =~ s/^"([^"]+)"\.//;
            }
            else {
                $table_name =~ s/^([^.]+)\.//;
            }
            my $table = DBIx::Class::Schema::Loader::Table->new(schema => $1);

            $table_name =~ s/^"([^"]+)"\z/$1/;

            $table->name($table_name);

            push @tables, $table;
        }
    }

    return $self->_filter_tables(\@tables, $opts);
}

sub _table_uniq_info {
    my ($self, $table) = @_;

    # Use the default support if available
    return $self->next::method($table)
        if $DBD::Pg::VERSION >= 1.50;

    my @uniqs;
    my $dbh = $self->schema->storage->dbh;

    # Most of the SQL here is mostly based on
    #   Rose::DB::Object::Metadata::Auto::Pg, after some prodding from
    #   John Siracusa to use his superior SQL code :)

    my $attr_sth = $self->{_cache}->{pg_attr_sth} ||= $dbh->prepare(
        q{SELECT attname FROM pg_catalog.pg_attribute
        WHERE attrelid = ? AND attnum = ?}
    );

    my $uniq_sth = $self->{_cache}->{pg_uniq_sth} ||= $dbh->prepare(
        q{SELECT x.indrelid, i.relname, x.indkey
        FROM
          pg_catalog.pg_index x
          JOIN pg_catalog.pg_class c ON c.oid = x.indrelid
          JOIN pg_catalog.pg_class i ON i.oid = x.indexrelid
          JOIN pg_catalog.pg_constraint con ON con.conname = i.relname
          LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
        WHERE
          x.indisunique = 't' AND
          c.relkind     = 'r' AND
          i.relkind     = 'i' AND
          con.contype   = 'u' AND
          n.nspname     = ? AND
          c.relname     = ?}
    );

    $uniq_sth->execute($table->schema, $table);
    while(my $row = $uniq_sth->fetchrow_arrayref) {
        my ($tableid, $indexname, $col_nums) = @$row;
        $col_nums =~ s/^\s+//;
        my @col_nums = split(/\s+/, $col_nums);
        my @col_names;

        foreach (@col_nums) {
            $attr_sth->execute($tableid, $_);
            my $name_aref = $attr_sth->fetchrow_arrayref;
            push(@col_names, $name_aref->[0]) if $name_aref;
        }

        if(!@col_names) {
            warn "Failed to parse UNIQUE constraint $indexname on $table";
        }
        else {
            push(@uniqs, [ $indexname => \@col_names ]);
        }
    }

    return \@uniqs;
}

sub _table_comment {
    my ( $self, $table ) = @_;
     my ($table_comment) = $self->schema->storage->dbh->selectrow_array(
        q{SELECT obj_description(oid) 
            FROM pg_class 
            WHERE relname=? AND relnamespace=(
                SELECT oid FROM pg_namespace WHERE nspname=?)
        }, undef, $table, $table->schema
        );   
    return $table_comment
}


sub _column_comment {
    my ( $self, $table, $column_number ) = @_;
     my ($table_oid) = $self->schema->storage->dbh->selectrow_array(
        q{SELECT oid
            FROM pg_class 
            WHERE relname=? AND relnamespace=(
                SELECT oid FROM pg_namespace WHERE nspname=?)
        }, undef, $table, $table->schema
        );   
    return $self->schema->storage->dbh->selectrow_array('SELECT col_description(?,?)', undef, $table_oid,
    $column_number );
}

# Make sure data_type's that don't need it don't have a 'size' column_info, and
# set the correct precision for datetime and varbit types.
sub _columns_info_for {
    my $self = shift;
    my ($table) = @_;

    my $result = $self->next::method(@_);

    while (my ($col, $info) = each %$result) {
        my $data_type = $info->{data_type};

        # these types are fixed size
        # XXX should this be a negative match?
        if ($data_type =~
/^(?:bigint|int8|bigserial|serial8|boolean|bool|box|bytea|cidr|circle|date|double precision|float8|inet|integer|int|int4|line|lseg|macaddr|money|path|point|polygon|real|float4|smallint|int2|serial|serial4|text)\z/i) {
            delete $info->{size};
        }
# for datetime types, check if it has a precision or not
        elsif ($data_type =~ /^(?:interval|time|timestamp)\b/i) {
            if (lc($data_type) eq 'timestamp without time zone') {
                $info->{data_type} = 'timestamp';
            }
            elsif (lc($data_type) eq 'time without time zone') {
                $info->{data_type} = 'time';
            }

            my ($precision) = $self->schema->storage->dbh
                ->selectrow_array(<<EOF, {}, $table, $col);
SELECT datetime_precision
FROM information_schema.columns
WHERE table_name = ? and column_name = ?
EOF

            if ($data_type =~ /^time\b/i) {
                if ((not $precision) || $precision !~ /^\d/) {
                    delete $info->{size};
                }
                else {
                    my ($integer_datetimes) = $self->schema->storage->dbh
                        ->selectrow_array('show integer_datetimes');

                    my $max_precision =
                        $integer_datetimes =~ /^on\z/i ? 6 : 10;

                    if ($precision == $max_precision) {
                        delete $info->{size};
                    }
                    else {
                        $info->{size} = $precision;
                    }
                }
            }
            elsif ((not $precision) || $precision !~ /^\d/ || $precision == 6) {
                delete $info->{size};
            }
            else {
                $info->{size} = $precision;
            }
        }
        elsif ($data_type =~ /^(?:bit(?: varying)?|varbit)\z/i) {
            $info->{data_type} = 'varbit' if $data_type =~ /var/i;

            my ($precision) = $self->schema->storage->dbh
                ->selectrow_array(<<EOF, {}, $table, $col);
SELECT character_maximum_length
FROM information_schema.columns
WHERE table_name = ? and column_name = ?
EOF

            $info->{size} = $precision if $precision;

            $info->{size} = 1 if (not $precision) && lc($data_type) eq 'bit';
        }
        elsif ($data_type =~ /^(?:numeric|decimal)\z/i && (my $size = $info->{size})) {
            $size =~ s/\s*//g;

            my ($scale, $precision) = split /,/, $size;

            $info->{size} = [ $precision, $scale ];
        }
        elsif (lc($data_type) eq 'character varying') {
            $info->{data_type} = 'varchar';

            if (not $info->{size}) {
                $info->{data_type}           = 'text';
                $info->{original}{data_type} = 'varchar';
            }
        }
        elsif (lc($data_type) eq 'character') {
            $info->{data_type} = 'char';
        }
        else {
            my ($typetype) = $self->schema->storage->dbh
                ->selectrow_array(<<EOF, {}, $data_type);
SELECT typtype
FROM pg_catalog.pg_type
WHERE typname = ?
EOF
            if ($typetype && $typetype eq 'e') {
                # The following will extract a list of allowed values for the
                # enum.
                my $typevalues = $self->schema->storage->dbh
                    ->selectall_arrayref(<<EOF, {}, $info->{data_type});
SELECT e.enumlabel
FROM pg_catalog.pg_enum e
JOIN pg_catalog.pg_type t ON t.oid = e.enumtypid
WHERE t.typname = ?
EOF

                $info->{extra}{list} = [ map { $_->[0] } @$typevalues ];

                # Store its original name in extra for SQLT to pick up.
                $info->{extra}{custom_type_name} = $info->{data_type};

                $info->{data_type} = 'enum';
                
                delete $info->{size};
            }
        }

# process SERIAL columns
        if (ref($info->{default_value}) eq 'SCALAR'
                && ${ $info->{default_value} } =~ /\bnextval\('([^:]+)'/i) {
            $info->{is_auto_increment} = 1;
            $info->{sequence}          = $1;
            delete $info->{default_value};
        }

# alias now() to current_timestamp for deploying to other DBs
        if ((eval { lc ${ $info->{default_value} } }||'') eq 'now()') {
            # do not use a ref to a constant, that breaks Data::Dump output
            ${$info->{default_value}} = 'current_timestamp';

            my $now = 'now()';
            $info->{original}{default_value} = \$now;
        }
    }

    return $result;
}

=head1 SEE ALSO

L<DBIx::Class::Schema::Loader>, L<DBIx::Class::Schema::Loader::Base>,
L<DBIx::Class::Schema::Loader::DBI>

=head1 AUTHOR

See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.

=head1 LICENSE

This library is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.

=cut

1;
Commit	Line	Data
996be9ee	1	package DBIx::Class::Schema::Loader::DBI::Pg;
	2
	3	use strict;
	4	use warnings;
41968729	5	use base qw/
	6	DBIx::Class::Schema::Loader::DBI::Component::QuotedDefault
	7	DBIx::Class::Schema::Loader::DBI
	8	/;
942bd5e0	9	use mro 'c3';
e4be49c9	10	use DBIx::Class::Schema::Loader::Table ();
996be9ee	11
4295c4b4	12	our $VERSION = '0.07010';
32f784fc	13
996be9ee	14	=head1 NAME
996be9ee	15
8f9d7ce5	16	DBIx::Class::Schema::Loader::DBI::Pg - DBIx::Class::Schema::Loader::DBI
8f9d7ce5	17	PostgreSQL Implementation.
996be9ee	18
996be9ee	19	=head1 DESCRIPTION
996be9ee	20
e4be49c9	21	See L<DBIx::Class::Schema::Loader> and L<DBIx::Class::Schema::Loader::Base>.
996be9ee	22
	23	=cut
	24
	25	sub _setup {
	26	my $self = shift;
	27
	28	$self->next::method(@_);
bc1cb85e	29
e4be49c9	30	$self->{db_schema} \|\|= ['public'];
996be9ee	31
bc1cb85e	32	if (not defined $self->preserve_case) {
	33	$self->preserve_case(0);
	34	}
c930f78b	35	elsif ($self->preserve_case) {
	36	$self->schema->storage->sql_maker->quote_char('"');
	37	$self->schema->storage->sql_maker->name_sep('.');
	38	}
bc1cb85e	39	}
fbcfebdd	40
12b86f07	41	sub _tables_list {
	42	my ($self, $opts) = @_;
	43
	44	my $dbh = $self->schema->storage->dbh;
12b86f07	45
e4be49c9	46	my @tables;
12b86f07	47
e4be49c9	48	foreach my $schema (@{ $self->db_schema }) {
e4be49c9	49	my @raw_tables = $dbh->tables(undef, $schema, '%', '%');
12b86f07	50
e4be49c9	51	foreach my $table_name (@raw_tables) {
	52	my $schema_quoted = $table_name =~ /^"/;
	53
	54	if ($schema_quoted) {
	55	$table_name =~ s/^"([^"]+)"\.//;
	56	}
	57	else {
	58	$table_name =~ s/^([^.]+)\.//;
	59	}
	60	my $table = DBIx::Class::Schema::Loader::Table->new(schema => $1);
	61
	62	$table_name =~ s/^"([^"]+)"\z/$1/;
	63
	64	$table->name($table_name);
	65
	66	push @tables, $table;
	67	}
	68	}
12b86f07	69
	70	return $self->_filter_tables(\@tables, $opts);
	71	}
	72
996be9ee	73	sub _table_uniq_info {
	74	my ($self, $table) = @_;
	75
fd589700	76	# Use the default support if available
fd589700	77	return $self->next::method($table)
79fe0081	78	if $DBD::Pg::VERSION >= 1.50;
fd589700	79
996be9ee	80	my @uniqs;
	81	my $dbh = $self->schema->storage->dbh;
	82
5223f24a	83	# Most of the SQL here is mostly based on
	84	# Rose::DB::Object::Metadata::Auto::Pg, after some prodding from
	85	# John Siracusa to use his superior SQL code :)
	86
	87	my $attr_sth = $self->{_cache}->{pg_attr_sth} \|\|= $dbh->prepare(
	88	q{SELECT attname FROM pg_catalog.pg_attribute
	89	WHERE attrelid = ? AND attnum = ?}
	90	);
	91
	92	my $uniq_sth = $self->{_cache}->{pg_uniq_sth} \|\|= $dbh->prepare(
	93	q{SELECT x.indrelid, i.relname, x.indkey
	94	FROM
	95	pg_catalog.pg_index x
	96	JOIN pg_catalog.pg_class c ON c.oid = x.indrelid
	97	JOIN pg_catalog.pg_class i ON i.oid = x.indexrelid
	98	JOIN pg_catalog.pg_constraint con ON con.conname = i.relname
	99	LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
	100	WHERE
	101	x.indisunique = 't' AND
	102	c.relkind = 'r' AND
	103	i.relkind = 'i' AND
	104	con.contype = 'u' AND
	105	n.nspname = ? AND
	106	c.relname = ?}
	107	);
	108
e4be49c9	109	$uniq_sth->execute($table->schema, $table);
5223f24a	110	while(my $row = $uniq_sth->fetchrow_arrayref) {
	111	my ($tableid, $indexname, $col_nums) = @$row;
	112	$col_nums =~ s/^\s+//;
	113	my @col_nums = split(/\s+/, $col_nums);
	114	my @col_names;
	115
	116	foreach (@col_nums) {
	117	$attr_sth->execute($tableid, $_);
	118	my $name_aref = $attr_sth->fetchrow_arrayref;
	119	push(@col_names, $name_aref->[0]) if $name_aref;
996be9ee	120	}
5223f24a	121
5223f24a	122	if(!@col_names) {
8f9d7ce5	123	warn "Failed to parse UNIQUE constraint $indexname on $table";
996be9ee	124	}
996be9ee	125	else {
5223f24a	126	push(@uniqs, [ $indexname => \@col_names ]);
996be9ee	127	}
	128	}
	129
	130	return \@uniqs;
	131	}
	132
fbcfebdd	133	sub _table_comment {
	134	my ( $self, $table ) = @_;
	135	my ($table_comment) = $self->schema->storage->dbh->selectrow_array(
	136	q{SELECT obj_description(oid)
	137	FROM pg_class
	138	WHERE relname=? AND relnamespace=(
	139	SELECT oid FROM pg_namespace WHERE nspname=?)
e4be49c9	140	}, undef, $table, $table->schema
fbcfebdd	141	);
	142	return $table_comment
	143	}
	144
	145
	146	sub _column_comment {
	147	my ( $self, $table, $column_number ) = @_;
	148	my ($table_oid) = $self->schema->storage->dbh->selectrow_array(
	149	q{SELECT oid
	150	FROM pg_class
	151	WHERE relname=? AND relnamespace=(
	152	SELECT oid FROM pg_namespace WHERE nspname=?)
e4be49c9	153	}, undef, $table, $table->schema
fbcfebdd	154	);
	155	return $self->schema->storage->dbh->selectrow_array('SELECT col_description(?,?)', undef, $table_oid,
	156	$column_number );
	157	}
	158
baff904e	159	# Make sure data_type's that don't need it don't have a 'size' column_info, and
afb4c5bc	160	# set the correct precision for datetime and varbit types.
baff904e	161	sub _columns_info_for {
	162	my $self = shift;
	163	my ($table) = @_;
	164
	165	my $result = $self->next::method(@_);
	166
f80b0ea7	167	while (my ($col, $info) = each %$result) {
f80b0ea7	168	my $data_type = $info->{data_type};
baff904e	169
baff904e	170	# these types are fixed size
7640ef4b	171	# XXX should this be a negative match?
baff904e	172	if ($data_type =~
f80b0ea7	173	/^(?:bigint\|int8\|bigserial\|serial8\|boolean\|bool\|box\|bytea\|cidr\|circle\|date\|double precision\|float8\|inet\|integer\|int\|int4\|line\|lseg\|macaddr\|money\|path\|point\|polygon\|real\|float4\|smallint\|int2\|serial\|serial4\|text)\z/i) {
f80b0ea7	174	delete $info->{size};
baff904e	175	}
afb4c5bc	176	# for datetime types, check if it has a precision or not
43b982ea	177	elsif ($data_type =~ /^(?:interval\|time\|timestamp)\b/i) {
f80b0ea7	178	if (lc($data_type) eq 'timestamp without time zone') {
	179	$info->{data_type} = 'timestamp';
	180	}
8e030521	181	elsif (lc($data_type) eq 'time without time zone') {
	182	$info->{data_type} = 'time';
	183	}
f80b0ea7	184
baff904e	185	my ($precision) = $self->schema->storage->dbh
	186	->selectrow_array(<<EOF, {}, $table, $col);
	187	SELECT datetime_precision
	188	FROM information_schema.columns
	189	WHERE table_name = ? and column_name = ?
	190	EOF
	191
5f85388e	192	if ($data_type =~ /^time\b/i) {
5f85388e	193	if ((not $precision) \|\| $precision !~ /^\d/) {
f80b0ea7	194	delete $info->{size};
5f85388e	195	}
	196	else {
	197	my ($integer_datetimes) = $self->schema->storage->dbh
	198	->selectrow_array('show integer_datetimes');
	199
	200	my $max_precision =
	201	$integer_datetimes =~ /^on\z/i ? 6 : 10;
	202
	203	if ($precision == $max_precision) {
f80b0ea7	204	delete $info->{size};
5f85388e	205	}
5f85388e	206	else {
f80b0ea7	207	$info->{size} = $precision;
5f85388e	208	}
	209	}
	210	}
	211	elsif ((not $precision) \|\| $precision !~ /^\d/ \|\| $precision == 6) {
f80b0ea7	212	delete $info->{size};
baff904e	213	}
baff904e	214	else {
f80b0ea7	215	$info->{size} = $precision;
baff904e	216	}
baff904e	217	}
f80b0ea7	218	elsif ($data_type =~ /^(?:bit(?: varying)?\|varbit)\z/i) {
	219	$info->{data_type} = 'varbit' if $data_type =~ /var/i;
	220
afb4c5bc	221	my ($precision) = $self->schema->storage->dbh
	222	->selectrow_array(<<EOF, {}, $table, $col);
	223	SELECT character_maximum_length
	224	FROM information_schema.columns
	225	WHERE table_name = ? and column_name = ?
	226	EOF
	227
f80b0ea7	228	$info->{size} = $precision if $precision;
	229
	230	$info->{size} = 1 if (not $precision) && lc($data_type) eq 'bit';
afb4c5bc	231	}
f80b0ea7	232	elsif ($data_type =~ /^(?:numeric\|decimal)\z/i && (my $size = $info->{size})) {
d4d1a665	233	$size =~ s/\s*//g;
	234
	235	my ($scale, $precision) = split /,/, $size;
	236
f80b0ea7	237	$info->{size} = [ $precision, $scale ];
	238	}
	239	elsif (lc($data_type) eq 'character varying') {
	240	$info->{data_type} = 'varchar';
	241
8e030521	242	if (not $info->{size}) {
	243	$info->{data_type} = 'text';
	244	$info->{original}{data_type} = 'varchar';
	245	}
f80b0ea7	246	}
	247	elsif (lc($data_type) eq 'character') {
	248	$info->{data_type} = 'char';
d4d1a665	249	}
12333562	250	else {
	251	my ($typetype) = $self->schema->storage->dbh
	252	->selectrow_array(<<EOF, {}, $data_type);
	253	SELECT typtype
	254	FROM pg_catalog.pg_type
	255	WHERE typname = ?
	256	EOF
e4be49c9	257	if ($typetype && $typetype eq 'e') {
463c86fb	258	# The following will extract a list of allowed values for the
	259	# enum.
	260	my $typevalues = $self->schema->storage->dbh
	261	->selectall_arrayref(<<EOF, {}, $info->{data_type});
	262	SELECT e.enumlabel
	263	FROM pg_catalog.pg_enum e
	264	JOIN pg_catalog.pg_type t ON t.oid = e.enumtypid
	265	WHERE t.typname = ?
	266	EOF
	267
	268	$info->{extra}{list} = [ map { $_->[0] } @$typevalues ];
	269
	270	# Store its original name in extra for SQLT to pick up.
	271	$info->{extra}{custom_type_name} = $info->{data_type};
	272
12333562	273	$info->{data_type} = 'enum';
463c86fb	274
463c86fb	275	delete $info->{size};
12333562	276	}
	277	}
	278
df956aad	279	# process SERIAL columns
12b86f07	280	if (ref($info->{default_value}) eq 'SCALAR'
12b86f07	281	&& ${ $info->{default_value} } =~ /\bnextval\('([^:]+)'/i) {
f80b0ea7	282	$info->{is_auto_increment} = 1;
	283	$info->{sequence} = $1;
	284	delete $info->{default_value};
df956aad	285	}
8e64075f	286
6e566cc4	287	# alias now() to current_timestamp for deploying to other DBs
45321eda	288	if ((eval { lc ${ $info->{default_value} } }\|\|'') eq 'now()') {
8a64178e	289	# do not use a ref to a constant, that breaks Data::Dump output
f80b0ea7	290	${$info->{default_value}} = 'current_timestamp';
701cd3e3	291
	292	my $now = 'now()';
	293	$info->{original}{default_value} = \$now;
8e64075f	294	}
a8df0345	295	}
a8df0345	296
df956aad	297	return $result;
78b7ccaa	298	}
78b7ccaa	299
996be9ee	300	=head1 SEE ALSO
	301
	302	L<DBIx::Class::Schema::Loader>, L<DBIx::Class::Schema::Loader::Base>,
	303	L<DBIx::Class::Schema::Loader::DBI>
	304
be80bba7	305	=head1 AUTHOR
be80bba7	306
9cc8e7e1	307	See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
be80bba7	308
	309	=head1 LICENSE
	310
	311	This library is free software; you can redistribute it and/or modify it under
	312	the same terms as Perl itself.
	313
996be9ee	314	=cut
	315
	316	1;