Skip to content

Commit 2b0ee1f

Browse files
actions-useractions-user
committed
Update documentation
1 parent 369cd27 commit 2b0ee1f

8 files changed

Lines changed: 30 additions & 30 deletions

File tree

‎explanation/whats-new-2/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6113,7 +6113,7 @@ <h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permanen
61136113
<li><strong>Explicit over implicit</strong>: All type conversions are now explicit through the codec system</li>
61146114
<li><strong>Better distributed computing</strong>: Per-table job coordination with improved error handling</li>
61156115
<li><strong>Object storage integration</strong>: Native support for large arrays and files</li>
6116-
<li><strong>Future-proof architecture</strong>: Portable types preparing for PostgreSQL backend support</li>
6116+
<li><strong>Multi-backend support</strong>: Portable types enabling PostgreSQL backend (added in 2.1)</li>
61176117
</ul>
61186118
<h3 id="breaking-changes-at-a-glance">Breaking Changes at a Glance<a class="headerlink" href="#breaking-changes-at-a-glance" title="Permanent link">&para;</a></h3>
61196119
<p>If you're upgrading from legacy DataJoint, these changes require code updates:</p>

‎how-to/demo_modules/__init__/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2942,7 +2942,7 @@ <h1> init </h1>
29422942
</style>
29432943
<!-- End of mermaid configuration --><div class="jupyter-wrapper">
29442944
<div class="jp-Notebook" data-jp-theme-light="true" data-jp-theme-name="JupyterLab Light">
2945-
<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=735cac76">
2945+
<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell" id="cell-id=0a6b00ac">
29462946
<div class="jp-Cell-inputWrapper" tabindex="0">
29472947
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
29482948
</div>

‎how-to/demo_modules/acquisition/index.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2943,7 +2943,7 @@ <h1>Acquisition</h1>
29432943
<!-- End of mermaid configuration --><div class="jupyter-wrapper">
29442944
<div class="jp-Notebook" data-jp-theme-light="true" data-jp-theme-name="JupyterLab Light">
29452945
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
2946-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=82697634">
2946+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=55b6c4fe">
29472947
<div class="jp-Cell-inputWrapper" tabindex="0">
29482948
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
29492949
</div>
@@ -2982,7 +2982,7 @@ <h1>Acquisition</h1>
29822982
</div>
29832983
</div>
29842984
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
2985-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=c27134a7">
2985+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=10e3e0ee">
29862986
<div class="jp-Cell-inputWrapper" tabindex="0">
29872987
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
29882988
</div>
@@ -3011,7 +3011,7 @@ <h1>Acquisition</h1>
30113011
</div>
30123012
</div>
30133013
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3014-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=7e9b14c6">
3014+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=86732753">
30153015
<div class="jp-Cell-inputWrapper" tabindex="0">
30163016
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
30173017
</div>
@@ -3050,7 +3050,7 @@ <h1>Acquisition</h1>
30503050
</div>
30513051
</div>
30523052
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3053-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=905d7d5e">
3053+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=c2b8ccee">
30543054
<div class="jp-Cell-inputWrapper" tabindex="0">
30553055
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
30563056
</div>
@@ -3093,7 +3093,7 @@ <h1>Acquisition</h1>
30933093
</div>
30943094
</div>
30953095
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3096-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=f68f89ac">
3096+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=db71afd1">
30973097
<div class="jp-Cell-inputWrapper" tabindex="0">
30983098
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
30993099
</div>

‎how-to/demo_modules/analysis/index.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2943,7 +2943,7 @@ <h1>Analysis</h1>
29432943
<!-- End of mermaid configuration --><div class="jupyter-wrapper">
29442944
<div class="jp-Notebook" data-jp-theme-light="true" data-jp-theme-name="JupyterLab Light">
29452945
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
2946-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=36c1904d">
2946+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=5f52c735">
29472947
<div class="jp-Cell-inputWrapper" tabindex="0">
29482948
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
29492949
</div>
@@ -2984,7 +2984,7 @@ <h1>Analysis</h1>
29842984
</div>
29852985
</div>
29862986
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
2987-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=5415b4e9">
2987+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=38c973bb">
29882988
<div class="jp-Cell-inputWrapper" tabindex="0">
29892989
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
29902990
</div>
@@ -3013,7 +3013,7 @@ <h1>Analysis</h1>
30133013
</div>
30143014
</div>
30153015
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3016-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=914a146f">
3016+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=3ce479c8">
30173017
<div class="jp-Cell-inputWrapper" tabindex="0">
30183018
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
30193019
</div>
@@ -3054,7 +3054,7 @@ <h1>Analysis</h1>
30543054
</div>
30553055
</div>
30563056
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3057-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=9ea2ce01">
3057+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=5220afe7">
30583058
<div class="jp-Cell-inputWrapper" tabindex="0">
30593059
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
30603060
</div>
@@ -3103,7 +3103,7 @@ <h1>Analysis</h1>
31033103
</div>
31043104
</div>
31053105
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3106-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=c240e336">
3106+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=e9c9b70e">
31073107
<div class="jp-Cell-inputWrapper" tabindex="0">
31083108
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
31093109
</div>

‎how-to/demo_modules/processing/index.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2943,7 +2943,7 @@ <h1>Processing</h1>
29432943
<!-- End of mermaid configuration --><div class="jupyter-wrapper">
29442944
<div class="jp-Notebook" data-jp-theme-light="true" data-jp-theme-name="JupyterLab Light">
29452945
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
2946-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=06b807ce">
2946+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=90456e98">
29472947
<div class="jp-Cell-inputWrapper" tabindex="0">
29482948
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
29492949
</div>
@@ -2984,7 +2984,7 @@ <h1>Processing</h1>
29842984
</div>
29852985
</div>
29862986
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
2987-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=1f46505a">
2987+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=9a3a9f59">
29882988
<div class="jp-Cell-inputWrapper" tabindex="0">
29892989
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
29902990
</div>
@@ -3013,7 +3013,7 @@ <h1>Processing</h1>
30133013
</div>
30143014
</div>
30153015
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3016-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=d6eaaadd">
3016+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=e45ff803">
30173017
<div class="jp-Cell-inputWrapper" tabindex="0">
30183018
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
30193019
</div>
@@ -3056,7 +3056,7 @@ <h1>Processing</h1>
30563056
</div>
30573057
</div>
30583058
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3059-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=e0608af8">
3059+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=1eba14ec">
30603060
<div class="jp-Cell-inputWrapper" tabindex="0">
30613061
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
30623062
</div>
@@ -3105,7 +3105,7 @@ <h1>Processing</h1>
31053105
</div>
31063106
</div>
31073107
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs">
3108-
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=270be454">
3108+
<div class="jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" id="cell-id=21de7b3f">
31093109
<div class="jp-Cell-inputWrapper" tabindex="0">
31103110
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
31113111
</div>

‎how-to/migrate-to-v20/index.html‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3311,10 +3311,10 @@
33113311
</li>
33123312

33133313
<li class="md-nav__item">
3314-
<a href="#future-backend-support" class="md-nav__link">
3314+
<a href="#postgresql-backend-support" class="md-nav__link">
33153315
<span class="md-ellipsis">
33163316

3317-
Future Backend Support
3317+
PostgreSQL Backend Support
33183318

33193319
</span>
33203320
</a>
@@ -6471,10 +6471,10 @@
64716471
</li>
64726472

64736473
<li class="md-nav__item">
6474-
<a href="#future-backend-support" class="md-nav__link">
6474+
<a href="#postgresql-backend-support" class="md-nav__link">
64756475
<span class="md-ellipsis">
64766476

6477-
Future Backend Support
6477+
PostgreSQL Backend Support
64786478

64796479
</span>
64806480
</a>
@@ -7624,7 +7624,7 @@ <h3 id="system-requirements">System Requirements<a class="headerlink" href="#sys
76247624
<p><strong>Character encoding and collation:</strong> DataJoint 2.0 standardizes on UTF-8 encoding with binary collation (case-sensitive comparisons). This is configured <strong>server-wide</strong> and is assumed by DataJoint:</p>
76257625
<ul>
76267626
<li><strong>MySQL:</strong> <code>utf8mb4</code> character set with <code>utf8mb4_bin</code> collation</li>
7627-
<li><strong>PostgreSQL (future):</strong> <code>UTF8</code> encoding with <code>C</code> collation</li>
7627+
<li><strong>PostgreSQL (new in 2.1):</strong> <code>UTF8</code> encoding with <code>C</code> collation</li>
76287628
</ul>
76297629
<p>Like timezone handling, encoding is infrastructure configuration, not part of the data model. Ensure your MySQL server is configured with these defaults before migration.</p>
76307630
<h3 id="license-change">License Change<a class="headerlink" href="#license-change" title="Permanent link">&para;</a></h3>
@@ -7635,8 +7635,8 @@ <h3 id="license-change">License Change<a class="headerlink" href="#license-chang
76357635
<li>Clearer patent grant provisions</li>
76367636
</ul>
76377637
<p>No action required—the new license is more permissive.</p>
7638-
<h3 id="future-backend-support">Future Backend Support<a class="headerlink" href="#future-backend-support" title="Permanent link">&para;</a></h3>
7639-
<p>DataJoint 2.0 introduces portable type aliases (<code>int64</code>, <code>float64</code>, etc.) that prepare the codebase for <strong>PostgreSQL backend compatibility</strong> in a future release. Migration to core types ensures your schemas will work seamlessly when Postgres support is available.</p>
7638+
<h3 id="postgresql-backend-support">PostgreSQL Backend Support<a class="headerlink" href="#postgresql-backend-support" title="Permanent link">&para;</a></h3>
7639+
<p>DataJoint 2.0 introduced portable type aliases (<code>int64</code>, <code>float64</code>, etc.) that enable <strong>PostgreSQL backend compatibility</strong>, which was added in DataJoint 2.1. Migration to core types ensures your schemas work seamlessly on both MySQL and PostgreSQL backends.</p>
76407640
<p><strong>String quoting in restrictions:</strong> MySQL and PostgreSQL handle quotes differently. MySQL allows both single and double quotes for string literals, but PostgreSQL interprets double quotes as identifier (column) references. For PostgreSQL compatibility, replace double quotes with single quotes inside SQL restriction strings:</p>
76417641
<div class="highlight"><pre><span></span><code><span class="c1"># Before (MySQL only)</span>
76427642
<span class="n">Table</span> <span class="o">&amp;</span> <span class="s1">&#39;name = &quot;Alice&quot;&#39;</span>

‎llms-full.txt‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# DataJoint Documentation (Full)
22

3-
Generated: 2026-02-04 14:59:47 UTC
3+
Generated: 2026-02-04 17:07:00 UTC
44
Commit: unknown
55
Branch: unknown
66

@@ -3044,7 +3044,7 @@ DataJoint 2.0 introduces fundamental improvements to type handling, job coordina
30443044
- **Explicit over implicit**: All type conversions are now explicit through the codec system
30453045
- **Better distributed computing**: Per-table job coordination with improved error handling
30463046
- **Object storage integration**: Native support for large arrays and files
3047-
- **Future-proof architecture**: Portable types preparing for PostgreSQL backend support
3047+
- **Multi-backend support**: Portable types enabling PostgreSQL backend (added in 2.1)
30483048

30493049
### Breaking Changes at a Glance
30503050

@@ -17428,7 +17428,7 @@ Upgrade existing pipelines from legacy DataJoint (pre-2.0) to DataJoint 2.0.
1742817428
**Character encoding and collation:** DataJoint 2.0 standardizes on UTF-8 encoding with binary collation (case-sensitive comparisons). This is configured **server-wide** and is assumed by DataJoint:
1742917429

1743017430
- **MySQL:** `utf8mb4` character set with `utf8mb4_bin` collation
17431-
- **PostgreSQL (future):** `UTF8` encoding with `C` collation
17431+
- **PostgreSQL (new in 2.1):** `UTF8` encoding with `C` collation
1743217432

1743317433
Like timezone handling, encoding is infrastructure configuration, not part of the data model. Ensure your MySQL server is configured with these defaults before migration.
1743417434

@@ -17442,9 +17442,9 @@ DataJoint 2.0 is licensed under **Apache 2.0** (previously LGPL-2.1).
1744217442

1744317443
No action required—the new license is more permissive.
1744417444

17445-
### Future Backend Support
17445+
### PostgreSQL Backend Support
1744617446

17447-
DataJoint 2.0 introduces portable type aliases (`int64`, `float64`, etc.) that prepare the codebase for **PostgreSQL backend compatibility** in a future release. Migration to core types ensures your schemas will work seamlessly when Postgres support is available.
17447+
DataJoint 2.0 introduced portable type aliases (`int64`, `float64`, etc.) that enable **PostgreSQL backend compatibility**, which was added in DataJoint 2.1. Migration to core types ensures your schemas work seamlessly on both MySQL and PostgreSQL backends.
1744817448

1744917449
**String quoting in restrictions:** MySQL and PostgreSQL handle quotes differently. MySQL allows both single and double quotes for string literals, but PostgreSQL interprets double quotes as identifier (column) references. For PostgreSQL compatibility, replace double quotes with single quotes inside SQL restriction strings:
1745017450

‎search/search_index.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)