git.iko.soy/project-m36
on master help sign in
add basic data frames documentation
c0e84ceAgentM
README.markdown+1
compare with master
unifiedsplit
@@ -68,6 +68,7 @@ Project:M36 supports multiple frontends which target different audiences.
68
68
691. [Transaction Graph Operators](docs/transaction_graph_operators.markdown)
691. [Transaction Graph Operators](docs/transaction_graph_operators.markdown)
701. [ProjectM36.Client Library](docs/projectm36_client_library.markdown)
701. [ProjectM36.Client Library](docs/projectm36_client_library.markdown)
71+1. [Data Frames for Sorting](docs/dataframes.markdown)
711. [Adding New Data Types](docs/new_datatypes.markdown)
721. [Adding New Data Types](docs/new_datatypes.markdown)
721. [Database-Manipulating Functions](docs/database_context_functions.markdown)
731. [Database-Manipulating Functions](docs/database_context_functions.markdown)
731. [Serving Remote ProjectM36 Databases](docs/server_mode.markdown)
741. [Serving Remote ProjectM36 Databases](docs/server_mode.markdown)
docs/dataframes.markdownnew file+53
@@ -0,0 +1,53 @@
1+# Project:M36 DataFrames
2+
3+Users of typical relational algebra engines have come to expect sorting and limiting of query results despite the fact that relations do not support ordering. To that end, Project:M36 supports converting relations to "data frames" to support sorting on attributes and limiting the maximum tuple count in the result set.
4+
5+The equivalent feature in SQL is invoked by the `ORDER BY`, `LIMIT`, and `OFFSET` clauses.
6+
7+## Usage
8+
9+From within the `tutd` console, converting a relation to be sorted as a data frame is invoked using the `:showdataframe` command.
10+
11+```
12+:showdataframe <relational expression> orderby {<attribute {ascending,descending}>} {offset <num>} {limit <num>}
13+```
14+
15+The default sort order is `ascending`.
16+
17+## Examples
18+
19+```
20+TutorialD (master/main): :showdataframe s orderby {status}
21+┌──┬───────────┬─────────┬────────────┬────────────────┐
22+│DF│city::Text↕│s#::Text↕│sname::Text↕│status::Integer⬆│
23+├──┼───────────┼─────────┼────────────┼────────────────┤
24+│1 │"Paris" │"S2" │"Jones" │10 │
25+│2 │"London" │"S1" │"Smith" │20 │
26+│3 │"London" │"S4" │"Clark" │20 │
27+│4 │"Athens" │"S5" │"Adams" │30 │
28+│5 │"Paris" │"S3" │"Blake" │30 │
29+└──┴───────────┴─────────┴────────────┴────────────────┘
30+TutorialD (master/main): :showdataframe s{status} orderby {status}
31+┌──┬────────────────┐
32+│DF│status::Integer⬆│
33+├──┼────────────────┤
34+│1 │10 │
35+│2 │20 │
36+│3 │30 │
37+└──┴────────────────┘
38+TutorialD (master/main): :showdataframe s{status} orderby {status descending} limit 1
39+┌──┬────────────────┐
40+│DF│status::Integer⬇│
41+├──┼────────────────┤
42+│1 │30 │
43+└──┴────────────────┘
44+TutorialD (master/main): :showdataframe s{status} orderby {status descending} offset 1 limit 3
45+┌──┬────────────────┐
46+│DF│status::Integer⬇│
47+├──┼────────────────┤
48+│1 │20 │
49+│2 │10 │
50+└──┴────────────────┘
51+
52+```
53+The arrow in the attributes indicates the sort order while the DF column indicates the row number based on the sort order. Column ordering can also be arbitrary.