Manual:Database access/cs

Tento článek poskytuje přehled přístupu k databázi a obecných problémů s databází na MediaWiki.

Při kódování v MediaWiki budete obvykle přistupovat k databázi pouze prostřednictvím funkcí MediaWiki pro tento účel.

Rozložení databáze
Informace o rozvržení databáze MediaWiki, například popis tabulek a jejich obsah, naleznete v rozložení. Historicky to bylo v MediaWiki zdokumentováno také na, ale počínaje MediaWiki 1.35 dochází v rámci iniciativy Abstract Schema, k postupnému přesunu na. To znamená, že  se změní na   o, což usnadňuje generování souborů schématu pro podporu různých databázových strojů.

Použití sql.php
MediaWiki poskytuje skript údržby pro přístup k databázi z maintenance adresáře údržby:

Poté můžete zapisovat databázové dotazy. Alternativně můžete zadat název souboru a MediaWiki jej spustí, přičemž podle potřeby nahradí všechny speciální proměnné MW. Více informací najdete na stránce

To bude fungovat pro všechny databázové backendy. Výzva však není tak plnohodnotná jako klienti příkazového řádku dodávaní s vaší databází.

Použití klienta příkazového řádku mysql
V LocalSettings.php najdete heslo a uživatelské jméno vaší wiki pro MySQL, například:

Do SSH se přihlaste zadáním následujícího:

Nahraďte  a   informacemi. Poté budete vyzváni k zadání hesla, po kterém se zobrazí výzva.

Vrstva abstrakce databáze
MediaWiki poskytuje abstrakční vrstvu databáze. Pokud nepracujete na abstrakční vrstvě, nikdy byste neměli přímo volat funkce databáze PHP (například  nebo  ).

K abstrakční vrstvě se přistupuje prostřednictvím třídy. Příklad této třídy lze získat voláním  (přednostně) nebo pomocí   vložením. Funkce  se postupně vyřazuje a neměla by se používat v novém kódu. Buď se obvykle volá s jediným parametrem, kterým může být konstantní  (pro dotazy na čtení) nebo   (pro dotazy na psaní a čtení, které potřebují absolutně nejnovější informace). Rozdíl mezi základním a opakovaným je důležitý v prostředí více databází, jako je například Wikimedia. V části Balíčky funkcí (wrapper functions) níže najdete informace o tom, co můžete udělat s vráceným objektem.

Obálky výsledků výběrových dotazů jsou pole, jejichž klíče jsou celá čísla začínající na 1. K vytvoření dotazu pro čtení obvykle stačí něco takovéhoto:

""

Chcete-li napsat dotaz, použijte něco jako:

""

Používáme konvenci pro čtení a  pro zápis, abychom vám pomohli sledovat, zda je databázový objekt replikou (pouze pro čtení) nebo primárním (čtení/zápis). Pokud napíšete do repliky, svět exploduje. Nebo abychom byli přesní, následný zápisový dotaz, který uspěl na primárním serveru, může selhat při replikaci do repliky kvůli jedinečné kolizi klíče. Replikace na replice se zastaví a oprava databáze a její opětovné zprovoznění může trvat hodiny. Nastavením read_only v my.cnf na replice se tomuto scénáři vyhnete, ale vzhledem k hrozným následkům dáváme přednost co největšímu počtu kontrol.

Funkce obálky
Poskytujeme funkci query pro nezpracovaný SQL, ale funkce wrapperu jako select a insert jsou obvykle pohodlnější. Mohou se za určitých okolností postarat například o předvolby tabulek a escaping. Pokud opravdu potřebujete vytvořit svůj vlastní SQL, přečtěte si dokumentaci k tableName a addQuotes. Ob̟ě budete potřebovat. Nezapomeňte, že pokud nebudete správně používat addQuotes, můžete do své wiki vložit závažné bezpečnostní díry.

Dalším důležitým důvodem pro použití metod na vysoké úrovni, namísto vytváření vlastních dotazů, je zajištění správného fungování kódu bez ohledu na typ databáze. V současné době je nejlepší podpora pro MySQL/MariaDB. Existuje také dobrá podpora pro SQLite, je však mnohem pomalejší než MySQL nebo MariaDB. Existuje podpora pro PostgreSQL, ale není tak stabilní jako MySQL.

V následující části jsou uvedeny dostupné funkce obálky. Podrobný popis parametrů funkcí obálky (wrapper) najdete v dokumentech třídy 's. Zejména viz  pro vysvětlení ,  ,  ,  ,   a   parametrů, které používá mnoho dalších funkcí wrapperu.

Funkce wrapperu: select
Funkce select poskytuje rozhraní MediaWiki pro příkaz SELECT. Komponenty příkazu SELECT jsou kódovány jako parametry funkce select. Zde je příklad:

Tento příklad odpovídá dotazu

JOINs jsou také možné. Například:

Tento příklad odpovídá dotazu

poskytuje příklad jak používat tabulku aliasů v dotazech.

Argumenty jsou buď jednotlivé hodnoty (jako je 'category' a 'cat_pages > 0') nebo pole, pokud je pro pozici argumentu předána více než jedna hodnota (například ['cat_pages > 0', $myNextCond]). Pokud předáte řetězec třetím nebo pátým argumentům, musíte při vytváření řetězce ručně použít databázi Database::addQuotes, pokud sestavujete řetězec, protože to za vás wrapper neudělá. Hodnoty pro názvy tabulek (1. argument) nebo názvy polí (2. argument) nesmějí být kontrolovány uživatelem. Konstrukce pole pro $conds je poněkud omezená. Může provádět pouze vztahy rovnosti a  (tj. WHERE key = 'value').

K jednotlivým řádkům výsledku můžete přistupovat pomocí smyčky foreach. Jakmile máte řádkový objekt, můžete použít operátor  pro přístup ke konkrétnímu poli. Úplným příkladem může být:

Který vloží abecední seznam kategorií s počtem položek, které má každá kategorie v proměnné $output. Pokud vystupujete jako HTML, ujistěte se, že chcete uniknout hodnotám z databáze pomocí

Pohodlné funkce
Pro kompatibilitu s PostgreSQL jsou idy vložení získány pomocí nextSequenceValue a insertId. Parametr pro nextSequenceValue lze získat z příkazu  v   a vždy odpovídá formátu x_y_seq, kde x je název tabulky (např. page) a y je primární klíč (např. page_id), např. page_page_id_seq. Například:

Pro některé další užitečné funkce, např. affectedRows, numRows atd., viz Manual:Database.php.

Základní optimalizace dotazu
Vývojáři MediaWiki, kteří potřebují psát dotazy na DB, by měli mít určité znalosti o databázích a s nimi spojenými problémy s výkonem. Opravy obsahující nepřijatelně pomalé funkce nebudou přijaty. Neindexované dotazy nejsou na MediaWiki obecně vítány, s výjimkou zvláštních stránek odvozených z QueryPage. Pro nové vývojáře je obvyklé předkládat kód obsahující dotazy SQL, které zkoumají obrovské množství řádků. Pamatujte, že COUNT(*) je O(N), počítání řádků v tabulce je jako počítání fazolí v kbelíku.

Backward compatibility
Often, due to design changes to the DB, different DB accesses are necessary to ensure backward compatibility. This can be handled for example with the global variables and :

Replikace
Velké instalace MediaWiki, jako je Wikipedia, používají velkou sadu podřízených serverů MySQL replikujících zápisy na hlavní server MySQL. Pokud chcete psát kód určený pro Wikipedii, je důležité porozumět problémům spojeným s tímto nastavením.

Často se stává, že nejlepší algoritmus pro daný úkol závisí na tom, zda se replikace používá. Kvůli našemu neustálému centrování na Wikipedii často používáme pouze verzi vhodnou pro replikaci, ale pokud chcete, můžete použít a zkontrolovat, zda je replikace při použití.

Lag
K Lag (nadměrnému zpoždění) dochází primárně, když jsou velké požadavky na zápis odesílány do masteru. Zápisy na masteru jsou prováděny paralelně, ale jsou replikovány do série, když jsou replikovány na slaves. Master píše dotaz do binlogu, když je transakce potvrzena. WSlaves dotazují binlog a začnou provádět dotaz, jakmile se objeví. Mohou číst služby, zatímco provádějí dotaz na zápis, ale nebudou číst nic víc z binlogu a nebudou tedy provádět žádné další zápisy. To znamená, že pokud bude dotaz na psaní spuštěn po dlouhou dobu, budou slave zaostávat za masterem po dobu potřebnou k dokončení dotazu na zápis.

Lag může být zvýšen vysokým čtením. Vyrovnávač zatížení MediaWiki zastaví odesílání čtení slave, pokud je zpožděn o více než 30 sekund. Pokud jsou poměry zatížení nastaveny nesprávně nebo pokud je obecně příliš velké zatížení, může to vést k tomu, že se slave trvale zpožďuje kolem 30 sekund.

Pokud jsou všechny slaves zpožděny o více než 30 sekund (podle ), MediaWiki přestane zapisovat do databáze. Všechny úpravy a další operace zápisu budou odmítnuty s chybou vrácenou uživateli. To dává slaves šanci vše dohnat. Než jsme získali tento mechanismus, slaves se pravidelně zpožďovali o několik minut, což ztěžovalo revizi posledních úprav.

Kromě toho se MediaWiki snaží zajistit, aby uživatel viděl události na wiki v chronologickém pořadí. Několik sekund zpoždění může být tolerováno, pokud uživatel uvidí konzistentní obrázek z následných požadavků. To se provádí uložením pozice hlavního binlogu v relaci a poté na začátku každé žádosti čekáním, až podřízená jednotka tuto pozici dohraje, než z ní provede jakékoli čtení. Pokud toto čekání vyprší, čtení je přesto povoleno, ale požadavek je považován za „zpožděný režim slave“. Opožděný režim slave lze zkontrolovat voláním. Jediným praktickým důsledkem v současné době je varování zobrazené v zápatí stránky.

Uživatelé prostředí Shell mohou kontrolovat zpoždění replikace pomocí ; ostatní uživatelé s rozhraním API.

Databáze mají často také své vlastní monitorovací systémy, viz například MariaDB (Wikimedia) a wikitech:Help:Toolforge/Database (Wikimedia Cloud VPS).

Vyhnutí se Lag
Chcete-li se vyhnout nadměrnému zpoždění, dotazy, které píší velké množství řádků, by se měly rozdělit. Obvykle psát vždy jeden řádek najednou. Víceřádkový VLOŽIT (INSERT) ... VYBRAT (SELECT) dotazy jsou nejhorší pachatelé a je třeba se jim úplně vyhnout. Místo toho proveďte nejprve výběr a poté vložení.

Even small writes can cause lag if they are done at a very high speed and replication is unable to keep up. This most commonly happens in maintenance scripts. To prevent it, you should call after every few hundred writes. Most scripts make the exact number configurable:

Práce se zpožděním
I přes naše nejlepší úsilí není praktické zaručit prostředí s malým zpožděním. Zpoždění replikace bude obvykle kratší než jedna sekunda, ale někdy může být až 30 sekund. Pro škálovatelnost je velmi důležité udržovat nízké zatížení masteru, takže jednoduše odeslání všech vašich dotazů na master není odpověď. Pokud tedy skutečně potřebujete aktuální data, doporučuje se následující postup:


 * 1) Rychlý dotaz na master pro pořadové číslo nebo časové razítko
 * 2) Spusťte úplný dotaz na slave a zkontrolujte, zda odpovídá datům, která jste dostali od mastera
 * 3) Pokud se tak nestane, spusťte úplný dotaz na hlavním počítači

Aby se předešlo zaplavení master pokaždé, když slaves zpozdí, použití tohoto přístupu by mělo být omezeno na minimum. Ve většině případů byste měli číst pouze z podřízené jednotky a nechat uživatele vypořádat se zpožděním.

Uzamčení sporu
Vzhledem k vysoké míře zápisu na Wikipedii (a některých dalších wiki) musí být vývojáři MediaWiki velmi opatrní při strukturování svých zápisů, aby se vyhnuli dlouhodobým zámkům. Ve výchozím nastavení MediaWiki otevře transakci při prvním dotazu a potvrdí ji před odesláním výstupu. Zámky se budou držet od doby, kdy je dotaz proveden, až po potvrzení. Takže můžete zkrátit dobu uzamčení provedením co nejvíce zpracování, než začnete psát dotazy. Operace aktualizace, které nevyžadují přístup k databázi, mohou být zpožděny až po odevzdání přidáním objektu do.

Tento přístup často není dost dobrý a je nutné uzavřít malé skupiny dotazů do jejich vlastní transakce. Použijte následující syntaxi:

Použití blokovacích čtení (např. klauzule FOR UPDATE) se nedoporučuje. Jsou špatně implementovány v InnoDB a způsobí pravidelné chyby zablokování. Je také překvapivě snadné ochromit wiki s tvrzením o uzamčení.

Namísto zamykání čtení zkombinujte své existenční kontroly do svých písemných dotazů pomocí vhodné podmínky v klauzuli WHERE UPDATE nebo pomocí jedinečných indexů v kombinaci s INSERT IGNORE. Potom pomocí ovlivněného počtu řádků zjistěte, zda byl dotaz úspěšný.

Schéma databáze
Při vytváření databází nezapomeňte na indexy, na zkušební wiki s desítkami stránek mohou věci hladce fungovat, ale skutečná wiki se zastaví. Podrobnosti viz výše.

Konvence pojmenování viz.

SQLite kompatibilita
Při psaní definic tabulek MySQL nebo upgradování oprav je důležité si uvědomit, že SQLite sdílí MySQL schéma, ale funguje to pouze tehdy, pokud jsou definice psány specifickým způsobem:


 * Primární klíče musí být deklarovány v deklaraci hlavní tabulky, ale normální klíče by měly být přidány samostatně s CREATE INDEX:

Do definice hlavní tabulky by však měly být zahrnuty primární klíče zahrnující více než jedno pole:


 * Nepřidávejte do příkazu více než jeden sloupec:


 * Nastavte explicitní výchozí hodnoty při přidávání sloupců NOT NULL:

Základní kontroly kompatibility můžete spustit pomocí:



Nebo, pokud potřebujete testovat aktualizaci, postupujte takto:


 * (s novým tables.sql)
 * Protože záplaty DB aktualizují také soubor tables.sql, pro tento by jste měli předat předběžnou verzi tables.sql (soubor s úplnou definicí DB). Jinak můžete získat chybu, pokud přetáhněte index (protože již neexistuje v tables.sql, protože jste jej právě odstranili).
 * Protože záplaty DB aktualizují také soubor tables.sql, pro tento by jste měli předat předběžnou verzi tables.sql (soubor s úplnou definicí DB). Jinak můžete získat chybu, pokud přetáhněte index (protože již neexistuje v tables.sql, protože jste jej právě odstranili).

Výše uvedené předpokládá, že jste v $IP/maintenance/, jinak předejte úplnou cestu k souboru. Pro opravy rozšíření použijte ekvivalent těchto přípon.

Viz též

 * &mdash; Pokud rozšíření vyžaduje změny v databázi při aktualizaci MediaWiki, lze to provést pomocí tohoto hook. Uživatelé pak mohou aktualizovat svou wiki spuštěním.