UNPKG

1.66 kBMarkdownView Raw
1![Module](https://img.shields.io/badge/%40platform-cell.schema-%23EA4E7E.svg)
2[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
3[![NPM](https://img.shields.io/npm/v/@platform/cell.schema.svg?colorB=blue&style=flat)](https://www.npmjs.com/package/@platform/cell.schema)
4![banner](https://user-images.githubusercontent.com/185555/68096906-c7ece580-ff18-11e9-8b4f-bfa6c7ca21f1.png)
5
6URI and database schemas for the `CellOS`.
7
8## Setup
9
10 yarn add @platform/cell.schema
11
12<p>&nbsp;</p>
13
14## URI Scheme
15
16See `Schema.uri` for URI helpers.
17
18```
19KIND URI DESCRIPTION
20---------------------------------------------------------------------------------------------------------------------------------
21Namespace ns:<id> A set of cells/row/columns that exist in the same logical-space (aka "table" or "sheet").
22Cell cell:<ns>!<A1> A single cell (the core primitive data-structure of CellOS).
23Row row:<ns>!<1> Meta-data for a single "row" within a namespace.
24Column col:<ns>!<A> Meta-data for a single "column" within a namespace.
25File file:<ns>.<id> A binary file.
26```
27
28<p>&nbsp;</p>
29<p>&nbsp;</p>
30
31![diagram](https://user-images.githubusercontent.com/185555/69764149-3c433d80-11d4-11ea-8f43-add586e2c04a.png)
32
33<p>&nbsp;</p>
34<p>&nbsp;</p>
35
36## URI to DB Mapping (Path)
37
38See [@platform/cell.db](../cell.db) for database model implementation.
39
40![diagram](https://user-images.githubusercontent.com/185555/69764162-4402e200-11d4-11ea-9004-84898d44ea0d.png)
41
42<p>&nbsp;</p>
43<p>&nbsp;</p>