W3C home > Mailing lists > Public > public-webapps@w3.org > July to September 2012

[Bug 18328] New: [IndexedDB] Editorial: Clarify that "record value" === "referenced primary key" for indeces

From: <bugzilla@jessica.w3.org>
Date: Thu, 19 Jul 2012 09:37:17 +0000
To: public-webapps@w3.org
Message-ID: <bug-18328-2927@http.www.w3.org/Bugs/Public/>
https://www.w3.org/Bugs/Public/show_bug.cgi?id=18328

           Summary: [IndexedDB] Editorial: Clarify that "record value" ===
                    "referenced primary key" for indeces
           Product: WebAppsWG
           Version: unspecified
          Platform: All
        OS/Version: All
            Status: NEW
          Severity: minor
          Priority: P2
         Component: Indexed Database API
        AssignedTo: dave.null@w3.org
        ReportedBy: odinho@opera.com
         QAContact: public-webapps-bugzilla@w3.org
                CC: mike@w3.org, public-webapps@w3.org


In 3.1.6 Index you find this:

# The records in an index are always sorted according to the records key.
# However unlike object stores, a given index can contain multiple records
# with the same key. Such records are additionally sorted according to the
# records value.


And in a note in the "steps for iterating a cursor" you find:

# records is always sorted in ascending key order. In the case of 
# source being an index, records is secondarily sorted in ascending
# value order.

That is all fine and dandy, because for an index, the key is "toyota" and the
value is in fact a *pointer to the referenced record*, so value will be the
*key* of the objectstore record.


Technically there is no problem, however, those sentences up there might easily
confuse humans (I always have to read it twice). So I hope we can tweak the
wording; In "3.1.6 Index"

# The records in an index are always sorted according to the records key.
# However unlike object stores, a given index can contain multiple records
# with the same key. Such records are additionally sorted according to the
# records value (meaning the key of a record in a referenced object store)

And in the steps for iterating a cursor:

# records is always sorted in ascending key order. In the case of 
# source being an index, records is secondarily sorted in ascending
# value order (value in an index is a key from the referenced object
# store).


Please feel free to make it even better or clearer, I'm not super happy about
the fixes.

Yeah, and sorry for making bugs at this time, but I hope we want to fix stuff
even after CR. ;-)

-- 
Configure bugmail: https://www.w3.org/Bugs/Public/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are on the CC list for the bug.
Received on Thursday, 19 July 2012 09:37:21 GMT

This archive was generated by hypermail 2.3.1 : Tuesday, 26 March 2013 18:49:54 GMT