Skip to content

Commit 05ad44d

Browse files
authored
Rename BlobEntry->Blobentry and BlobStore->Blobstore (#1136)
Co-authored-by: Johannes Terblanche <Affie@users.noreply.github.com>
1 parent ffe75ea commit 05ad44d

28 files changed

+470
-427
lines changed

NEWS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Listing news on any major breaking changes in DFG. For regular changes, see int
44
- `delete` returns number of nodes deleted and no longer the object that was deleted.
55
- Deprecate `updateVariable!` for `mergeVariable!`, note `merege` returns number of nodes updated/added.
66
- Deprecate `updateFactor!` for `mergeFactor!`, note `merege` returns number of nodes updated/added.
7+
- Rename BlobEntry to Blobentry, see #1123.
8+
- Rename BlobStore to Blobstore, see #1124.
79

810
# v0.26
911
- Graph structure plotting now uses GraphMakie.jl instead of GraphPlot.jl. Update by replacing `using GraphPlot` with `using GraphMakie`.

docs/src/GraphData.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -180,10 +180,10 @@ you are working with an in-memory graph, the DFG structure contains the graph it
180180
Graphs reside inside a hierarchy made up in the following way:
181181
- Agent
182182
- Metadata
183-
- BlobEntries
183+
- Blobentries
184184
- Graph
185185
- Metadata
186-
- BlobEntries
186+
- Blobentries
187187

188188
This data can be retrieved with the follow functions:
189189

docs/src/blob_ref.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Blobs and BlobEntries
1+
# Blobs and Blobentries
22

33
```@contents
44
Pages = [

src/DataBlobs/entities/BlobEntry.jl

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11

22
##==============================================================================
3-
## BlobEntry
3+
## Blobentry
44
##==============================================================================
55

66
"""
77
$(TYPEDEF)
88
9-
A `BlobEntry` is a small about of structured data that holds reference information to find an actual blob. Many `BlobEntry`s
9+
A `Blobentry` is a small about of structured data that holds reference information to find an actual blob. Many `Blobentry`s
1010
can exist on different graph nodes spanning Agents and Factor Graphs which can all reference the same `Blob`.
1111
1212
Notes:
1313
- `blobId`s should be unique within a blobstore and are immutable.
1414
"""
15-
Base.@kwdef struct BlobEntry
16-
""" Remotely assigned and globally unique identifier for the `BlobEntry` itself (not the `.blobId`). """
15+
Base.@kwdef struct Blobentry
16+
""" Remotely assigned and globally unique identifier for the `Blobentry` itself (not the `.blobId`). """
1717
id::Union{UUID, Nothing} = nothing
1818
""" Machine friendly and globally unique identifier of the 'Blob', usually assigned from a common point in the system. This can be used to guarantee unique retrieval of the large data blob. """
1919
blobId::Union{UUID, Nothing} = uuid4() #Deprecated in v0.25 TODO remove union, blobId is mandatory
2020
""" Machine friendly and locally assigned identifier of the 'Blob'. `.originId`s are mandatory upon first creation at the origin regardless of network access. Separate from `.blobId` since some architectures do not allow edge processes to assign a uuid4 to data store elements. """
2121
originId::Union{UUID, Nothing} = blobId #Deprecated in v0.25 TODO remove union or remove originId completely
22-
""" Human friendly label of the `Blob` and also used as unique identifier per node on which a `BlobEntry` is added. E.g. do "LEFTCAM_1", "LEFTCAM_2", ... of you need to repeat a label on the same variable. """
22+
""" Human friendly label of the `Blob` and also used as unique identifier per node on which a `Blobentry` is added. E.g. do "LEFTCAM_1", "LEFTCAM_2", ... of you need to repeat a label on the same variable. """
2323
label::Symbol
2424
""" A hint about where the `Blob` itself might be stored. Remember that a Blob may be duplicated over multiple blobstores. """
2525
blobstore::Symbol = :default
2626
""" A hash value to ensure data consistency which must correspond to the stored hash upon retrieval. Use `bytes2hex(sha256(blob))`. [Legacy: some usage functions allow the check to be skipped if needed.] """
2727
hash::String = ""# Probably https://docs.julialang.org/en/v1/stdlib/SHA
28-
""" Context from which a BlobEntry=>Blob was first created. E.g. agent|graph|varlabel. """
28+
""" Context from which a Blobentry=>Blob was first created. E.g. agent|graph|varlabel. """
2929
origin::String = ""
3030
""" number of bytes in blob as a string"""
3131
size::Union{String, Nothing} = "-1" #TODO remove union -> size::String = "-1"
@@ -37,16 +37,16 @@ Base.@kwdef struct BlobEntry
3737
metadata::String = "e30="
3838
""" When the Blob itself was first created. """
3939
timestamp::ZonedDateTime = now(localzone())
40-
""" When the BlobEntry was created. """
40+
""" When the Blobentry was created. """
4141
createdTimestamp::Union{ZonedDateTime, Nothing} = nothing
4242
""" Use carefully, but necessary to support advanced usage such as time synchronization over Blob data. """
4343
lastUpdatedTimestamp::Union{ZonedDateTime, Nothing} = nothing
44-
""" Type version of this BlobEntry. TBD.jl consider upgrading to `::VersionNumber`. """
44+
""" Type version of this Blobentry. TBD.jl consider upgrading to `::VersionNumber`. """
4545
_version::String = string(_getDFGVersion())
4646
end
4747

48-
StructTypes.StructType(::Type{BlobEntry}) = StructTypes.UnorderedStruct()
49-
StructTypes.idproperty(::Type{BlobEntry}) = :id
50-
StructTypes.omitempties(::Type{BlobEntry}) = (:id,)
48+
StructTypes.StructType(::Type{Blobentry}) = StructTypes.UnorderedStruct()
49+
StructTypes.idproperty(::Type{Blobentry}) = :id
50+
StructTypes.omitempties(::Type{Blobentry}) = (:id,)
5151

5252
_fixtimezone(cts::NamedTuple) = ZonedDateTime(cts.utc_datetime * "+00")

src/DataBlobs/entities/BlobStores.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
abstract type AbstractBlobStore{T} end
1+
abstract type AbstractBlobstore{T} end

0 commit comments

Comments
 (0)