MySQL (48) - UDF

Uživatelsky definované funkce jsou dalším rysem databáze MySQL, kterému se dnes podíváme na zoubek.

2.12.2005 06:00 | Petr Zajíc | přečteno 21353×

Protože jsme se v tomto seriálu již začali věnovat novým rysům MySQL 5.0, jako jsou uložené procedury a spouště, slušelo by se rovněž zmínit se o uživatelsky definovaných funkcích. Ty byly totiž rovněž přidány v poslední době - a i s nimi je databázový život mnohem jednodušší. Pojďme se tedy podívat, co nám v tomto ohledu může MySQL nabídnout.

Uživatelsky definované funkce

Jak jste asi pochopili, uživatelsky definovaná funkce je taková, kterou si můžete sami napsat. V tomto ohledu by z hlediska MySQL mohlo dojít k určitému matení pojmů, v tomto systému si totiž můžete napsat vlastní funkci dvěma způsoby:

  1. Jednak můžete rozšířit databázový systém napsáním rutiny v jazycích C či C++ a tuto rutinu pak zaregistrovat pro použití na serveru,
  2. a jednak můžete (od verze 5.0.3) vytvářet uživatelsky definované funkce pomocí příkazu SQL - CREATE FUNCTION.

My se dnes budeme bavit pouze o tom druhém způsobu, a sice o vytváření funkcí pomocí příkazu CREATE FUNCTION. Tyto funkce se v mnohém podobají uloženým procedurám - například v tom, že mohou požadovat vstupní parametry nebo v tom, že jsou svázány s konkrétní databází. Než bych to dlouze vysvětloval, raději posloužím nějakým názorným příkladem. Je to odpověď na otázku, kterou často dostávám e-mailem: zda a jak se dá zajistit, aby MySQL vracela české datumy s textovým označením měsíce.

My na to půjdeme tak, že si vytvoříme funkci, která podle pořadového čísla měsíce "natvrdo" vrátí jeho textovou reprezentaci (ve druhém pádě). Jak bude tato funkce vypadat? Nějak takhle:

delimiter $$
create function mesicslovy (mesic tinyint)
returns varchar (9)
begin
return
case mesic
  when 1 then 'ledna'
  when 2 then 'února'
  when 3 then 'března'
  when 4 then 'dubna'
  when 5 then 'května'
  when 6 then 'června'
  when 7 then 'července'
  when 8 then 'srpna'
  when 9 then 'září'
  when 10 then 'října'
  when 11 then 'listopadu'
  when 12 then 'prosince'
end;
end $$
delimiter ;

Jak vidíte, je tvorba uživatelských funkcí v MySQL velmi prostá. Je ale přitom třeba mít na paměti následující zásady:

  1. Funkce se vytváří pomocí klauzule CREATE FUNCTION.
  2. Funkce může (ale pochopitelně nemusí) přijímat vstupní parametry. Těch může být jedna a více - ale je třeba určit jejich typ.
  3. Dále je třeba určit, jaký datový typ bude naše milá funkce vracet. To se provede pomocí klíčového slova RETURNS. Pozor, na konci je S.
  4. Pak následuje tělo funkce, ohraničené pomocí bloku BEGIN a END tak, jako je tomu u uložených procedur. Všimněte si, že v našem případě je tělo funkce tvořeno jediným příkazem; samozřejmě to není podmínka.
  5. Tělo funkce musí obsahovat klíčové slovo RETURN (bez S), které vrátí výsledek.

Volání funkce

Takto vytvořená funkce je pochopitelně k ničemu, pokud ji nebudeme z kódu volat. Pro volání uživatelem vytvořených funkcí přitom platí jednoduché pravidlo: volají se stejně jako funkce vestavěné. Jinými slovy systém se chová tak, jako by v něm naše drahá funkce byla odjakživa. Pokud tedy napíšete:

select mesicslovy(5);

Dostanete kýžený výsledek ("května"). Samozřejmě, že jedna funkce může volat funkci jinou:

delimiter $$
create function ceskedatum (datum date)
returns varchar (18)
begin
  return
  CONCAT(
    day(datum),
    '. ',
    mesicslovy (month(datum)),
    ' ',
    year(datum)
  );
end $$
delimiter ;

Můžete si to vyzkoušet: Stačí zavolat něco ve smyslu:

select ceskedatum(now());

a hned obdržíte hezkou českou reprezentaci data přímo z MySQL. Výhoda je jasná - pokud bude databázi využívat více různých klientů - možná napsaných v různých programovacích jazycích - všichni můžou těžit z této funkce uložené na serveru. A ještě jedna poznámka: při testech jsem si všiml, že MySQL standardně přetypovává vstupní parametry funkcí na ten datový typ, který funkce očekává. Prakticky to znamená, že následující příkaz PROJDE:

select ceskedatum('2005-12-24');

Funkce očekávala datum, ale dostala řetězec. Ten se pokusila převést na datum, což se povedlo a tak se celý příkaz v tichosti dokončil. Nejsem si tak úplně jistý, jestli je to dobře nebo špatně, ale pohodlné to každopádně je.

Použití funkcí

Přestože se funkcemi dá ošetřit leccos, měli byste je v MySQL používat spíše střízlivě. Do určité verze MySQL nesměly funkce obsahovat odkazy na tabulky, a i v současné době mají jistá omezení. "Správná" databázová funkce by tedy měla být krátká, měla by řešit pouze jeden problém a to problém související s daty. Pěkným příkladem mohou být právě funkce sloužící k formátování výstupu.

Online verze článku: http://www.linuxsoft.cz/article.php?id_article=1034