Skip to content

Commit 9c8b196

Browse files
docs: fix terminology - replace "external" with "in-store"
Object storage is an integral part of DataJoint architecture, not "external". Updated docstrings to use correct terminology: - "external" → "in-store" or "store only" Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 68300f2 commit 9c8b196

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

src/datajoint/builtin_codecs/__init__.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
88
Built-in Codecs:
99
- ``<blob>``: Serialize Python objects (in-table storage)
10-
- ``<blob@>``: Serialize Python objects (external with hash-addressed dedup)
10+
- ``<blob@>``: Serialize Python objects (in-store with hash-addressed dedup)
1111
- ``<attach>``: File attachment (in-table storage)
12-
- ``<attach@>``: File attachment (external with hash-addressed dedup)
13-
- ``<hash@>``: Hash-addressed storage with MD5 deduplication (external only)
14-
- ``<object@>``: Schema-addressed storage for files/folders (external only)
15-
- ``<npy@>``: Store numpy arrays as portable .npy files (external only)
16-
- ``<filepath@store>``: Reference to existing file in store (external only)
12+
- ``<attach@>``: File attachment (in-store with hash-addressed dedup)
13+
- ``<hash@>``: Hash-addressed storage with MD5 deduplication (store only)
14+
- ``<object@>``: Schema-addressed storage for files/folders (store only)
15+
- ``<npy@>``: Store numpy arrays as portable .npy files (store only)
16+
- ``<filepath@store>``: Reference to existing file in store (store only)
1717
1818
Example - Creating a Custom Codec:
1919
Here's how to define your own codec, modeled after the built-in codecs::

src/datajoint/builtin_codecs/filepath.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ class FilepathCodec(Codec):
1818
exists in the storage backend. Unlike ``<attach>`` or ``<object@>``, no
1919
file copying occurs - only the path is recorded.
2020
21-
External only - requires @store.
21+
Store only - requires @store.
2222
2323
This codec gives users maximum freedom in organizing their files while
2424
reusing DataJoint's store configuration. Files can be placed anywhere
@@ -64,7 +64,7 @@ class Recordings(dj.Manual):
6464
name = "filepath"
6565

6666
def get_dtype(self, is_store: bool) -> str:
67-
"""Filepath is external only."""
67+
"""Filepath requires a store (use @store syntax)."""
6868
if not is_store:
6969
raise DataJointError(
7070
"<filepath> requires @ symbol. Use <filepath@> for default store or <filepath@store> to specify store."

0 commit comments

Comments
 (0)