Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions src/how-to/define-tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ class MyTable(dj.Manual):

| Type | Base Class | Purpose |
|------|------------|---------|
| Manual | `dj.Manual` | Data entered at runtime (users, forms, instruments, imports) |
| Manual | `dj.Manual` | Data inserted directly from outside the pipeline (forms, instruments, ingestion scripts) |
| Lookup | `dj.Lookup` | Reference data defined in the schema via `contents` |
| Imported | `dj.Imported` | Data from external sources |
| Computed | `dj.Computed` | Derived data |
| Imported | `dj.Imported` | Populated by `make()` from an external source |
| Computed | `dj.Computed` | Populated by `make()` from other tables |
| Part | `dj.Part` | Child of master table |

## Primary Key (Above `---`)
Expand Down
4 changes: 2 additions & 2 deletions src/reference/specs/table-declaration.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ class TableName(dj.Manual):

| Tier | Base Class | Table Prefix | Purpose |
|------|------------|--------------|---------|
| Manual | `dj.Manual` | (none) | Data entered at runtime (users, instruments, imports) |
| Manual | `dj.Manual` | (none) | Data inserted directly from outside the pipeline (users, instruments, ingestion scripts) |
| Lookup | `dj.Lookup` | `#` | Reference data defined in the schema via `contents` |
| Imported | `dj.Imported` | `_` | Data from external sources |
| Imported | `dj.Imported` | `_` | Populated by `make()` from an external source |
| Computed | `dj.Computed` | `__` | Derived from other tables |
| Part | `dj.Part` | `master__` | Detail records of master table |

Expand Down
4 changes: 2 additions & 2 deletions src/tutorials/advanced/sql-comparison.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -2067,8 +2067,8 @@
"| Tier | Purpose | SQL Equivalent |\n",
"|------|---------|----------------|\n",
"| `Lookup` | Reference data, parameters | Regular table |\n",
"| `Manual` | User-entered data | Regular table |\n",
"| `Imported` | Data from external files | Regular table + trigger |\n",
"| `Manual` | Data inserted directly from outside the pipeline (people or ingestion scripts) | Regular table |\n",
"| `Imported` | Data from external sources (files, instruments, databases), populated by `make()` | Regular table + trigger |\n",
"| `Computed` | Derived results | Materialized view + trigger |\n",
"\n",
"### 2. Automatic Computation\n",
Expand Down
8 changes: 4 additions & 4 deletions src/tutorials/basics/02-schema-design.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@
"\n",
"| Tier | Class | Purpose | Data Entry |\n",
"|------|-------|---------|------------|\n",
"| **Manual** | `dj.Manual` | Core experimental data | Inserted by operators or instruments |\n",
"| **Manual** | `dj.Manual` | Core experimental data | Inserted directly by operators, instruments, or ingestion scripts |\n",
"| **Lookup** | `dj.Lookup` | Reference/configuration data | Pre-populated, rarely changes |\n",
"| **Imported** | `dj.Imported` | Data from external files | Auto-populated via `make()` |\n",
"| **Imported** | `dj.Imported` | Data from external sources (files, instruments, databases) | Auto-populated via `make()` |\n",
"| **Computed** | `dj.Computed` | Derived/processed data | Auto-populated via `make()` |\n",
"\n",
"**Manual** tables are not necessarily populated by hand—they contain data entered into the pipeline by operators, instruments, or ingestion scripts using `insert` commands. In contrast, **Imported** and **Computed** tables are auto-populated by calling the `.populate()` method, which invokes the `make()` callback for each missing entry.\n",
Expand Down Expand Up @@ -1383,9 +1383,9 @@
"- Keep keys minimal but sufficient for uniqueness\n",
"\n",
"### 2. Use Appropriate Table Tiers\n",
"- **Manual**: Data entered by operators or instruments\n",
"- **Manual**: Data inserted directly — by operators, instruments, or ingestion scripts\n",
"- **Lookup**: Configuration, parameters, reference data\n",
"- **Imported**: Data read from files (recordings, images)\n",
"- **Imported**: Data read from external sources (recordings, images, instruments)\n",
"- **Computed**: Derived analyses and summaries\n",
"\n",
"### 3. Normalize Your Data\n",
Expand Down
2 changes: 1 addition & 1 deletion src/tutorials/domain/calcium-imaging/calcium-imaging.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -1476,7 +1476,7 @@
"metadata": {},
"source": [
"**Legend:**\n",
"- **Green rectangles**: Manual tables (user-entered data)\n",
"- **Green rectangles**: Manual tables (data inserted directly — manually or by ingestion scripts)\n",
"- **Gray rectangles**: Lookup tables (parameters)\n",
"- **Blue ovals**: Imported tables (data from files)\n",
"- **Red ovals**: Computed tables (derived from other tables)\n",
Expand Down
4 changes: 2 additions & 2 deletions src/tutorials/examples/blob-detection.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -600,7 +600,7 @@
"metadata": {},
"source": [
"The diagram shows:\n",
"- **Green** = Manual tables (user-entered data)\n",
"- **Green** = Manual tables (data inserted directly, manually or via ingestion)\n",
"- **Gray** = Lookup tables (reference data)\n",
"- **Red** = Computed tables (derived data)\n",
"- **Edges** = Dependencies (foreign keys), always flow top-to-bottom"
Expand Down Expand Up @@ -1398,7 +1398,7 @@
"| Concept | What It Does | Example |\n",
"|---------|--------------|--------|\n",
"| **Schema** | Groups related tables | `schema = dj.Schema('tutorial_blobs')` |\n",
"| **Manual Table** | Stores user-entered data | `Image`, `SelectedDetection` |\n",
"| **Manual Table** | Stores data inserted directly from outside the pipeline | `Image`, `SelectedDetection` |\n",
"| **Lookup Table** | Stores reference/config data | `DetectionParams` |\n",
"| **Computed Table** | Derives data automatically | `Detection` |\n",
"| **Part Table** | Stores detailed results with master | `Detection.Blob` |\n",
Expand Down
Loading