Rename BlobEntry->Blobentry and BlobStore->Blobstore

NEWS.md

@@ -4,6 +4,8 @@ Listing news on any major breaking changes in DFG.  For regular changes, see int
 - `delete` returns number of nodes deleted and no longer the object that was deleted.
 - Deprecate `updateVariable!` for `mergeVariable!`, note `merege` returns number of nodes updated/added.
 - Deprecate `updateFactor!` for `mergeFactor!`, note `merege` returns number of nodes updated/added.
+- Rename BlobEntry to Blobentry, see #1123.
+- Rename BlobStore to Blobstore, see #1124.
 
 # v0.26
 - Graph structure plotting now uses GraphMakie.jl instead of GraphPlot.jl. Update by replacing `using GraphPlot` with `using GraphMakie`.

docs/src/GraphData.md

@@ -180,10 +180,10 @@ you are working with an in-memory graph, the DFG structure contains the graph it
 Graphs reside inside a hierarchy made up in the following way:
 - Agent
   - Metadata
-  - BlobEntries
+  - Blobentries
 - Graph
   - Metadata
-  - BlobEntries
+  - Blobentries
 
 This data can be retrieved with the follow functions:
 

docs/src/blob_ref.md

@@ -1,4 +1,4 @@
-# Blobs and BlobEntries
+# Blobs and Blobentries
 
 ```@contents
 Pages = [

src/DataBlobs/entities/BlobEntry.jl

@@ -1,31 +1,31 @@
 
 ##==============================================================================
-## BlobEntry
+## Blobentry
 ##==============================================================================
 
 """
     $(TYPEDEF)
 
-A `BlobEntry` is a small about of structured data that holds reference information to find an actual blob. Many `BlobEntry`s 
+A `Blobentry` is a small about of structured data that holds reference information to find an actual blob. Many `Blobentry`s 
 can exist on different graph nodes spanning Agents and Factor Graphs which can all reference the same `Blob`.
 
 Notes:
 - `blobId`s should be unique within a blobstore and are immutable.
 """
-Base.@kwdef struct BlobEntry
-    """ Remotely assigned and globally unique identifier for the `BlobEntry` itself (not the `.blobId`). """
+Base.@kwdef struct Blobentry
+    """ Remotely assigned and globally unique identifier for the `Blobentry` itself (not the `.blobId`). """
     id::Union{UUID, Nothing} = nothing
     """ 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. """
     blobId::Union{UUID, Nothing} = uuid4() #Deprecated in v0.25 TODO  remove union, blobId is mandatory
     """ 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. """
     originId::Union{UUID, Nothing} = blobId #Deprecated in v0.25 TODO remove union or remove originId completely
-    """ 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. """
+    """ 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. """
     label::Symbol
     """ A hint about where the `Blob` itself might be stored.  Remember that a Blob may be duplicated over multiple blobstores. """
     blobstore::Symbol = :default
     """ 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.] """
     hash::String = ""# Probably https://docs.julialang.org/en/v1/stdlib/SHA
-    """ Context from which a BlobEntry=>Blob was first created. E.g. agent|graph|varlabel. """
+    """ Context from which a Blobentry=>Blob was first created. E.g. agent|graph|varlabel. """
     origin::String = ""
     """ number of bytes in blob as a string"""
     size::Union{String, Nothing} = "-1" #TODO remove union -> size::String = "-1"
@@ -37,16 +37,16 @@
     metadata::String = "e30="
     """ When the Blob itself was first created. """
     timestamp::ZonedDateTime = now(localzone())
-    """ When the BlobEntry was created. """
+    """ When the Blobentry was created. """
     createdTimestamp::Union{ZonedDateTime, Nothing} = nothing
     """ Use carefully, but necessary to support advanced usage such as time synchronization over Blob data. """
     lastUpdatedTimestamp::Union{ZonedDateTime, Nothing} = nothing
-    """ Type version of this BlobEntry. TBD.jl consider upgrading to `::VersionNumber`. """
+    """ Type version of this Blobentry. TBD.jl consider upgrading to `::VersionNumber`. """
     _version::String = string(_getDFGVersion())
 end
 
-StructTypes.StructType(::Type{BlobEntry}) = StructTypes.UnorderedStruct()
-StructTypes.idproperty(::Type{BlobEntry}) = :id
-StructTypes.omitempties(::Type{BlobEntry}) = (:id,)
+StructTypes.StructType(::Type{Blobentry}) = StructTypes.UnorderedStruct()
+StructTypes.idproperty(::Type{Blobentry}) = :id
+StructTypes.omitempties(::Type{Blobentry}) = (:id,)
 
 _fixtimezone(cts::NamedTuple) = ZonedDateTime(cts.utc_datetime * "+00")

src/DataBlobs/entities/BlobStores.jl

@@ -1 +1 @@
-abstract type AbstractBlobStore{T} end
+abstract type AbstractBlobstore{T} end