SearchWiki
NoSQL.RecentChanges
Edit Page
Page Revisions
Groups available

CSA
Calendar
Main
NoSQL
People
PmWiki
PmWikiIt
PtvDev
RssFeeds
ScriptaVox
ScriptaWeb
ScriptaWiki

Quick links

TextFormattingRules
Edit Menu

Campaigns

A table (or relation) is an ordinary ASCII file, with some additional rules that make it possible to use it as a database table. The file has records (rows) and fields (columns). The relation, or table structure, is achieved by separating the columns with ASCII TAB characters and terminating the rows with ASCII NEWLINE characters. That is, each row of data in a file contains the data values (each in a data field) separated by TAB characters and terminated with a NEWLINE character. Therefore a fundamental rule is that data values must NOT contain TAB characters.

The first section of the file, called the header, contains the file structure information used by the operators. The rest of the file, called the body, contains the actual data values. A file of data, so structured, is said to be a "table".

The header consists of exactly one line that contains the structure information: the column name row. Each column name begins with an octal "\001" character, i.e. ASCII start of header ("SOH") character, and is separated from the next column name by an ASCII TAB. The SOH character must uniquely mark the beginning of column names, and especially the beginning of the table header, and therefore it may not appear anywhere else as the first character in a row. The fields in the column name row contain the names of each column, and are separated from each other by a single TAB character. In the rest of this document, the SOH characters usually will be omitted from the explanations, but it is implied that they must always be present at the beginning of each column name.

The SOH character was choosen for a reason: it is the character that sorts at the top in lexicographical order, so that the table header does not usually need to be treated especially when sorting or performing most other table manipulations. It has been added to the beginning of each column name, not just the first one, to make it survive "table slicing" and column reordering. See the TableHeader page for a dissertation on this problematic topic.

Trailing blank (i.e. 'space') characters in data columns are NOT considered significant, and NoSQL operators may freely decide to drop them at will. Note that while it is ok to have leading blanks in the data rows of a table, not all NoSQL programs will accept them in the table header.

The column names are case sensitive, i.e. "COUNT" is different from "Count." The guideline for characters that may be used in column names is that alphabetic, numeric, and the underscore (_) are good choices. Numeric-only column names are not allowed.

The TAB character must never be used in column names, nor should spaces or UNIX I/O redirection characters (<,>,|) be used. To be on the safe side, column names should always start with a letter and contain only upper and lower case letters, numbers, and the underscore (_). The following names are reserved to the AWK programming language, and should not be used to indicate column names:

BEGIN, END, break, continue, else, exit, exp, for, getline, gsub, if, in, index, int, length, log, next, print, printf, split, sprintf, sqrt, sub, substr, while, and possibly others. Refer to the mawk(1) man page. Furthermore, the "_" character should never be used at the beginning of column names, as that is sometimes used by NoSQL for internal purposes. Finally, appending the "_" character at the end of column names, although perfectly acceptable, should be reserved to special needs of the application program, like inserting dummy columns in the STDOUT of a query, and to other circumstances where the application needs to use column names that are not supposed to appear in a table.

For instance, if you have a table that maps names to nicknames, then the table's two columns could be called Name and Nickname. Some NoSQL operators create new columns that have the same name as pre-existing table columns with lower-case letters prepended to them. This is why you really should stick to these rules.

Not abiding by these naming rules may still work, but there may be unexpected results.

A sample table (named sample.table) that will be used in later examples is shown in Table 1. The picture in Table 1 is for illustrative purposes; what the file would actually look like is shown in Table 2, where a TAB character is represented by "<T>," a NEWLINE is represented by "<N>" and a SOH by "<S>."

Table 1: sample.table
    NAME    COUNT   TYP     AMT
    Bush       44     A     133
    Hansen     44     A     23 
    Jones      77     X     77 
    Perry      77     B     244
    Hart       77     D     1111
    Holmes     65     D     1111

Table 2: sample.table (actual content)

    <S>NAME<T><S>COUNT<T><S>TYP<T><S>AMT<N>
    Bush<T>44<T>A<T>133<N>
    Hansen<T>44<T>A<T>23<N>
    Jones<T>77<T>X<T>77<N>
    Perry<T>77<T>B<T>244<N>
    Hart<T>77<T>D<T>1111<N>
    Holmes<T>65<T>D<T>1111<N>

It is important to note that only actual data is stored in the data fields, with no leading or trailing space characters. This fact can (and usually does) have a major effect on the size of the resulting datafiles (tables) compared to data stored in "fixed field width" systems. The datafiles in NoSQL are almost always smaller, sometimes dramatically smaller.

A table also can be represented in a different format, called "list format". The list format of the above sample.table is:

      NAME  Bush
      COUNT 44
      TYP   A
      AMT   133     

      NAME  Hansen
      COUNT 44
      TYP   A
      AMT   23      

      NAME  Jones
      COUNT 77
      TYP   X
      AMT   77      

      NAME  Perry
      COUNT 77
      TYP   B
      AMT   244     

      NAME  Hart
      COUNT 77
      TYP   D
      AMT   1111    

      NAME  Holmes
      COUNT 65
      TYP   D
      AMT   1111

The actual contents of a table in 'list' format, showing newlines and TABs is:

      <N>
      NAME<T>Bush<N>
      COUNT<T>44<N>
      TYP<T>A<N>
      AMT<T>133<N>
      <N>
      NAME<T>Hansen<N>
      COUNT<T>44<N>
      TYP<T>A<N>
      AMT<T>23<N>
      <N>
      NAME<T>Jones<N>
      COUNT<T>77<N>
      TYP<T>X<N>
      AMT<T>77<N>
      <N>
      NAME<T>Perry<N>
      COUNT<T>77<N>
      TYP<T>B<N>
      AMT<T>244<N>
      <N>
      NAME<T>Hart<N>
      COUNT<T>77<N>
      TYP<T>D<N>
      AMT<T>1111<N>
      <N>
      NAME<T>Holmes<N>
      COUNT<T>65<N>
      TYP<T>D<N>
      AMT<T>1111<N>
      <N>

Long lines, i.e. lines that are too long to fit in the width of the screen, may be folded over multiple rows in the 'list' format, provided that each continuation row starts with one TAB character. Field (column) names need to be separated by the associated data by exactly one TAB characters. The data part may contain physical TABs and newlines, which will be turned into '\t' and '\n' escapes respectively by the 'listtotable' operator when the list is turned into a table.

      COMMENTS  This is a very looong comment, that I want to fold over
        multiple lines.

and the actual content is :

      <N>
      COMMENTS<T>This is a very looong comment, that I want to fold over<N>
      <T>multiple lines.<N>
      <N>

As we will see, there are NoSQL operators that convert back and forth between "table" and "list" formats. The list leading empty row is called the list header, while the trailing empty row is called the list footer.

<< IntroductionToNoSQL | NoSQL.DocumentationIndex | DataTypes >>

Edit Page - Page Revisions - WikiHelp - SearchWiki - RecentChanges - Printable version
Page last modified on June 17, 2006, at 19:16 (CEST)