Added how to '.. fetch a single (or topmost) row?' to the FAQ
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Test / SQLite.pm
1 package DBIx::Class::Test::SQLite;
2
3 =head1 NAME
4
5 DBIx::Class::Test::SQLite - Base class for running Class::DBI tests against DBIx::Class compat layer, shamelessly ripped from Class::DBI::Test::SQLite
6
7 =head1 SYNOPSIS
8
9   use base 'DBIx::Class::Test::SQLite';
10
11   __PACKAGE__->set_table('test');
12   __PACKAGE__->columns(All => qw/id name film salary/);
13
14   sub create_sql {
15       return q{
16           id     INTEGER PRIMARY KEY,
17           name   CHAR(40),
18           film   VARCHAR(255),
19           salary INT
20       }
21   }
22     
23 =head1 DESCRIPTION
24
25 This provides a simple base class for DBIx::Class::CDBICompat tests using
26 SQLite.  Each class for the test should inherit from this, provide a
27 create_sql() method which returns a string representing the SQL used to
28 create the table for the class, and then call set_table() to create the
29 table, and tie it to the class.
30
31 =cut
32
33 use strict;
34 use warnings;
35
36 use base qw/DBIx::Class/;
37
38 __PACKAGE__->load_components(qw/CDBICompat Core DB/);
39
40 use File::Temp qw/tempfile/;
41 my (undef, $DB) = tempfile();
42 END { unlink $DB if -e $DB }
43
44 my @DSN = ("dbi:SQLite:dbname=$DB", '', '', { AutoCommit => 1, RaiseError => 1 });
45
46 __PACKAGE__->connection(@DSN);
47 __PACKAGE__->set_sql(_table_pragma => 'PRAGMA table_info(__TABLE__)');
48 __PACKAGE__->set_sql(_create_me    => 'CREATE TABLE __TABLE__ (%s)');
49 __PACKAGE__->storage->dbh->do("PRAGMA synchronous = OFF");
50
51 =head1 METHODS
52
53 =head2 set_table
54
55     __PACKAGE__->set_table('test');
56
57 This combines creating the table with the normal DBIx::Class table()
58 call.
59
60 =cut
61
62 sub set_table {
63     my ($class, $table) = @_;
64     $class->table($table);
65     $class->_create_test_table;
66 }
67
68 sub _create_test_table {
69     my $class = shift;
70     my @vals  = $class->sql__table_pragma->select_row;
71     $class->sql__create_me($class->create_sql)->execute unless @vals;
72 }
73
74 =head2 create_sql
75
76 This is an abstract method you must override.
77
78   sub create_sql {
79       return q{
80           id     INTEGER PRIMARY KEY,
81           name   CHAR(40),
82           film   VARCHAR(255),
83           salary INT
84       }
85   }
86
87 This should return, as a text string, the schema for the table represented
88 by this class.
89
90 =cut
91
92 sub create_sql { die "create_sql() not implemented by $_[0]\n" }
93
94 1;