V posledním dílu o catalystu si představíme databázový systém SQLite a naučíme se řešit základní úkoly při práci s databází.11.1.2010 00:00 | Jiří Václavík | přečteno 12246×
V posledním dílu o catalystu si představíme databázový systém SQLite a naučíme se řešit základní úkoly při práci s databází.
11.1.2010 00:00 | Jiří Václavík | přečteno 12246×
V Catalystu máme zabudováno několik způsobů, jak se vypořádat s databázemi. Budeme zde používat modul DBIx::Class, který poskytuje pohodlné objektově-orientované rozhraní pro přístup k datům.
Velkou výhodou je zde to, že nemusíme používat SQL a vyhneme se tak nekonzistencím mezi jednotlivými databázovými systémy.
Práci s databázemi si ukážeme na systému SQLite, což relační databázový systém od Richarda Hippa. Každá databáze je v SQLite uložena v samostatném .dbm souboru, který bude součástí aplikace.
Nejprve tedy nainstalujeme SQLite a podporu databázím. Ve většině distribucí by měl být dostupný balíček sqlite nebo sqlite3. Pokud není, stáhneme ho například z domovské stránky projektu www.sqlite.org. Nainstalujeme ho a dále nainstalujeme i následující dva moduly.
$ cpan DBIx::Class Catalyst::Model::DBIC::Schema
Práce se systémem SQLite je velmi intuitivní a není potřeba se k ní téměř nic nového učit. SQLite editor databáze spustíme příkazem sqlite3 (případně sqlite) a jako parametr uvedeme soubor, kde je databáze uložena (resp. kam ji uložit).
Spustí se interpret, do kterého můžeme zadávat příkazy. Za prvé existují příkazy začínající tečkou, jimiž lze vykonávat činnosti jiné než zadávání SQL dotazů. Například .help vytiskne seznam tečkovaných příkazů.
$ sqlite3 db
SQLite version 3.5.7
Enter ".help" for instructions
sqlite> .help
.bail ON|OFF Stop after hitting an error. Default OFF
.databases List names and files of attached databases
.dump ?TABLE? ... Dump the database in an SQL text format
.echo ON|OFF Turn command echo on or off
.exit Exit this program
.explain ON|OFF Turn output mode suitable for EXPLAIN on or off.
.header(s) ON|OFF Turn display of headers on or off
.help Show this message
.import FILE TABLE Import data from FILE into TABLE
.indices TABLE Show names of all indices on TABLE
.mode MODE ?TABLE? Set output mode where MODE is one of:
csv Comma-separated values
column Left-aligned columns. (See .width)
html HTML \<table> code
insert SQL insert statements for TABLE
line One value per line
list Values delimited by .separator string
tabs Tab-separated values
tcl TCL list elements
.nullvalue STRING Print STRING in place of NULL values
.output FILENAME Send output to FILENAME
.output stdout Send output to the screen
.prompt MAIN CONTINUE Replace the standard prompts
.quit Exit this program
.read FILENAME Execute SQL in FILENAME
.schema ?TABLE? Show the CREATE statements
.separator STRING Change separator used by output mode and .import
.show Show the current values for various settings
.tables ?PATTERN? List names of tables matching a LIKE pattern
.timeout MS Try opening locked tables for MS milliseconds
.timer ON|OFF Turn the CPU timer measurement on or off
.width NUM NUM ... Set column widths for "column" mode
sqlite> .q
$
Dále lze zadávat SQL dotazy, jejichž tvar se většinou příliš neliší od tvaru, který používají velké databázové systémy. Následující posloupnost příkazů vytvoří naši první SQLite databázi. Vytvoříme tabulku druhů zboží.
$ sqlite3 db
SQLite version 3.5.7
Enter ".help" for instructions
sqlite> create table zbozi (id int primary key, nazev varchar(255), cena float);
sqlite> insert into zbozi (id, nazev, cena) values (null, "klavesnice", 100);
sqlite> insert into zbozi (id, nazev, cena) values (null, "mys", 200);
sqlite> select * from zbozi;
1|klavesnice|100.0
2|mys|200.0
Zkusme dále vytvořit tabulku, která bude obsahovat sériové číslo pro každý jednotlivý kus zboží. Jeden druh zboží může mít více takových kusů.
sqlite> create table kusy (id int primary key, druh_zbozi int, seriove_cislo varchar(100), stav int);
sqlite> insert into zbozi (id, druh_zbozi, seriove_cislo, stav) values (null, 2, "abc-123456789", 1);
Pokud již máme SQL příkazy připraveny v souboru db.sql, stačí pro import zadat pouze následující příkaz.
$ sqlite3 db < db.sql
Nejprve si opět vytvoříme kostru aplikace pomocí příkazu catalyst.pl.
$ catalyst.pl Databaze
Abychom mohli přistupovat k databázi v Catalystu, je potřeba vytvořit datový Model. To uděláme spuštěním následujícího příkazu v adresáři script.
$ perl databaze_create.pl model MojeDatabaze DBIC::Schema Databaze::Schema::MojeDatabaze dbi:SQLite:db
Prvním argumentem je jako obvykle jméno komponenty. V důsledku to znamená, že komponenta bude žít v souboru lib/Databaze/Model/MojeDatabaze.pm. Dále DBIC::Schema je typ modelu a Databaze::Schema::MojeDatabaze uchovává strukturu tabulek uvnitř databáze specifikované posledním argumentem.
Následkem zadání tohoto příkazu se vytvoří mimo jiné také soubor lib/Databaze/Schema/MojeDatabaze/Zbozi.pm a lib/Databaze/Schema/MojeDatabaze/Kusy.pm. Název Zbozi.pm je odvozen od jména tabulky v importované databázi. Pro každou tabulku se totiž vytvoří samostatný modul, který bude uchovávat její strukturu.
Jako ukázku toho, jak je zde zachycená struktura tabulek si vypišme například soubor Zbozi.pm.
package Databaze::Schema::MojeDatabaze::Result::Zbozi;
use strict;
use warnings;
use base "DBIx::Class";
__PACKAGE__->load_components("InflateColumn::DateTime", "Core");
__PACKAGE__->table("zbozi");
__PACKAGE__->add_columns(
"id",
{
data_type => "INTEGER",
default_value => undef,
is_nullable => 0,
size => undef,
},
"nazev",
{
data_type => "VARCHAR",
default_value => undef,
is_nullable => 0,
size => 255,
},
"cena",
{
data_type => "FLOAT",
default_value => undef,
is_nullable => 0,
size => undef,
},
);
__PACKAGE__->set_primary_key("id");
# Created by DBIx::Class::Schema::Loader
# DO NOT MODIFY THIS OR ANYTHING ABOVE!
# You can replace this text with custom content, and it will be preserved on regeneration
1;
Soubor Kusy.pm vypadá analogicky.
V těchto souborech lze přímo určovat vztahy mezi tabulkami. K tomu existují funkce has_many a belongs_to.
Například každý druh zboží ma obecně nějaký počet kusů na skladě. Tento vztah určíme přidáním následujícího řádku do Zbozi.pm.
__PACKAGE__->has_many(kusy => "Databaze::Schema::MojeDatabaze::Kusy", "druh_zbozi", {cascading_delete => 1});
Naopak do Kusy.pm bychom přidali následující kód, protože každý kus náleží k nějakému druhu zboží.
__PACKAGE__->belongs_to(zbozi => "Databaze::Schema::MojeDatabaze::Zbozi");
Zajímavého efektu lze také dosáhnout přidáváním nových podprogramů. Například chceme-li zformátovat jeden nebo několik sloupců tabulky a vytvořit něco jako imaginární sloupec, lze přidat následující kód.
sub cena_s_menou {
my($self) = @_;
return $self->cena." CZK";
}
Nyní si ukážeme, jak se dají zobrazit data. Vytvoříme tedy soubor root/db.tt, což bude naše nová šablona. Dovnitř vepíšeme následující kód.
<html>
<head></head>
<body>
<h1>Výpis databáze</h1>
<table>
[% WHILE (radek = radky.next) %]
<tr><td>[% radek.id | html %]</td><td>[% radek.nazev | html %]</td><td>[% radek.cena | html %]</td></tr>
[% END %]
</table>
</body>
</html>
Nyní je potřeba pomocí Controlleru propojit model a tuto šablonu. Pro přidanou databázi tedy vytvoříme nový Controller s názvem Databaze.
$ perl databaze_create.pl controller Databaze
Naším cílem je, aby se po zadání http://localhost:3000/zbozi zobrazila naše šablona, do které se doplní data z naší databáze. Vytvoříme tedy metodu zbozi, která se nám o to postará.
sub zbozi :Global {
my($self, $c) = @_;
$c->stash->{template} = "db.tt";
$c->stash->{radky} = $c->model("MojeDatabaze");
}
Poslední řádek v podprogramu nás zajímá nejvíce, protože ten naplní proměnnou radky, ze které čerpáme v šabloně data. Metoda model nám umožňuje přistupovat k modelu pomocí jeho názvu.
Upravme nyní šablonu db.tt tak, že přidáme možnost smazání záznamu. Můžeme to udělat například přidáním nového sloupce do tabulky.
<html>
<head></head>
<body>
<h1>Výpis databáze</h1>
<table>
[% WHILE (radek = radky.next) %]
<tr><td>[% radek.id | html %]</td><td>[% radek.nazev | html %]</td><td>[% radek.cena | html %]
</td><td><a href="[% Catalyst.uri_for("/zbozi/smazat/$radek.id") | html %]">smazat</a></td></tr>
[% END %]
</table>
</body>
</html>
Všimněme si, že pro odkaz používáme k tomu určenou funkci Catalyst.uri_for.
Nyní bude potřeba napsat metodu smazat, která nám akci smazání záznamu provede. Jak je vidět ze zápisu cesty /zbozi/smazat/$radek.id, předáváme této metodě jako parametr ID mazaného záznamu. Například, zadáme-li do prohlížeče URL http://localhost/zbozi/smazat/154, budeme chtít, aby se smazal záznam s id 154.
V komponentě Zbozi.pm tedy vytvoříme novou proceduru, která se o smazání postará.
sub smazat : Local {
my ($self, $c, $id) = @_;
my $polozka : Stashed = $c->model("MojeDatabaze::zbozi")->find({id => $id});
if($polozka){
$polozka->delete;
$c->stash->{vysledek} = "Smazano";
}
$c->forward("seznam_zbozi");
}
Abychom mohli měnit upravovat data v databázi, budeme je muset od uživatele nějak získávat. Standardní cestou pro to jsou formuláře. Catalyst podporuje automatické vytváření formulářů pomocí modulu Catalyst::Controller::Formbuilder. Ten automaticky vygeneruje HTML, zkontroluje uživatelský vstup - a to jak na straně klienta pomocí Javascriptu, tak na straně serveru.
V adresáři root vytvoříme adresář forms a v něm zbozi/edit.fb. Do něj zapíšeme následující text.
name: zbozi_edit
method: post
fields
nazev:
label: Nazev zbozi
type: text
size: 100
required: 1
cena
label: Cena
type: text
size: 6
required: 1
Dále vytvoříme soubor /root/src/zbozi/edit.tt2 - toto bude samotná šablona, která použije k vygenerování HTML soubor edit.fb.
[% META title = "Editace zbozi" %]
[% form.render %]
Nyní tedy máme formulář a ještě bude potřeba vytvořit příslušnou akci. Do Controlleru přidáme následující řádky.
use base qw(Catalyst::Controller::FormBuilder Catalyst::Controller::BindLex);
sub edit : Local Form {
my ($self, $c, $id) = @_;
my $zbozi = $c->model("MojeDatabaze::zbozi")->find_or_new({id => $id});
if ($c->form->submitted and $c->form->validate) {
$zbozi->nazev($c->form->field("nazev"));
$zbozi->cena($c->form->field("cena"));
$zbozi->update_or_insert;
$c->stash->{vysledek} = $zbozi->nazev.": uspesne editovano!";
$c->forward("seznam_zbozi");
}
}