[cvs] [Wiki] changed: Groo/Tables

[Luciano Ramalho]

luciano  Mon, 21 Aug 2006 06:54:26 -0700

Modified page: http://wiki.horde.org/Groo/Tables
New Revision:  1.1
Change log:  added table info

@@ -1,17 +1,26 @@
  + Groo tables
+
+[[toc]]
  
  ++ groo_books
  
-<code type="sql">
-CREATE TABLE groo_books (
+Each record represents a book in print, usually identified by an ISBN. Since older books don't have an ISBN, the primary key is and internal sequence. When the ISBN is NULL the title must not be NULL (but this is not enforced at this time).
+
+Books have a one-to-many relationship with Items (see groo_items groo_items).
+
+Books have a many-to-many relationship to Creators (see groo_creators and groo_l_book_creator).
+
+The title field is indexed for full text search.
+
+<code type="sql">CREATE TABLE groo_books (
      book_id INT UNSIGNED NOT NULL,
-    isbn13 CHAR(14),      -- ISBN13 + 1 DIGIT = GTIN
-    title VARCHAR(255),   -- Either isbn13 or title must not be null
-    title_sort VARCHAR(255),   -- Title for sorting purposes (article at end)
-    edition VARCHAR(63),  -- Ex: 1st; extended ultimate director's cut edition
+    isbn13 CHAR(14),        -- ISBN13 + 1 DIGIT = GTIN
+    title VARCHAR(255),     -- Either isbn13 or title must not be null
+    title_sort VARCHAR(255),-- Title for sorting purposes (article at end)
+    edition VARCHAR(63),    -- Ex: 1st; extended ultimate director's cut edition
      publisher VARCHAR(63),
-    issued CHAR(10), -- publication date in partial ISO-8601 format Ex: 1999-12
+    issued CHAR(10),        -- publication date in partial ISO-8601 format Ex: 1999-12
      metadata_status VARCHAR(32),           -- status of the data in this record
      metadata_source VARCHAR(32) NOT NULL,  -- source of the data in this record
      metadata_modified_dt TIMESTAMP,
      created_dt DATETIME NOT NULL,
@@ -20,4 +29,85 @@
      UNIQUE (isbn13),
      FULLTEXT (title)
  );
  </code>
+----
+++ groo_creators
+
+The name field is indexed for full text search.
+
+<code type="sql">CREATE TABLE groo_creators (
+    creator_id INT UNSIGNED NOT NULL,
+    name VARCHAR(255) NOT NULL,
+    metadata_source VARCHAR(32) NOT NULL,
+    metadata_modified_dt TIMESTAMP,
+    created_dt DATETIME NOT NULL,
+--
+    PRIMARY KEY (creator_id),
+    FULLTEXT (name)
+);
+</code>
+----
+++ groo_l_book_creator
+
+This table establishes the many-to-many relationship between Books and Creators
+
+<code type="sql">CREATE TABLE groo_l_book_creator (
+    book_id INT UNSIGNED NOT NULL,
+    creator_id INT UNSIGNED NOT NULL,
+    role CHAR(16),                    -- author, translator, editor, illustrator etc.
+    citation_order SMALLINT UNSIGNED, -- the order in which the creator name appears
+--
+    PRIMARY KEY (book_id, creator_id)
+);
+</code>
+----
+++ groo_items
+
+This table structured was borrowed from Mnemo (the mnemo_memos table). The only change, besides the fieldnames, was the addition of the item_book_id field, which is a foreign key linking to the groo_books table.
+
+Both item_id and item_uid are randomly generated unique strings. In a recent discussion on the //dev// list concluded with Chuck saying that id fields (such as item_id) in Horde tables should be converted back to integers. Item_uid will continue as is, because it is used for syncing to external devices. I don't know wether Groo items could be usefully synced to a cell phone or PDA, but for the time being the field stays.
+
+<code type="sql">CREATE TABLE groo_items (
+    item_owner      VARCHAR(255) NOT NULL, -- id of the Horde share which owns this item
+    item_id         VARCHAR(32) NOT NULL,  -- id of the item (a random string)
+    item_uid        VARCHAR(255) NOT NULL, -- uid of the item, for syncing to external devices
+    item_desc       VARCHAR(255) NOT NULL, -- short description of the item
+    item_body       TEXT,                  -- user comments on the item
+    item_book_id    INT UNSIGNED NOT NULL, -- the book of which this item is a copy
+    item_category   VARCHAR(80),           -- one of the user defined categories
+    item_private    SMALLINT NOT NULL DEFAULT 0, -- boolean?
+    item_modified   TIMESTAMP,             -- used to sort items by date of change
+--
+    PRIMARY KEY (item_owner, item_id)
+);
+</code>
+----
+++ groo_remote_queries
+
+This table is used by the Fetch.php module to record transactions with the remote metadata sources.
+
+Calling {{./Fetch.php --fetch-untitled}} via the command line adds a record in this table for each Book without a title added since the last fetch operation.
+
+Fetch.php then passes the list of queries to the fetch drivers (currently only Amazon.php is implemented). The fetch drivers should be prioritized, that is, the first one invoked should be the one most likely to have the metadata. For US books, Amazon.com is a good first choice because it has book covers (the Library of Congress catalog is more complete but does not have the convers).
+
+<code type="sql">CREATE TABLE groo_remote_queries (
+    query_id INT UNSIGNED NOT NULL AUTO_INCREMENT,
+    metadata_source VARCHAR(32) NOT NULL,   -- eg: amazon.com, bn.br etc.
+    param_name VARCHAR(32) NOT NULL,        -- eg: asin, isbn etc.
+    param_value VARCHAR(255) NOT NULL,      -- eg: 0486273474
+    last_attempt_num INT UNSIGNED DEFAULT 0,-- fetch attempts counter
+    last_attempt_dt DATETIME,
+    query_status CHAR(32),                  -- interna status string, eg: SUCCESS, NOT_FOUND
+    message TEXT,                           -- the actual message returned by the remote system
+    record_modified_dt TIMESTAMP,
+    created_dt DATETIME NOT NULL,
+--
+    PRIMARY KEY (query_id),
+    UNIQUE (metadata_source, param_name, param_value)
+);
+</code>
+
+
+
+
+