air-dml 2.1.11 โ 2.1.13
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.md +19 -22
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
*The Open Standard for AI-Ready Data Modeling*
|
|
6
6
|
|
|
7
|
-
AIR-DML is
|
|
7
|
+
AIR-DML is a data modeling language designed for AI-driven development. It provides a structured, human- and machine-readable syntax for database schemas enriched with business context.
|
|
8
8
|
|
|
9
9
|
[](https://www.npmjs.com/package/air-dml)
|
|
10
10
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
@@ -21,7 +21,7 @@ Generate ER diagrams from natural language using AI. Mode-ai is the reference im
|
|
|
21
21
|
|
|
22
22
|
- Natural language to ER diagram generation
|
|
23
23
|
- Interactive visual editor with drag & drop
|
|
24
|
-
- Export to SQL,
|
|
24
|
+
- Export to SQL, AIR-DML, and more
|
|
25
25
|
|
|
26
26
|
<br clear="left"/>
|
|
27
27
|
|
|
@@ -32,7 +32,7 @@ Generate ER diagrams from natural language using AI. Mode-ai is the reference im
|
|
|
32
32
|
๐ **Multilingual**: Logical names (aliases) in any language
|
|
33
33
|
๐จ **Visual Design**: Coordinate and color information for diagram rendering
|
|
34
34
|
๐ **Polyglot Persistence**: Different database types per area
|
|
35
|
-
๐ฆ **
|
|
35
|
+
๐ฆ **Zero Dependencies**: Independent parser with no external dependencies
|
|
36
36
|
๐ฌ **Comment Preservation**: Leading comments are preserved and associated with elements
|
|
37
37
|
|
|
38
38
|
## Installation
|
|
@@ -103,7 +103,7 @@ console.log(output);
|
|
|
103
103
|
|
|
104
104
|
### Table Definition
|
|
105
105
|
|
|
106
|
-
```
|
|
106
|
+
```airdml
|
|
107
107
|
Table table_name [alias: "่ซ็ๅ", pos_x: 100, pos_y: 200, color: "#1976D2"] {
|
|
108
108
|
column_name data_type [constraints, alias: "ใซใฉใ ่ซ็ๅ"]
|
|
109
109
|
|
|
@@ -130,7 +130,7 @@ Table table_name [alias: "่ซ็ๅ", pos_x: 100, pos_y: 200, color: "#1976D2"]
|
|
|
130
130
|
|
|
131
131
|
Define allowed values for a column (status codes, flags, etc.):
|
|
132
132
|
|
|
133
|
-
```
|
|
133
|
+
```airdml
|
|
134
134
|
status varchar(1) [
|
|
135
135
|
not null,
|
|
136
136
|
alias: "ในใใผใฟใน",
|
|
@@ -143,7 +143,7 @@ Format: `"key=label/key2=label2/..."` โ key and label separated by `=`, entrie
|
|
|
143
143
|
|
|
144
144
|
### Relationships
|
|
145
145
|
|
|
146
|
-
```
|
|
146
|
+
```airdml
|
|
147
147
|
Ref: table_a.column > table_b.column // Many-to-One (A โ B)
|
|
148
148
|
Ref: table_a.column < table_b.column // One-to-Many (A โ B)
|
|
149
149
|
Ref: table_a.column - table_b.column // One-to-One
|
|
@@ -153,7 +153,7 @@ Ref: table_a.column ~ table_b.column // AI-inferred (undetermined)
|
|
|
153
153
|
|
|
154
154
|
### Area (Bounded Context)
|
|
155
155
|
|
|
156
|
-
```
|
|
156
|
+
```airdml
|
|
157
157
|
Area "Area Name" [
|
|
158
158
|
pos_x: 50,
|
|
159
159
|
pos_y: 50,
|
|
@@ -188,7 +188,7 @@ When using AI to generate AIR-DML, follow these rules:
|
|
|
188
188
|
|
|
189
189
|
**Example Output:**
|
|
190
190
|
|
|
191
|
-
```
|
|
191
|
+
```airdml
|
|
192
192
|
// ๅฎๆ่ณผๅ
ฅๆฉ่ฝ
|
|
193
193
|
Table subscriptions [alias: "ๅฎๆ่ณผๅ
ฅ"] {
|
|
194
194
|
id serial [pk, alias: "ๅฎๆ่ณผๅ
ฅID"]
|
|
@@ -317,17 +317,17 @@ interface Area {
|
|
|
317
317
|
}
|
|
318
318
|
```
|
|
319
319
|
|
|
320
|
-
##
|
|
320
|
+
## Key Features At a Glance
|
|
321
321
|
|
|
322
|
-
| Feature |
|
|
323
|
-
|
|
324
|
-
| **
|
|
325
|
-
| **
|
|
326
|
-
| **Area management** |
|
|
327
|
-
| **Visual
|
|
328
|
-
| **Multi-DB** |
|
|
329
|
-
| **AI
|
|
330
|
-
| **
|
|
322
|
+
| Feature | Description |
|
|
323
|
+
|---------|-------------|
|
|
324
|
+
| **Logical names** | `alias` attribute for human-readable names in any language |
|
|
325
|
+
| **Classification values** | `values` attribute for enums and status codes |
|
|
326
|
+
| **Area management** | Bounded context grouping with CommonColumns and per-area database type |
|
|
327
|
+
| **Visual layout** | Coordinates, colors, and sizes for diagram rendering |
|
|
328
|
+
| **Multi-DB** | Area-level database type (polyglot persistence) |
|
|
329
|
+
| **AI-optimized** | LLM-friendly syntax designed for generation and interpretation |
|
|
330
|
+
| **Zero dependencies** | Independent recursive descent parser |
|
|
331
331
|
|
|
332
332
|
## Changelog
|
|
333
333
|
|
|
@@ -383,13 +383,10 @@ For the complete AIR-DML specification, see [SPECIFICATION.md](./SPECIFICATION.m
|
|
|
383
383
|
|
|
384
384
|
Apache-2.0 License - see [LICENSE](./LICENSE) file for details.
|
|
385
385
|
|
|
386
|
-
AIR-DML extends [DBML](https://github.com/holistics/dbml) (also Apache-2.0).
|
|
387
|
-
|
|
388
386
|
## Credits
|
|
389
387
|
|
|
390
388
|
- **Created by**: Data-mination Partners
|
|
391
|
-
- **Technical collaboration**: Claude
|
|
392
|
-
- **Based on**: [@dbml/core](https://www.npmjs.com/package/@dbml/core) by Holistics
|
|
389
|
+
- **Technical collaboration**: Claude Sonnet 4.6 (Anthropic)
|
|
393
390
|
|
|
394
391
|
## Links
|
|
395
392
|
|