Skip to content

Commit

Permalink
fix typos and tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
lmcmicu committed Sep 4, 2024
1 parent 21ea38f commit a5c3e17
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Below is an example of one of the views Valve provides into a data table in whic

(5 rows)

Here, **row_number** is a fixed identifier assigned to each row at the time of creation, while **row_order**, which in principle might change multiple times throughout the lifetime of a given row, is used to manipulate the logical order of rows in the table. The **message** column, in this example, conveys that the value 'denise_l' of the column "employee_id" in row 3, and the value 'eddie_c' of the same column in rows 4 and 5, are duplicates of already existing values of that column, which happens to be a primary key, and are therefore invalid. We can also see, from the **history** column, that there has been one change, in which one of values in row 3, namely the value of the column "rank", has been changed from 'intern' to 'Chief executive officer'. Finally, the names of the columns to the right of the **history** column correspond to the column names of the source table and will therefore vary from table to table. Normally these column names are specified in the header of a '.tsv' file from which the source data is read, though see [below](#further-information-on-path) for alternate input data formats and associated table options. In any case the data contained in the columns to the right of the **history** column will exactly match the contents of the source table unless the data has been edited since it was initially loaded.
Here, **row_number** is a fixed identifier assigned to each row at the time of creation, while **row_order**, which in principle might change multiple times throughout the lifetime of a given row, is used to manipulate the logical order of rows in the table. The **message** column, in this example, conveys that the value 'denise_l' of the column "employee_id" in row 3, and the value 'eddie_c' of the same column in rows 4 and 5, are duplicates of already existing values of that column, which happens to be a primary key, and are therefore invalid. We can also see, from the **history** column, that there has been one change, in which one of the values in row 3, namely the value of the column "rank", has been changed from 'intern' to 'Chief executive officer'. Finally, the names of the columns to the right of the **history** column correspond to the column names of the source table and will therefore vary from table to table. Normally these column names are specified in the header of a '.tsv' file from which the source data is read, though see [below](#further-information-on-path) for alternate input data formats and associated table options. In any case the data contained in the columns to the right of the **history** column will exactly match the contents of the source table unless the data has been edited since it was initially loaded.

For the example below we will assume that a file named `artists.tsv` exists on your hard disk in your current working directory with the following contents:

Expand Down Expand Up @@ -541,7 +541,7 @@ user_view3 | | |

Note that in the first row above the table being described is the table table itself. In general the columns of the table table have the following significance:
- **table**: the name of the table.
- **path**: where to find information about the contents of the table (see below). Note that the path for one of the special configuration tables must be a '.tsv' file.
- **path**: where to find information about the contents of the table (see below). Note that the path of a special configuration tables must be a '.tsv' file.
- **description**: An optional description of the contents and/or the purpose of the table.
- **type**: Valve recognizes four special configuration table types that can be specified using the **type** column of the table table. These are the `table`, `column`, `datatype`, and `rule` table types. Data tables (e.g., the 'user_*' tables in the above example) should not explicitly specify a type, and in general if a type other than the ones just mentioned is specified, Valve will exit with an "Unrecognized table type" error.
- **options** (optional column): Allows the user to specify a number of further options for the table (see below).
Expand Down Expand Up @@ -590,7 +590,7 @@ If no options are specified, the options *db_table*, *truncate*, *load*, *save*,
- *internal*: This option is reserved for internal use and is not allowed to be specified by the user.
- *validate_on_load*: When set, Valve will validate a table's rows before loading them to the database. Note that this option is not compatible with *db_view*.
- *edit*: When set, this option indicates that it is allowed to edit the table after it has been initially loaded. Note that this option is not compatible with *db_view*.
- *save*: When set, this indicates that it is allowed to save the table to a '.tsv' file. Note that this option is not compatible with *db_view*.
- *save*: When set, this indicates that overwriting the table's source file, as indicated by **path** (which must be a '.tsv' file) is allowed. If the *save* option is not set, the table may nevertheless be saved as long as it is to a different path. Note that the *save* option is not compatible with *db_view*.
- *no-conflict*: Sets the *conflict* option (which is set to true by default unless *db_view* is true) to false.
- *no-validate_on_load*: Sets the *validate_on_load* option (which is set to true by default unless *db_view* is true) to false.
- *no-edit*: Sets the *edit* option (which is set to true by default unless *db_view* is true) to false.
Expand Down

0 comments on commit a5c3e17

Please sign in to comment.