Skip to content

docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing#13687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zhuangjianguo merged 1 commit into from
Aug 31, 2026
+11 −14
Merged

docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing #13687

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions skills/objectstack-data/rules/field-types.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
Quick reference for choosing the right field type from 49 available options.

> **Config columns list only real `FieldSchema` keys.** Per-type display knobs
> beyond these do **not** exist — an unknown field key is silently stripped at
> parse (dead metadata), so don't invent config like `theme`, `rows`, or
> beyond these do **not** exist — an unknown field key is REFUSED at parse
> (`unrecognized_keys`), so don't invent `theme`, `rows`, or
> `fileAttachmentConfig`. Source of truth:
> `node_modules/@objectstack/spec/src/data/field.zod.ts`.

Expand DownExpand Up@@ -343,7 +343,7 @@ The `format` is literal text interleaved with `{...}` tokens:
1. **Every `{field}` you interpolate must be `required: true`** and set before the record is created. An empty interpolated field makes the record number generation *throw* (the compile lint flags a non-existent field as an error, an optional one as a warning).
2. **Put a delimiter between adjacent variable tokens** — `{section}-{zone}{000}`, not `{section}{zone}{000}`. Without one, `('AB','C')` and `('A','BC')` both render prefix `ABC` and share a counter (to keep numbers unique). The literal separator keeps distinct groups apart.
3. **Pad width is a MINIMUM, not a cap.** `{000}` → `001`…`999`, then `1000` (it grows, never wraps). Size it for readability, not as a ceiling.
4. **Only known tokens are interpolated.** Date tokens are **case-sensitive and exact** (`{YYYY}`, not `{yyyy}` or `{YYYY-MM}`). An unrecognized `{...}` is emitted **literally** into the number — `{ YYYY }` (spaces) renders the text `{ YYYY }`.
4. **Only known tokens are interpolated.** Date tokens are **case-sensitive** — `{yyyy}` parses as a `{field}` reference and renders **empty** (rule 1 applies). Only a spelling no field could have — `{ YYYY }`, `{YYYY-MM}` — is emitted **literally**.

### Vector (AI Embeddings)

Expand All@@ -354,8 +354,8 @@ The `format` is literal text interleaved with `{...}` tokens:
}
```

There is **no** `vectorConfig` block — an authored `vectorConfig` is silently
stripped (dead metadata). `dimensions` is the flat field-level key.
There is **no** `vectorConfig` block — an authored `vectorConfig` is refused at
parse. `dimensions` is the flat field-level key.

## Incorrect vs Correct

Expand Down
7 changes: 3 additions & 4 deletions skills/objectstack-data/rules/indexing.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,7 @@ Guide for creating efficient database indexes in ObjectStack.

ObjectStack automatically creates indexes for:
- Primary keys (`id`)
- Foreign keys (lookup/master_detail fields)
- Unique constraints
- Field-level `unique` — **not** foreign keys: declare those

**Only declare non-default values.** `unique` defaults to `false` — omit it when using the default.

Expand DownExpand Up@@ -83,7 +82,7 @@ Notes an author has to know:

### ✅ Always Index

1. **Foreign keys** — Automatic, but verify
1. **Foreign keys** — declare them; never automatic
2. **Filter fields** — Columns used in WHERE clauses
3. **Sort fields** — Columns used in ORDER BY
4. **Unique constraints** — Enforce uniqueness at DB level
Expand DownExpand Up@@ -328,7 +327,7 @@ SHOW INDEX FROM your_table;

## Best Practices

1. **Index foreign keys** — Always (automatic in ObjectStack)
1. **Index foreign keys** — always; declare each one
2. **Composite for common queries** — Combine frequently filtered columns
3. **Order matters** — Most selective field first
4. **Partial for subsets** — but build it in a migration, not a declaration
Expand Down
8 changes: 3 additions & 5 deletions skills/objectstack-data/rules/relationships.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,23 +6,21 @@ Guide for modeling relationships between objects using `lookup`, `master_detail`

| Type | Lifecycle | Required | Sharing | Roll-ups | Use Case |
|:-----|:----------|:---------|:--------|:---------|:---------|
| `lookup` | Independent | Optional by default | Independent | Not available | "Related to" |
| `master_detail` | Coupled (cascade delete) | Always required | Inherits parent | Supported via `summary` | "Owned by" |
| `lookup` | Independent | Optional by default | Independent | Supported via `summary` | "Related to" |
| `master_detail` | Coupled (cascade delete) | Forced only under `controlled_by_parent`; else lint-warned | Inherits parent | Supported via `summary` | "Owned by" |
| `tree` | Self-reference | Optional | N/A | Not available | Hierarchical |

## When to Use lookup vs master_detail

### Use `lookup` When:
- Child record can exist independently
- Parent deletion should not affect child (`deleteBehavior: 'set_null'`)
- No roll-up aggregations needed
- Parent deletion should only clear the FK (`deleteBehavior: 'set_null'`, the default)
- Relationship is optional
- **Example:** `task.assigned_to → user` (task can exist without assignment)

### Use `master_detail` When:
- Child record is meaningless without parent
- Parent deletion should cascade to children
- Need roll-up summaries (count, sum, min, max, avg)
- Relationship is mandatory
- **Example:** `invoice_line_item.invoice_id → invoice` (line items belong to invoice)

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing by zhuangjianguo · Pull Request #13687 · objectstack-ai/objectstack · GitHub
Skip to content
docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing#13687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

zhuangjianguo
merged 1 commit into

from

Aug 31, 2026

+11

−14

 Merged


docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing
#13687
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 5 additions & 5 deletions
skills/objectstack-data/rules/field-types.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
Quick reference for choosing the right field type from 49 available options.

> **Config columns list only real `FieldSchema` keys.** Per-type display knobs
> beyond these do **not** exist — an unknown field key is silently stripped at
> parse (dead metadata), so don't invent config like `theme`, `rows`, or
> beyond these do **not** exist — an unknown field key is REFUSED at parse
> (`unrecognized_keys`), so don't invent `theme`, `rows`, or
> `fileAttachmentConfig`. Source of truth:
> `node_modules/@objectstack/spec/src/data/field.zod.ts`.

Expand DownExpand Up@@ -343,7 +343,7 @@ The `format` is literal text interleaved with `{...}` tokens:
1. **Every `{field}` you interpolate must be `required: true`** and set before the record is created. An empty interpolated field makes the record number generation *throw* (the compile lint flags a non-existent field as an error, an optional one as a warning).
2. **Put a delimiter between adjacent variable tokens** — `{section}-{zone}{000}`, not `{section}{zone}{000}`. Without one, `('AB','C')` and `('A','BC')` both render prefix `ABC` and share a counter (to keep numbers unique). The literal separator keeps distinct groups apart.
3. **Pad width is a MINIMUM, not a cap.** `{000}` → `001`…`999`, then `1000` (it grows, never wraps). Size it for readability, not as a ceiling.
4. **Only known tokens are interpolated.** Date tokens are **case-sensitive and exact** (`{YYYY}`, not `{yyyy}` or `{YYYY-MM}`). An unrecognized `{...}` is emitted **literally** into the number — `{ YYYY }` (spaces) renders the text `{ YYYY }`.
4. **Only known tokens are interpolated.** Date tokens are **case-sensitive** — `{yyyy}` parses as a `{field}` reference and renders **empty** (rule 1 applies). Only a spelling no field could have — `{ YYYY }`, `{YYYY-MM}` — is emitted **literally**.

### Vector (AI Embeddings)

Expand All@@ -354,8 +354,8 @@ The `format` is literal text interleaved with `{...}` tokens:
}
```

There is **no** `vectorConfig` block — an authored `vectorConfig` is silently
stripped (dead metadata). `dimensions` is the flat field-level key.
There is **no** `vectorConfig` block — an authored `vectorConfig` is refused at
parse. `dimensions` is the flat field-level key.

## Incorrect vs Correct

Expand Down

7 changes: 3 additions & 4 deletions
skills/objectstack-data/rules/indexing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,7 @@ Guide for creating efficient database indexes in ObjectStack.

ObjectStack automatically creates indexes for:
- Primary keys (`id`)
- Foreign keys (lookup/master_detail fields)
- Unique constraints
- Field-level `unique` — **not** foreign keys: declare those

**Only declare non-default values.** `unique` defaults to `false` — omit it when using the default.

Expand DownExpand Up@@ -83,7 +82,7 @@ Notes an author has to know:

### ✅ Always Index

1. **Foreign keys** — Automatic, but verify
1. **Foreign keys** — declare them; never automatic
2. **Filter fields** — Columns used in WHERE clauses
3. **Sort fields** — Columns used in ORDER BY
4. **Unique constraints** — Enforce uniqueness at DB level
Expand DownExpand Up@@ -328,7 +327,7 @@ SHOW INDEX FROM your_table;

## Best Practices

1. **Index foreign keys** — Always (automatic in ObjectStack)
1. **Index foreign keys** — always; declare each one
2. **Composite for common queries** — Combine frequently filtered columns
3. **Order matters** — Most selective field first
4. **Partial for subsets** — but build it in a migration, not a declaration
Expand Down

8 changes: 3 additions & 5 deletions
skills/objectstack-data/rules/relationships.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,23 +6,21 @@ Guide for modeling relationships between objects using `lookup`, `master_detail`

| Type | Lifecycle | Required | Sharing | Roll-ups | Use Case |
|:-----|:----------|:---------|:--------|:---------|:---------|
| `lookup` | Independent | Optional by default | Independent | Not available | "Related to" |
| `master_detail` | Coupled (cascade delete) | Always required | Inherits parent | Supported via `summary` | "Owned by" |
| `lookup` | Independent | Optional by default | Independent | Supported via `summary` | "Related to" |
| `master_detail` | Coupled (cascade delete) | Forced only under `controlled_by_parent`; else lint-warned | Inherits parent | Supported via `summary` | "Owned by" |
| `tree` | Self-reference | Optional | N/A | Not available | Hierarchical |

## When to Use lookup vs master_detail

### Use `lookup` When:
- Child record can exist independently
- Parent deletion should not affect child (`deleteBehavior: 'set_null'`)
- No roll-up aggregations needed
- Parent deletion should only clear the FK (`deleteBehavior: 'set_null'`, the default)
- Relationship is optional
- **Example:** `task.assigned_to → user` (task can exist without assignment)

### Use `master_detail` When:
- Child record is meaningless without parent
- Parent deletion should cascade to children
- Need roll-up summaries (count, sum, min, max, avg)
- Relationship is mandatory
- **Example:** `invoice_line_item.invoice_id → invoice` (line items belong to invoice)

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing by zhuangjianguo · Pull Request #13687 · objectstack-ai/objectstack · GitHub
Skip to content
docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing#13687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

zhuangjianguo
merged 1 commit into

from

Aug 31, 2026

+11

−14

 Merged


docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing
#13687
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 5 additions & 5 deletions
skills/objectstack-data/rules/field-types.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
Quick reference for choosing the right field type from 49 available options.

> **Config columns list only real `FieldSchema` keys.** Per-type display knobs
> beyond these do **not** exist — an unknown field key is silently stripped at
> parse (dead metadata), so don't invent config like `theme`, `rows`, or
> beyond these do **not** exist — an unknown field key is REFUSED at parse
> (`unrecognized_keys`), so don't invent `theme`, `rows`, or
> `fileAttachmentConfig`. Source of truth:
> `node_modules/@objectstack/spec/src/data/field.zod.ts`.

Expand DownExpand Up@@ -343,7 +343,7 @@ The `format` is literal text interleaved with `{...}` tokens:
1. **Every `{field}` you interpolate must be `required: true`** and set before the record is created. An empty interpolated field makes the record number generation *throw* (the compile lint flags a non-existent field as an error, an optional one as a warning).
2. **Put a delimiter between adjacent variable tokens** — `{section}-{zone}{000}`, not `{section}{zone}{000}`. Without one, `('AB','C')` and `('A','BC')` both render prefix `ABC` and share a counter (to keep numbers unique). The literal separator keeps distinct groups apart.
3. **Pad width is a MINIMUM, not a cap.** `{000}` → `001`…`999`, then `1000` (it grows, never wraps). Size it for readability, not as a ceiling.
4. **Only known tokens are interpolated.** Date tokens are **case-sensitive and exact** (`{YYYY}`, not `{yyyy}` or `{YYYY-MM}`). An unrecognized `{...}` is emitted **literally** into the number — `{ YYYY }` (spaces) renders the text `{ YYYY }`.
4. **Only known tokens are interpolated.** Date tokens are **case-sensitive** — `{yyyy}` parses as a `{field}` reference and renders **empty** (rule 1 applies). Only a spelling no field could have — `{ YYYY }`, `{YYYY-MM}` — is emitted **literally**.

### Vector (AI Embeddings)

Expand All@@ -354,8 +354,8 @@ The `format` is literal text interleaved with `{...}` tokens:
}
```

There is **no** `vectorConfig` block — an authored `vectorConfig` is silently
stripped (dead metadata). `dimensions` is the flat field-level key.
There is **no** `vectorConfig` block — an authored `vectorConfig` is refused at
parse. `dimensions` is the flat field-level key.

## Incorrect vs Correct

Expand Down

7 changes: 3 additions & 4 deletions
skills/objectstack-data/rules/indexing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,7 @@ Guide for creating efficient database indexes in ObjectStack.

ObjectStack automatically creates indexes for:
- Primary keys (`id`)
- Foreign keys (lookup/master_detail fields)
- Unique constraints
- Field-level `unique` — **not** foreign keys: declare those

**Only declare non-default values.** `unique` defaults to `false` — omit it when using the default.

Expand DownExpand Up@@ -83,7 +82,7 @@ Notes an author has to know:

### ✅ Always Index

1. **Foreign keys** — Automatic, but verify
1. **Foreign keys** — declare them; never automatic
2. **Filter fields** — Columns used in WHERE clauses
3. **Sort fields** — Columns used in ORDER BY
4. **Unique constraints** — Enforce uniqueness at DB level
Expand DownExpand Up@@ -328,7 +327,7 @@ SHOW INDEX FROM your_table;

## Best Practices

1. **Index foreign keys** — Always (automatic in ObjectStack)
1. **Index foreign keys** — always; declare each one
2. **Composite for common queries** — Combine frequently filtered columns
3. **Order matters** — Most selective field first
4. **Partial for subsets** — but build it in a migration, not a declaration
Expand Down

8 changes: 3 additions & 5 deletions
skills/objectstack-data/rules/relationships.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,23 +6,21 @@ Guide for modeling relationships between objects using `lookup`, `master_detail`

| Type | Lifecycle | Required | Sharing | Roll-ups | Use Case |
|:-----|:----------|:---------|:--------|:---------|:---------|
| `lookup` | Independent | Optional by default | Independent | Not available | "Related to" |
| `master_detail` | Coupled (cascade delete) | Always required | Inherits parent | Supported via `summary` | "Owned by" |
| `lookup` | Independent | Optional by default | Independent | Supported via `summary` | "Related to" |
| `master_detail` | Coupled (cascade delete) | Forced only under `controlled_by_parent`; else lint-warned | Inherits parent | Supported via `summary` | "Owned by" |
| `tree` | Self-reference | Optional | N/A | Not available | Hierarchical |

## When to Use lookup vs master_detail

### Use `lookup` When:
- Child record can exist independently
- Parent deletion should not affect child (`deleteBehavior: 'set_null'`)
- No roll-up aggregations needed
- Parent deletion should only clear the FK (`deleteBehavior: 'set_null'`, the default)
- Relationship is optional
- **Example:** `task.assigned_to → user` (task can exist without assignment)

### Use `master_detail` When:
- Child record is meaningless without parent
- Parent deletion should cascade to children
- Need roll-up summaries (count, sum, min, max, avg)
- Relationship is mandatory
- **Example:** `invoice_line_item.invoice_id → invoice` (line items belong to invoice)

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing by zhuangjianguo · Pull Request #13687 · objectstack-ai/objectstack · GitHub
Skip to content
docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing#13687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

zhuangjianguo
merged 1 commit into

from

Aug 31, 2026

+11

−14

 Merged


docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing
#13687
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 5 additions & 5 deletions
skills/objectstack-data/rules/field-types.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
Quick reference for choosing the right field type from 49 available options.

> **Config columns list only real `FieldSchema` keys.** Per-type display knobs
> beyond these do **not** exist — an unknown field key is silently stripped at
> parse (dead metadata), so don't invent config like `theme`, `rows`, or
> beyond these do **not** exist — an unknown field key is REFUSED at parse
> (`unrecognized_keys`), so don't invent `theme`, `rows`, or
> `fileAttachmentConfig`. Source of truth:
> `node_modules/@objectstack/spec/src/data/field.zod.ts`.

Expand DownExpand Up@@ -343,7 +343,7 @@ The `format` is literal text interleaved with `{...}` tokens:
1. **Every `{field}` you interpolate must be `required: true`** and set before the record is created. An empty interpolated field makes the record number generation *throw* (the compile lint flags a non-existent field as an error, an optional one as a warning).
2. **Put a delimiter between adjacent variable tokens** — `{section}-{zone}{000}`, not `{section}{zone}{000}`. Without one, `('AB','C')` and `('A','BC')` both render prefix `ABC` and share a counter (to keep numbers unique). The literal separator keeps distinct groups apart.
3. **Pad width is a MINIMUM, not a cap.** `{000}` → `001`…`999`, then `1000` (it grows, never wraps). Size it for readability, not as a ceiling.
4. **Only known tokens are interpolated.** Date tokens are **case-sensitive and exact** (`{YYYY}`, not `{yyyy}` or `{YYYY-MM}`). An unrecognized `{...}` is emitted **literally** into the number — `{ YYYY }` (spaces) renders the text `{ YYYY }`.
4. **Only known tokens are interpolated.** Date tokens are **case-sensitive** — `{yyyy}` parses as a `{field}` reference and renders **empty** (rule 1 applies). Only a spelling no field could have — `{ YYYY }`, `{YYYY-MM}` — is emitted **literally**.

### Vector (AI Embeddings)

Expand All@@ -354,8 +354,8 @@ The `format` is literal text interleaved with `{...}` tokens:
}
```

There is **no** `vectorConfig` block — an authored `vectorConfig` is silently
stripped (dead metadata). `dimensions` is the flat field-level key.
There is **no** `vectorConfig` block — an authored `vectorConfig` is refused at
parse. `dimensions` is the flat field-level key.

## Incorrect vs Correct

Expand Down

7 changes: 3 additions & 4 deletions
skills/objectstack-data/rules/indexing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,7 @@ Guide for creating efficient database indexes in ObjectStack.

ObjectStack automatically creates indexes for:
- Primary keys (`id`)
- Foreign keys (lookup/master_detail fields)
- Unique constraints
- Field-level `unique` — **not** foreign keys: declare those

**Only declare non-default values.** `unique` defaults to `false` — omit it when using the default.

Expand DownExpand Up@@ -83,7 +82,7 @@ Notes an author has to know:

### ✅ Always Index

1. **Foreign keys** — Automatic, but verify
1. **Foreign keys** — declare them; never automatic
2. **Filter fields** — Columns used in WHERE clauses
3. **Sort fields** — Columns used in ORDER BY
4. **Unique constraints** — Enforce uniqueness at DB level
Expand DownExpand Up@@ -328,7 +327,7 @@ SHOW INDEX FROM your_table;

## Best Practices

1. **Index foreign keys** — Always (automatic in ObjectStack)
1. **Index foreign keys** — always; declare each one
2. **Composite for common queries** — Combine frequently filtered columns
3. **Order matters** — Most selective field first
4. **Partial for subsets** — but build it in a migration, not a declaration
Expand Down

8 changes: 3 additions & 5 deletions
skills/objectstack-data/rules/relationships.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,23 +6,21 @@ Guide for modeling relationships between objects using `lookup`, `master_detail`

| Type | Lifecycle | Required | Sharing | Roll-ups | Use Case |
|:-----|:----------|:---------|:--------|:---------|:---------|
| `lookup` | Independent | Optional by default | Independent | Not available | "Related to" |
| `master_detail` | Coupled (cascade delete) | Always required | Inherits parent | Supported via `summary` | "Owned by" |
| `lookup` | Independent | Optional by default | Independent | Supported via `summary` | "Related to" |
| `master_detail` | Coupled (cascade delete) | Forced only under `controlled_by_parent`; else lint-warned | Inherits parent | Supported via `summary` | "Owned by" |
| `tree` | Self-reference | Optional | N/A | Not available | Hierarchical |

## When to Use lookup vs master_detail

### Use `lookup` When:
- Child record can exist independently
- Parent deletion should not affect child (`deleteBehavior: 'set_null'`)
- No roll-up aggregations needed
- Parent deletion should only clear the FK (`deleteBehavior: 'set_null'`, the default)
- Relationship is optional
- **Example:** `task.assigned_to → user` (task can exist without assignment)

### Use `master_detail` When:
- Child record is meaningless without parent
- Parent deletion should cascade to children
- Need roll-up summaries (count, sum, min, max, avg)
- Relationship is mandatory
- **Example:** `invoice_line_item.invoice_id → invoice` (line items belong to invoice)

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing by zhuangjianguo · Pull Request #13687 · objectstack-ai/objectstack · GitHub
Skip to content
docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing#13687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

zhuangjianguo
merged 1 commit into

from

Aug 31, 2026

+11

−14

 Merged


docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing
#13687
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 5 additions & 5 deletions
skills/objectstack-data/rules/field-types.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
Quick reference for choosing the right field type from 49 available options.

> **Config columns list only real `FieldSchema` keys.** Per-type display knobs
> beyond these do **not** exist — an unknown field key is silently stripped at
> parse (dead metadata), so don't invent config like `theme`, `rows`, or
> beyond these do **not** exist — an unknown field key is REFUSED at parse
> (`unrecognized_keys`), so don't invent `theme`, `rows`, or
> `fileAttachmentConfig`. Source of truth:
> `node_modules/@objectstack/spec/src/data/field.zod.ts`.

Expand DownExpand Up@@ -343,7 +343,7 @@ The `format` is literal text interleaved with `{...}` tokens:
1. **Every `{field}` you interpolate must be `required: true`** and set before the record is created. An empty interpolated field makes the record number generation *throw* (the compile lint flags a non-existent field as an error, an optional one as a warning).
2. **Put a delimiter between adjacent variable tokens** — `{section}-{zone}{000}`, not `{section}{zone}{000}`. Without one, `('AB','C')` and `('A','BC')` both render prefix `ABC` and share a counter (to keep numbers unique). The literal separator keeps distinct groups apart.
3. **Pad width is a MINIMUM, not a cap.** `{000}` → `001`…`999`, then `1000` (it grows, never wraps). Size it for readability, not as a ceiling.
4. **Only known tokens are interpolated.** Date tokens are **case-sensitive and exact** (`{YYYY}`, not `{yyyy}` or `{YYYY-MM}`). An unrecognized `{...}` is emitted **literally** into the number — `{ YYYY }` (spaces) renders the text `{ YYYY }`.
4. **Only known tokens are interpolated.** Date tokens are **case-sensitive** — `{yyyy}` parses as a `{field}` reference and renders **empty** (rule 1 applies). Only a spelling no field could have — `{ YYYY }`, `{YYYY-MM}` — is emitted **literally**.

### Vector (AI Embeddings)

Expand All@@ -354,8 +354,8 @@ The `format` is literal text interleaved with `{...}` tokens:
}
```

There is **no** `vectorConfig` block — an authored `vectorConfig` is silently
stripped (dead metadata). `dimensions` is the flat field-level key.
There is **no** `vectorConfig` block — an authored `vectorConfig` is refused at
parse. `dimensions` is the flat field-level key.

## Incorrect vs Correct

Expand Down

7 changes: 3 additions & 4 deletions
skills/objectstack-data/rules/indexing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,7 @@ Guide for creating efficient database indexes in ObjectStack.

ObjectStack automatically creates indexes for:
- Primary keys (`id`)
- Foreign keys (lookup/master_detail fields)
- Unique constraints
- Field-level `unique` — **not** foreign keys: declare those

**Only declare non-default values.** `unique` defaults to `false` — omit it when using the default.

Expand DownExpand Up@@ -83,7 +82,7 @@ Notes an author has to know:

### ✅ Always Index

1. **Foreign keys** — Automatic, but verify
1. **Foreign keys** — declare them; never automatic
2. **Filter fields** — Columns used in WHERE clauses
3. **Sort fields** — Columns used in ORDER BY
4. **Unique constraints** — Enforce uniqueness at DB level
Expand DownExpand Up@@ -328,7 +327,7 @@ SHOW INDEX FROM your_table;

## Best Practices

1. **Index foreign keys** — Always (automatic in ObjectStack)
1. **Index foreign keys** — always; declare each one
2. **Composite for common queries** — Combine frequently filtered columns
3. **Order matters** — Most selective field first
4. **Partial for subsets** — but build it in a migration, not a declaration
Expand Down

8 changes: 3 additions & 5 deletions
skills/objectstack-data/rules/relationships.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,23 +6,21 @@ Guide for modeling relationships between objects using `lookup`, `master_detail`

| Type | Lifecycle | Required | Sharing | Roll-ups | Use Case |
|:-----|:----------|:---------|:--------|:---------|:---------|
| `lookup` | Independent | Optional by default | Independent | Not available | "Related to" |
| `master_detail` | Coupled (cascade delete) | Always required | Inherits parent | Supported via `summary` | "Owned by" |
| `lookup` | Independent | Optional by default | Independent | Supported via `summary` | "Related to" |
| `master_detail` | Coupled (cascade delete) | Forced only under `controlled_by_parent`; else lint-warned | Inherits parent | Supported via `summary` | "Owned by" |
| `tree` | Self-reference | Optional | N/A | Not available | Hierarchical |

## When to Use lookup vs master_detail

### Use `lookup` When:
- Child record can exist independently
- Parent deletion should not affect child (`deleteBehavior: 'set_null'`)
- No roll-up aggregations needed
- Parent deletion should only clear the FK (`deleteBehavior: 'set_null'`, the default)
- Relationship is optional
- **Example:** `task.assigned_to → user` (task can exist without assignment)

### Use `master_detail` When:
- Child record is meaningless without parent
- Parent deletion should cascade to children
- Need roll-up summaries (count, sum, min, max, avg)
- Relationship is mandatory
- **Example:** `invoice_line_item.invoice_id → invoice` (line items belong to invoice)

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing by zhuangjianguo · Pull Request #13687 · objectstack-ai/objectstack · GitHub
Skip to content
docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing#13687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

zhuangjianguo
merged 1 commit into

from

Aug 31, 2026

+11

−14

 Merged


docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing
#13687
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 5 additions & 5 deletions
skills/objectstack-data/rules/field-types.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
Quick reference for choosing the right field type from 49 available options.

> **Config columns list only real `FieldSchema` keys.** Per-type display knobs
> beyond these do **not** exist — an unknown field key is silently stripped at
> parse (dead metadata), so don't invent config like `theme`, `rows`, or
> beyond these do **not** exist — an unknown field key is REFUSED at parse
> (`unrecognized_keys`), so don't invent `theme`, `rows`, or
> `fileAttachmentConfig`. Source of truth:
> `node_modules/@objectstack/spec/src/data/field.zod.ts`.

Expand DownExpand Up@@ -343,7 +343,7 @@ The `format` is literal text interleaved with `{...}` tokens:
1. **Every `{field}` you interpolate must be `required: true`** and set before the record is created. An empty interpolated field makes the record number generation *throw* (the compile lint flags a non-existent field as an error, an optional one as a warning).
2. **Put a delimiter between adjacent variable tokens** — `{section}-{zone}{000}`, not `{section}{zone}{000}`. Without one, `('AB','C')` and `('A','BC')` both render prefix `ABC` and share a counter (to keep numbers unique). The literal separator keeps distinct groups apart.
3. **Pad width is a MINIMUM, not a cap.** `{000}` → `001`…`999`, then `1000` (it grows, never wraps). Size it for readability, not as a ceiling.
4. **Only known tokens are interpolated.** Date tokens are **case-sensitive and exact** (`{YYYY}`, not `{yyyy}` or `{YYYY-MM}`). An unrecognized `{...}` is emitted **literally** into the number — `{ YYYY }` (spaces) renders the text `{ YYYY }`.
4. **Only known tokens are interpolated.** Date tokens are **case-sensitive** — `{yyyy}` parses as a `{field}` reference and renders **empty** (rule 1 applies). Only a spelling no field could have — `{ YYYY }`, `{YYYY-MM}` — is emitted **literally**.

### Vector (AI Embeddings)

Expand All@@ -354,8 +354,8 @@ The `format` is literal text interleaved with `{...}` tokens:
}
```

There is **no** `vectorConfig` block — an authored `vectorConfig` is silently
stripped (dead metadata). `dimensions` is the flat field-level key.
There is **no** `vectorConfig` block — an authored `vectorConfig` is refused at
parse. `dimensions` is the flat field-level key.

## Incorrect vs Correct

Expand Down

7 changes: 3 additions & 4 deletions
skills/objectstack-data/rules/indexing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,7 @@ Guide for creating efficient database indexes in ObjectStack.

ObjectStack automatically creates indexes for:
- Primary keys (`id`)
- Foreign keys (lookup/master_detail fields)
- Unique constraints
- Field-level `unique` — **not** foreign keys: declare those

**Only declare non-default values.** `unique` defaults to `false` — omit it when using the default.

Expand DownExpand Up@@ -83,7 +82,7 @@ Notes an author has to know:

### ✅ Always Index

1. **Foreign keys** — Automatic, but verify
1. **Foreign keys** — declare them; never automatic
2. **Filter fields** — Columns used in WHERE clauses
3. **Sort fields** — Columns used in ORDER BY
4. **Unique constraints** — Enforce uniqueness at DB level
Expand DownExpand Up@@ -328,7 +327,7 @@ SHOW INDEX FROM your_table;

## Best Practices

1. **Index foreign keys** — Always (automatic in ObjectStack)
1. **Index foreign keys** — always; declare each one
2. **Composite for common queries** — Combine frequently filtered columns
3. **Order matters** — Most selective field first
4. **Partial for subsets** — but build it in a migration, not a declaration
Expand Down

8 changes: 3 additions & 5 deletions
skills/objectstack-data/rules/relationships.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,23 +6,21 @@ Guide for modeling relationships between objects using `lookup`, `master_detail`

| Type | Lifecycle | Required | Sharing | Roll-ups | Use Case |
|:-----|:----------|:---------|:--------|:---------|:---------|
| `lookup` | Independent | Optional by default | Independent | Not available | "Related to" |
| `master_detail` | Coupled (cascade delete) | Always required | Inherits parent | Supported via `summary` | "Owned by" |
| `lookup` | Independent | Optional by default | Independent | Supported via `summary` | "Related to" |
| `master_detail` | Coupled (cascade delete) | Forced only under `controlled_by_parent`; else lint-warned | Inherits parent | Supported via `summary` | "Owned by" |
| `tree` | Self-reference | Optional | N/A | Not available | Hierarchical |

## When to Use lookup vs master_detail

### Use `lookup` When:
- Child record can exist independently
- Parent deletion should not affect child (`deleteBehavior: 'set_null'`)
- No roll-up aggregations needed
- Parent deletion should only clear the FK (`deleteBehavior: 'set_null'`, the default)
- Relationship is optional
- **Example:** `task.assigned_to → user` (task can exist without assignment)

### Use `master_detail` When:
- Child record is meaningless without parent
- Parent deletion should cascade to children
- Need roll-up summaries (count, sum, min, max, avg)
- Relationship is mandatory
- **Example:** `invoice_line_item.invoice_id → invoice` (line items belong to invoice)

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing by zhuangjianguo · Pull Request #13687 · objectstack-ai/objectstack · GitHub
Skip to content
docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing#13687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

zhuangjianguo
merged 1 commit into

from

Aug 31, 2026

+11

−14

 Merged


docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing
#13687
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 5 additions & 5 deletions
skills/objectstack-data/rules/field-types.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
Quick reference for choosing the right field type from 49 available options.

> **Config columns list only real `FieldSchema` keys.** Per-type display knobs
> beyond these do **not** exist — an unknown field key is silently stripped at
> parse (dead metadata), so don't invent config like `theme`, `rows`, or
> beyond these do **not** exist — an unknown field key is REFUSED at parse
> (`unrecognized_keys`), so don't invent `theme`, `rows`, or
> `fileAttachmentConfig`. Source of truth:
> `node_modules/@objectstack/spec/src/data/field.zod.ts`.

Expand DownExpand Up@@ -343,7 +343,7 @@ The `format` is literal text interleaved with `{...}` tokens:
1. **Every `{field}` you interpolate must be `required: true`** and set before the record is created. An empty interpolated field makes the record number generation *throw* (the compile lint flags a non-existent field as an error, an optional one as a warning).
2. **Put a delimiter between adjacent variable tokens** — `{section}-{zone}{000}`, not `{section}{zone}{000}`. Without one, `('AB','C')` and `('A','BC')` both render prefix `ABC` and share a counter (to keep numbers unique). The literal separator keeps distinct groups apart.
3. **Pad width is a MINIMUM, not a cap.** `{000}` → `001`…`999`, then `1000` (it grows, never wraps). Size it for readability, not as a ceiling.
4. **Only known tokens are interpolated.** Date tokens are **case-sensitive and exact** (`{YYYY}`, not `{yyyy}` or `{YYYY-MM}`). An unrecognized `{...}` is emitted **literally** into the number — `{ YYYY }` (spaces) renders the text `{ YYYY }`.
4. **Only known tokens are interpolated.** Date tokens are **case-sensitive** — `{yyyy}` parses as a `{field}` reference and renders **empty** (rule 1 applies). Only a spelling no field could have — `{ YYYY }`, `{YYYY-MM}` — is emitted **literally**.

### Vector (AI Embeddings)

Expand All@@ -354,8 +354,8 @@ The `format` is literal text interleaved with `{...}` tokens:
}
```

There is **no** `vectorConfig` block — an authored `vectorConfig` is silently
stripped (dead metadata). `dimensions` is the flat field-level key.
There is **no** `vectorConfig` block — an authored `vectorConfig` is refused at
parse. `dimensions` is the flat field-level key.

## Incorrect vs Correct

Expand Down

7 changes: 3 additions & 4 deletions
skills/objectstack-data/rules/indexing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,7 @@ Guide for creating efficient database indexes in ObjectStack.

ObjectStack automatically creates indexes for:
- Primary keys (`id`)
- Foreign keys (lookup/master_detail fields)
- Unique constraints
- Field-level `unique` — **not** foreign keys: declare those

**Only declare non-default values.** `unique` defaults to `false` — omit it when using the default.

Expand DownExpand Up@@ -83,7 +82,7 @@ Notes an author has to know:

### ✅ Always Index

1. **Foreign keys** — Automatic, but verify
1. **Foreign keys** — declare them; never automatic
2. **Filter fields** — Columns used in WHERE clauses
3. **Sort fields** — Columns used in ORDER BY
4. **Unique constraints** — Enforce uniqueness at DB level
Expand DownExpand Up@@ -328,7 +327,7 @@ SHOW INDEX FROM your_table;

## Best Practices

1. **Index foreign keys** — Always (automatic in ObjectStack)
1. **Index foreign keys** — always; declare each one
2. **Composite for common queries** — Combine frequently filtered columns
3. **Order matters** — Most selective field first
4. **Partial for subsets** — but build it in a migration, not a declaration
Expand Down

8 changes: 3 additions & 5 deletions
skills/objectstack-data/rules/relationships.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,23 +6,21 @@ Guide for modeling relationships between objects using `lookup`, `master_detail`

| Type | Lifecycle | Required | Sharing | Roll-ups | Use Case |
|:-----|:----------|:---------|:--------|:---------|:---------|
| `lookup` | Independent | Optional by default | Independent | Not available | "Related to" |
| `master_detail` | Coupled (cascade delete) | Always required | Inherits parent | Supported via `summary` | "Owned by" |
| `lookup` | Independent | Optional by default | Independent | Supported via `summary` | "Related to" |
| `master_detail` | Coupled (cascade delete) | Forced only under `controlled_by_parent`; else lint-warned | Inherits parent | Supported via `summary` | "Owned by" |
| `tree` | Self-reference | Optional | N/A | Not available | Hierarchical |

## When to Use lookup vs master_detail

### Use `lookup` When:
- Child record can exist independently
- Parent deletion should not affect child (`deleteBehavior: 'set_null'`)
- No roll-up aggregations needed
- Parent deletion should only clear the FK (`deleteBehavior: 'set_null'`, the default)
- Relationship is optional
- **Example:** `task.assigned_to → user` (task can exist without assignment)

### Use `master_detail` When:
- Child record is meaningless without parent
- Parent deletion should cascade to children
- Need roll-up summaries (count, sum, min, max, avg)
- Relationship is mandatory
- **Example:** `invoice_line_item.invoice_id → invoice` (line items belong to invoice)

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing by zhuangjianguo · Pull Request #13687 · objectstack-ai/objectstack · GitHub
Skip to content
docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing#13687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

zhuangjianguo
merged 1 commit into

from

Aug 31, 2026

+11

−14

 Merged


docs(skills): objectstack-data factual sweep (1/3) — field-types, relationships, indexing
#13687
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 5 additions & 5 deletions
skills/objectstack-data/rules/field-types.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
Quick reference for choosing the right field type from 49 available options.

> **Config columns list only real `FieldSchema` keys.** Per-type display knobs
> beyond these do **not** exist — an unknown field key is silently stripped at
> parse (dead metadata), so don't invent config like `theme`, `rows`, or
> beyond these do **not** exist — an unknown field key is REFUSED at parse
> (`unrecognized_keys`), so don't invent `theme`, `rows`, or
> `fileAttachmentConfig`. Source of truth:
> `node_modules/@objectstack/spec/src/data/field.zod.ts`.

Expand DownExpand Up@@ -343,7 +343,7 @@ The `format` is literal text interleaved with `{...}` tokens:
1. **Every `{field}` you interpolate must be `required: true`** and set before the record is created. An empty interpolated field makes the record number generation *throw* (the compile lint flags a non-existent field as an error, an optional one as a warning).
2. **Put a delimiter between adjacent variable tokens** — `{section}-{zone}{000}`, not `{section}{zone}{000}`. Without one, `('AB','C')` and `('A','BC')` both render prefix `ABC` and share a counter (to keep numbers unique). The literal separator keeps distinct groups apart.
3. **Pad width is a MINIMUM, not a cap.** `{000}` → `001`…`999`, then `1000` (it grows, never wraps). Size it for readability, not as a ceiling.
4. **Only known tokens are interpolated.** Date tokens are **case-sensitive and exact** (`{YYYY}`, not `{yyyy}` or `{YYYY-MM}`). An unrecognized `{...}` is emitted **literally** into the number — `{ YYYY }` (spaces) renders the text `{ YYYY }`.
4. **Only known tokens are interpolated.** Date tokens are **case-sensitive** — `{yyyy}` parses as a `{field}` reference and renders **empty** (rule 1 applies). Only a spelling no field could have — `{ YYYY }`, `{YYYY-MM}` — is emitted **literally**.

### Vector (AI Embeddings)

Expand All@@ -354,8 +354,8 @@ The `format` is literal text interleaved with `{...}` tokens:
}
```

There is **no** `vectorConfig` block — an authored `vectorConfig` is silently
stripped (dead metadata). `dimensions` is the flat field-level key.
There is **no** `vectorConfig` block — an authored `vectorConfig` is refused at
parse. `dimensions` is the flat field-level key.

## Incorrect vs Correct

Expand Down

7 changes: 3 additions & 4 deletions
skills/objectstack-data/rules/indexing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,8 +6,7 @@ Guide for creating efficient database indexes in ObjectStack.

ObjectStack automatically creates indexes for:
- Primary keys (`id`)
- Foreign keys (lookup/master_detail fields)
- Unique constraints
- Field-level `unique` — **not** foreign keys: declare those

**Only declare non-default values.** `unique` defaults to `false` — omit it when using the default.

Expand DownExpand Up@@ -83,7 +82,7 @@ Notes an author has to know:

### ✅ Always Index

1. **Foreign keys** — Automatic, but verify
1. **Foreign keys** — declare them; never automatic
2. **Filter fields** — Columns used in WHERE clauses
3. **Sort fields** — Columns used in ORDER BY
4. **Unique constraints** — Enforce uniqueness at DB level
Expand DownExpand Up@@ -328,7 +327,7 @@ SHOW INDEX FROM your_table;

## Best Practices

1. **Index foreign keys** — Always (automatic in ObjectStack)
1. **Index foreign keys** — always; declare each one
2. **Composite for common queries** — Combine frequently filtered columns
3. **Order matters** — Most selective field first
4. **Partial for subsets** — but build it in a migration, not a declaration
Expand Down

8 changes: 3 additions & 5 deletions
skills/objectstack-data/rules/relationships.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,23 +6,21 @@ Guide for modeling relationships between objects using `lookup`, `master_detail`

| Type | Lifecycle | Required | Sharing | Roll-ups | Use Case |
|:-----|:----------|:---------|:--------|:---------|:---------|
| `lookup` | Independent | Optional by default | Independent | Not available | "Related to" |
| `master_detail` | Coupled (cascade delete) | Always required | Inherits parent | Supported via `summary` | "Owned by" |
| `lookup` | Independent | Optional by default | Independent | Supported via `summary` | "Related to" |
| `master_detail` | Coupled (cascade delete) | Forced only under `controlled_by_parent`; else lint-warned | Inherits parent | Supported via `summary` | "Owned by" |
| `tree` | Self-reference | Optional | N/A | Not available | Hierarchical |

## When to Use lookup vs master_detail

### Use `lookup` When:
- Child record can exist independently
- Parent deletion should not affect child (`deleteBehavior: 'set_null'`)
- No roll-up aggregations needed
- Parent deletion should only clear the FK (`deleteBehavior: 'set_null'`, the default)
- Relationship is optional
- **Example:** `task.assigned_to → user` (task can exist without assignment)

### Use `master_detail` When:
- Child record is meaningless without parent
- Parent deletion should cascade to children
- Need roll-up summaries (count, sum, min, max, avg)
- Relationship is mandatory
- **Example:** `invoice_line_item.invoice_id → invoice` (line items belong to invoice)

Expand Down
Loading