diff frontend/doc/database.txt @ 30:50708627f3c7

Ukończona strona klienta
author mild@mild-laptop
date Sun, 05 Jun 2011 23:10:18 +0200
parents c87f82a15606
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/frontend/doc/database.txt	Sun Jun 05 23:10:18 2011 +0200
@@ -0,0 +1,46 @@
+Baza danych
+===========
+
+Schemat bazy danych
+-------------------
+.. code-block:: sql
+
+    PRAGMA foreign_keys = ON;
+    CREATE TABLE users (
+        "id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,    -- ID Użytkownika
+        "username" TEXT NOT NULL,                           -- Nazwa użytkownika
+        "password" TEXT NOT NULL,                           -- Hash hasła użytkownika
+        "activated" BOOLEAN                                 -- Czy konto zostało uaktywnione
+    );
+    CREATE TABLE jobs (
+        "id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,    -- ID Zadania
+        "label" TEXT,                                       -- Opis zadania
+        "owner_id" INTEGER NOT NULL,                        -- ID właściciela zadania
+        "hash" TEXT NOT NULL,                               -- Hash do zdekodowania
+        "state" INTEGER NOT NULL DEFAULT (0),               -- Obecny stan operacji
+        "result" TEXT,                                      -- Wynik operacji
+        "percent" INTEGER,                                  -- Procent ukończenia operacji
+        "last_checked" TEXT,                                -- Ostatnio sprawdzany hash
+        "min_pass_len" INTEGER NOT NULL DEFAULT (1),        -- Minimalna długość hasła
+        "max_pass_len" INTEGER NOT NULL DEFAULT (5),        -- Maksymalna długość hasła
+        "method" INTEGER NOT NULL DEFAULT (0),              -- Metoda sprawdzania hashy
+        FOREIGN KEY("owner_id") REFERENCES users("id")
+    );
+
+Opisy pól w bazie danych
+------------------------
+
+jobs.state
+^^^^^^^^^^
+
+Pole to może przyjmować jedną z następujących wartości:
+
+0. Zadanie oczekujące na wykonanie
+1. Zadanie w trakcie wykonywania
+2. Zadanie zakończone
+
+Funkcje wspomagające operacje na bazie danych
+---------------------------------------------
+
+.. automodule:: mfrontend.db
+    :members: