Skip to content

Commit 75b6f29

Browse files
docs: clarify dual-mode codecs in builtin_codecs docstring
- List <blob> and <blob@> separately to show both inline and external modes - List <attach> and <attach@> separately to show both modes - Change <hash> to <hash@> (external only) - Change <object> to <object@> (external only) - Clarify storage mode for each codec variant - Also corrected hash algorithm from SHA256 to MD5 This makes it clear which codecs support dual modes vs external-only.
1 parent f3e5aae commit 75b6f29

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

src/datajoint/builtin_codecs.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@
66
want to create their own custom codecs.
77
88
Built-in Codecs:
9-
- ``<blob>``: Serialize Python objects (internal) or external with dedup
10-
- ``<hash>``: Hash-addressed storage with SHA256 deduplication
11-
- ``<object>``: Schema-addressed storage for files/folders (Zarr, HDF5)
12-
- ``<attach>``: File attachment (internal) or external with dedup
13-
- ``<filepath@store>``: Reference to existing file in store
9+
- ``<blob>``: Serialize Python objects (in-table storage)
10+
- ``<blob@>``: Serialize Python objects (external with hash-addressed dedup)
11+
- ``<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)
1415
- ``<npy@>``: Store numpy arrays as portable .npy files (external only)
16+
- ``<filepath@store>``: Reference to existing file in store (external only)
1517
1618
Example - Creating a Custom Codec:
1719
Here's how to define your own codec, modeled after the built-in codecs::

0 commit comments

Comments
 (0)