modscape 0.9.0 → 0.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.ja.md
CHANGED
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
- **自動レイアウト永続化**: キャンバス上の配置は、即座に元のYAMLファイルの座標情報として保存。
|
|
30
30
|
- **ドメイン・グルーピング**: テーブルをビジネスドメインごとに整理。
|
|
31
31
|
- **分析メタデータ**:
|
|
32
|
-
-
|
|
32
|
+
- **ファクトテーブル・タイプ**: `transaction`, `periodic`, `accumulating`, `factless` といったデータの性質を定義。
|
|
33
33
|
- **SCD(徐変ディメンション)管理**: `SCD Type 2` などの履歴管理方式を可視化。
|
|
34
34
|
- **加算規則(Additivity)**: カラムが合計可能か(`fully`, `semi`, `non`)を明示し、BI開発をガイド。
|
|
35
35
|
- **メタデータ/監査追跡**: 監査用カラムを専用アイコンで識別。
|
|
@@ -103,8 +103,8 @@ tables:
|
|
|
103
103
|
appearance:
|
|
104
104
|
type: fact # fact | dimension | hub | link | satellite
|
|
105
105
|
# --- 分析メタデータ ---
|
|
106
|
-
|
|
107
|
-
|
|
106
|
+
sub_type: transaction # transaction | periodic | accumulating | factless
|
|
107
|
+
# (Dimension用SCDタイプ: type0 | type1 | type2 | type3 | type4 | type5 | type6 | type7)
|
|
108
108
|
icon: 📦 # カスタム絵文字や文字
|
|
109
109
|
color: "#f87171" # エンティティのテーマカラー
|
|
110
110
|
|
package/README.md
CHANGED
|
@@ -29,7 +29,7 @@ In modern data analysis platforms, data modeling is no longer just about drawing
|
|
|
29
29
|
- **Auto-Layout Persistence**: Arrange nodes on the canvas; coordinates are saved directly back to your YAML.
|
|
30
30
|
- **Domain Grouping**: Organize tables into visual business domains.
|
|
31
31
|
- **Analytics Metadata**:
|
|
32
|
-
- **Fact
|
|
32
|
+
- **Fact Table Types**: Define `transaction`, `periodic`, `accumulating`, or `factless` grains.
|
|
33
33
|
- **SCD Management**: Visualize `SCD Type 2` and other history-tracking dimensions.
|
|
34
34
|
- **Additivity Rules**: Mark columns as `fully`, `semi`, or `non-additive` to guide BI development.
|
|
35
35
|
- **Metadata/Audit Tracking**: Identify audit columns with specialized visual cues.
|
|
@@ -103,8 +103,8 @@ tables:
|
|
|
103
103
|
appearance:
|
|
104
104
|
type: fact # fact | dimension | hub | link | satellite
|
|
105
105
|
# --- Analytics Metadata ---
|
|
106
|
-
|
|
107
|
-
|
|
106
|
+
sub_type: transaction # transaction | periodic | accumulating | factless
|
|
107
|
+
# (Use sub_type for SCD types in Dimensions: type0 | type1 | type2 | type3 | type4 | type5 | type6 | type7)
|
|
108
108
|
icon: 📦 # Custom emoji or character
|
|
109
109
|
color: "#f87171" # Custom theme color for this entity
|
|
110
110
|
|
package/package.json
CHANGED
package/src/index.js
CHANGED
package/src/templates/rules.md
CHANGED
|
@@ -11,18 +11,21 @@
|
|
|
11
11
|
## 2. Analytics Metadata
|
|
12
12
|
Modscape supports attributes to communicate the "Story" and "Grain" of your data to humans and AI agents.
|
|
13
13
|
|
|
14
|
-
### Fact Table
|
|
15
|
-
-
|
|
16
|
-
- `
|
|
17
|
-
- `
|
|
18
|
-
- `
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
- `type0`: Fixed dimensions (no changes allowed).
|
|
22
|
-
- `type1`: Overwrite changes (no history maintained).
|
|
23
|
-
- `type2`: Add new row for changes (full history with timestamps).
|
|
24
|
-
- `type3`: Add new column for changes (partial history).
|
|
25
|
-
- `
|
|
14
|
+
### Fact Table Types / Dimension History (`appearance.sub_type`)
|
|
15
|
+
- **For Fact Tables**:
|
|
16
|
+
- `transaction`: Standard fact table where one row = one event (e.g., an order).
|
|
17
|
+
- `periodic`: Snapshot fact table capturing state at set intervals (e.g., monthly inventory).
|
|
18
|
+
- `accumulating`: Fact table updated as a process moves through milestones (e.g., order → shipping → delivery).
|
|
19
|
+
- `factless`: Tables that record the occurrence of an event without numeric measures (e.g., event attendance).
|
|
20
|
+
- **For Dimension Tables (SCD Types)**:
|
|
21
|
+
- `type0`: Fixed dimensions (no changes allowed).
|
|
22
|
+
- `type1`: Overwrite changes (no history maintained).
|
|
23
|
+
- `type2`: Add new row for changes (full history with timestamps).
|
|
24
|
+
- `type3`: Add new column for changes (partial history).
|
|
25
|
+
- `type4`: History table (separate table for history).
|
|
26
|
+
- `type5`: Hybrid (1 + 4).
|
|
27
|
+
- `type6`: Hybrid (1 + 2 + 3).
|
|
28
|
+
- `type7`: Hybrid (1 + 2).
|
|
26
29
|
|
|
27
30
|
### Column Additivity (`logical.additivity`)
|
|
28
31
|
- `fully`: Can be summed across all dimensions (e.g., sales amount). Displays as `Σ`.
|
|
@@ -49,7 +52,7 @@ tables:
|
|
|
49
52
|
name: Orders Fact
|
|
50
53
|
appearance:
|
|
51
54
|
type: fact
|
|
52
|
-
|
|
55
|
+
sub_type: transaction # transaction | periodic | accumulating | factless
|
|
53
56
|
conceptual:
|
|
54
57
|
description: "Records of customer purchases"
|
|
55
58
|
tags: ["WHO", "WHEN", "HOW MUCH"]
|
|
@@ -65,7 +68,7 @@ tables:
|
|
|
65
68
|
name: Customers Dim
|
|
66
69
|
appearance:
|
|
67
70
|
type: dimension
|
|
68
|
-
|
|
71
|
+
sub_type: type2 # type0 | type1 | type2 | type3 | type6
|
|
69
72
|
columns:
|
|
70
73
|
- id: customer_id
|
|
71
74
|
logical: { name: ID, type: Int, isPrimaryKey: true }
|
|
@@ -79,5 +82,5 @@ tables:
|
|
|
79
82
|
|
|
80
83
|
## 7. The Golden Rules
|
|
81
84
|
- When updating `model.yaml`, always self-audit against these rules.
|
|
82
|
-
- Set appropriate `appearance.type` and `
|
|
85
|
+
- Set appropriate `appearance.type` and `sub_type` for new tables.
|
|
83
86
|
- Use `additivity` for numeric measures to inform BI tools and analysts.
|