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 |
|
6 | URI and database schemas for the `CellOS`.
|
7 |
|
8 | ## Setup
|
9 |
|
10 | yarn add @platform/cell.schema
|
11 |
|
12 | <p> </p>
|
13 |
|
14 | ## URI Scheme
|
15 |
|
16 | See `Schema.uri` for URI helpers.
|
17 |
|
18 | ```
|
19 | KIND URI DESCRIPTION
|
20 | ---------------------------------------------------------------------------------------------------------------------------------
|
21 | Namespace ns:<id> A set of cells/row/columns that exist in the same logical-space (aka "table" or "sheet").
|
22 | Cell cell:<ns>!<A1> A single cell (the core primitive data-structure of CellOS).
|
23 | Row row:<ns>!<1> Meta-data for a single "row" within a namespace.
|
24 | Column col:<ns>!<A> Meta-data for a single "column" within a namespace.
|
25 | File file:<ns>.<id> A binary file.
|
26 | ```
|
27 |
|
28 | <p> </p>
|
29 | <p> </p>
|
30 |
|
31 | ![diagram](https://user-images.githubusercontent.com/185555/69764149-3c433d80-11d4-11ea-8f43-add586e2c04a.png)
|
32 |
|
33 | <p> </p>
|
34 | <p> </p>
|
35 |
|
36 | ## URI to DB Mapping (Path)
|
37 |
|
38 | See [@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> </p>
|
43 | <p> </p>
|