Dave Jarvis' Repositories

git clone https://repo.autonoma.ca/repo/rxm.git

Documentation clarifications.

Author Dave Jarvis <email>
Date 2015-02-08 13:20:28 GMT-0800
Commit 15a272638c79a3a5b64f869dca00a2db131d8400
Parent 08098e5
README.md
# Overview
-Relational XPath Map (**rxm**) is a terse database query language to
+Relational eXpression Map (**rxm**) is a terse database query language to
produce structured documents.
-
-While the examples show how to produce an XML document, the same
-mapping could be used to produce any structured format, including JSON.
# Syntax
Each line in the mapping consists primarily of a database entity on the left
-and a simple XPath expression on the right.
+and an expression on the right.
```
```
-This would produce a document similar to the following:
+The database entity can be a *table name*, a *column name*, or a *table and
+column name*. The expression is an XPath node, an attribute, or a
+*table and column name*.
+
+The above mapping could produce the following:
```
</people>
```
-
-The database entity can be a *table name*, a *column name*, or a *table and
-column name*. The XPath expression is a node, an attribute, or a *table and
-column name*.
-Exceptions to the line format take the form of pops and globs.
+Although an XML document is shown, the same mapping could generate any
+structured document format, including JSON.
### Pops
The kleene star preceded by a column demarcation (`.`) indicates that all
-columns must be mapped. Each node name corresponds directly to the entity
-column name. Spaces in column names are replaced with underscores.
+columns are mapped automatically. Each node name corresponds directly to
+the entity column name. Spaces in column names are replaced with underscores.
## Where
Delta 11 lines added, 13 lines removed, 2-line decrease